const type: dirFile

File to read the contents of a directory.

const func file: openDir (in string: directoryPath)

Open a dirFile.

Returns:

the dirFile opened, or STD_NULL if it could not be opened.

Raises:

MEMORY_ERROR - Not enough memory to convert the path to the system path type.

RANGE_ERROR - 'path' does not use the standard path representation or it cannot be converted to the system path type.

const func string: getln (inout dirFile: aFile)

Read a file name from a dirFile. When the function is left dirFile.bufferChar contains '\n' or EOF.

Returns:

the file name.

const func string: getwd (inout dirFile: aFile)

Read a file name from a dirFile. When the function is left dirFile.bufferChar contains '\n' or EOF.

Returns:

the file name.

const func boolean: eof (in dirFile: aFile)

Determine the end-of-file indicator.

Returns:

TRUE if the end-of-file indicator is set, FALSE otherwise.

const func boolean: hasNext (in dirFile: aFile)

Determine if another filename can be read successfully. This function allows a file to be handled like an iterator.

Returns:

FALSE if 'getln' would return "", TRUE otherwise.