Xbasic

FILE Methods

IN THIS PAGE

Description

Methods available for a FILE object.

Methods

FILE.APPEND Method

Writes a string or blob to a file.

FILE.APPEND_LINE Method

Writes a string to a file followed by a carriage return and line feed.

FILE.ATTRIBUTES_GET Method

Returns A list of file attribute flags for the file.

FILE.ATTRIBUTES_SET Method

Sets file attributes for a file (-/+ R-readonly H-hidden A-Archive N-Normal).

FILE.BYTES_GET Method

Get the length of the file in bytes.

FILE.CHARS_GET Method

Get the length of the file in characters.

FILE.CLASS Method

The .CLASS() method returns the class of a file.

FILE.CLOSE Method

Close an open file.

FILE.COPY Method

Copies a file.

FILE.COPY2 Method

Same as File.Copy(), but if the dest_filename folder does not exist, then creates it.

FILE.COPY_FOLDER Method

Copy all of the files in a folder from one folder to another. All sub-folders are copies as well.

FILE.CREATE Method

Create a new file.

FILE.CREATE_TIME Method

Returns the date/time at which a file was created

FILE.DEPENDENCIES Method

Determines if the master file for a list of dependencies is out of date.

FILE.DIR_CREATE Method

Creates a new directory.

FILE.DIR_CREATE_RECURSE Method

Creates a folder, creating as many sub-folders as necessary.

FILE.DIR_GET Method

The FILE.DIR_GET() method returns the name of the current directory.

FILE.DIR_PUT Method

The FILE.DIR_PUT() method changes the current location to the specified directory.

FILE.DIR_REMOVE Method

Remove a directory.

FILE.DRIVE_SPACE_AVAIL Method

Returns the number of bytes free on the disk.

FILE.DRIVE_SPACE_TOTAL Method

Returns the number of bytes that can be stored on the drive.

FILE.DRIVE_TYPE Method

Returns The type of the drive.

FILE.DRIVES_GET Method

Returns a list of the valid drives.

FILE.EOF Method

Return TRUE if positioned at the end of the file.

FILE.EXISTS Method

The FILE.EXISTS() method determines if a file or directory exists on disk. A logical result of TRUE (.T.) is returned if the supplied Filename is found.

FILE.FILENAME_PARSE Method

Returns the component(s) of the filename in the order specified (D=drive, P=Path, N=Name, E=Extension, U=UNC Machine Name, S=Subdirectory).

FILE.FLUSH Method

Flush contents of file to disk.

FILE.FROM_BLOB Method

The FILE.FROM_BLOB() method creates a file from binary data.

FILE.FROM_PROPERTY Method

Writes pointer contents to a file.

FILE.FROM_STRING Method

Writes a string to a file.

FILE.FTP_PARSE Method

Processes FTP list data.

FILE.IS_VALID Method

Is the current file valid.

FILE.LONGNAME_TO_SHORTNAME Method

Converts a longname to a shortname.

FILE.MACHINES_GET Method

Returns a list of the valid servers - options S-storage,P-drinters,D-include domains,F=<format> - special format options C-omment,P-rovider,L-ocalname,T-ype,B-ase,M-achine,R-esource.

FILE.OPEN Method

Open an existing file.

FILE.POS_GET Method

Get the position in the file.

FILE.READ Method

Read bytes from file into string.

FILE.READ_LINE Method

Read a line from the file.

FILE.READ_TIME Method

Returns the date/time at which a file was last read

FILE.READB Method

Read bytes from file into a blob.

FILE.REMOVE Method

Remove a file.

FILE.RENAME Method

The FILE.RENAME() method changes the name of a file. You must supply both the original filename ( Old_Filename ) and the New_Filename.

FILE.SEEK Method

Set the position in the file.

FILE.SEND Method

Send one or more files to an address. Options: C or Z = compress (i.e. zip) files before sending.

FILE.SHORTNAME_TO_LONGNAME Method

Converts a shortname to a longname.

FILE.SIZE Method

The FILE.SIZE() method returns the size of a file.

FILE.STREAM_COPY Method

Perform a streamed copy - control variables include .exit and .bytes .

FILE.STREAM_FROM_BLOB Method

Perform a streamed copy from a blob- control variables include .exit and .bytes .

FILE.STREAM_FROM_STRING Method

Perform a streamed copy from a string- control variables include .exit and .bytes .

FILE.STREAM_TO_BLOB Method

Perform a streamed copy to a blob- control variables include .exit and .bytes .

FILE.STREAM_TO_STRING Method

Perform a streamed copy to a string- control variables include .exit and .bytes .

FILE.TEMP_CREATE Method

Create a temp filename.

FILE.TEMP_PATH_GET Method

Returns the windows temporary file path.

FILE.TEXT_ENCODING Method

Get the encoding type of a text file. Possible Values Include: (ASCII, UTF16LE, UTF16BE, UTF32LE, UTF32BE)

FILE.TO_BLOB Method

Reads a file to an in-memory blob variable.

FILE.TO_PROPERTY Method

Reads a file to a in dot variable - returns file contents as string.

FILE.TO_STRING Method

The FILE.TO_STRING() method reads a file from disk into a text variable, Data.

FILE.UNZIP Method

Extract files from a zip file.

FILE.UPDATE_TIME Method

Returns the date/time at which a file was last updated

FILE.WATCH_CREATE Method

Executes code on change of some aspect of a path changes (flags F= files renamed/add/delete D= sub-directory renamed/added/deleted A=Attributes changed L=Length of file(s) changed T=Time Changed S=File security changed R=recurse).

FILE.WATCH_DESTROY Method

Removes a registered 'watch'.

FILE.WATCH_ENUMERATE Method

Enumerate all file watches - format F=File/Path, N=Watch Name O=Option Flags.

FILE.WRITE Method

Writes data to a file.

FILE.WRITE_LINE Method

Writes a string to file with a trailing CR-LF.

FILE.WRITEB Method

Write blob to file.

FILE.ZIP Method

Zip files listed - expects a comma separated list.

FILE.ZIPLIST Method

Report on the contents of a zip file.