For the complete documentation index, see llms.txt. This page is also available as Markdown.

file

File Methods

bxDump(label=[string], top=[numeric], expand=[boolean], abort=[boolean], output=[string], format=[string], showUDFs=[boolean])

Outputs the contents of a variable (simple or complex) of any type for debugging purposes to a specific output location.

, The available ,,output,, locations are: - ,,buffer,,: The output is written to the buffer, which is the default location. If running on a web server, the output is written to the browser. - ,,console,,: The output is printed to the System console. - ,,Absolute File Path,, The output is written to a file with the specified absolute file path. ,

,

The output format can be either HTML or plain text.

The default format is HTML if the output location is the buffer or a web server or a file, otherwise it is plain text for the console.

Arguments:

Argument
Type
Required
Default

label

string

false

null

top

numeric

false

null

expand

boolean

false

true

abort

boolean

false

false

output

string

false

null

format

string

false

null

showUDFs

boolean

false

true

close()

Closes either the read or write stream

getLastModifedTime()

Retrieves the last modified time of a file

info()

Returns a struct of file information.

Different values are returned for FileInfo and GetFileInfo

readLine()

Returns the next line from the file object stream

seek(position=[integer])

Moves the buffer cursor position forward the number of characters specified by the position argument

Arguments:

Argument
Type
Required
Default

position

integer

true

null

setAccessMode(mode=[string])

Sets the Posix permissions on a file

Arguments:

Argument
Type
Required
Default

mode

string

true

null

setAttribute(attribute=[string])

Sets a file access attribute

Arguments:

Argument
Type
Required
Default

attribute

string

true

null

setLastModified(date=[any])

Sets the last modified time of a file

Arguments:

Argument
Type
Required
Default

date

any

true

null

skipBytes(position=[integer])

Moves the buffer cursor position forward the number of characters specified by the position argument

Arguments:

Argument
Type
Required
Default

position

integer

true

null

writeLine(data=[string])

Writes a line of data to a file

Arguments:

Argument
Type
Required
Default

data

string

true

null

Examples

Last updated

Was this helpful?