The PathUtils module provides an interface to manipulate system variables used as path variables by FileSwitch. That is, variables ending '$Path' which are used as references to multiple paths in filenames.

Flags:

Return all components of the path recursively Return only leaf components of the path Reserved, must be 0 Pointer to path to process Pointer to output buffer Maximum length of the buffer, or 0 to request length Opaque context value, or 0 for the first call Number of spare bytes in the buffer Context value, or -1 if complete (and the other registers are invalid) Variable type that the value was expanded from Depth the value was expanded from

This SWI is used to enumerate the components of a path variables. The path variable is expanded recursively. If R0 bit 0 is set, each path component will be returned in the results, even it is not terminal itself.

Flags:

Append the supplied path Prepend the supplied path Reserved, must be 0 Pointer to variable name to modify Pointer to path component to join

This SWI is used to join a path to an existing path variable. If the component already exists in the path variable, it will not be added.

Flags:

Reserved, must be 0 Pointer to variable name to modify Pointer to path component to remove

This SWI is used to remove a path from an existing path variable. If the component is not present, the variable will not be modified.
path-variable path-component name of the path variable to append to name of the path to append to the variable

This command appends a given path component to a path variable. If the path is already present, it has no effect.

 *AppPath Run$Path $.Library. path-variable path-component name of the path variable to append to name of the path to insert at the start of the path variable

This command prepends a given path component to a path variable, inserting the path at the start of the variable's value. If the path is already present, it has no effect.

 *PrepPath Run$Path $.Library. path-variable path-component name of the path variable to change name of the path to remove from the path variable

This command removes a given path component from a path variable. If the variable is not present, the variable is not changed.

 *RemPath Run$Path $.Library.

© Gerph, 2006-2023.

Original documentation. Recreated documentation in PRM-in-XML format. Included version table for compatibility info.