MAINSAIL Language Manual, Section 32.50

previous   next   top   contents   index   framed top   this page unframed


32.50. $composePath

Figure 32–49. $composePath
STRING
PROCEDURE   $composePath
                        (
OPTIONAL STRING
                             
pathPrefix,pathComponents,
                             
devModStr;
                         
OPTIONAL BITS ctrlBits);

$composePath takes three STRINGs in the (device-specific) format produced by $decomposePath and returns a syntactically correct (device-specific) directory path name. The pathComponents STRING is expected to include only directory components, i.e., is not expected to include the leaf file name; use $composeFileName to compose a file name including a leaf file name. $composePath strips off extra leading and trailing eols from pathComponents.

The directory components included in pathComponents are usually separated by eol characters. Higher-level components come first.

Consult the appropriate operating-system-specific user's guide for examples of $composePath and $decomposePath.

The only valid ctrlBits bits for $composePath are errorOK and $omitDevModStr. If errorOK is set, errMsg is not called when an error occurs. If $omitDevModStr is set, the output from $composePath does not include the device MODULE, and is therefore suitable for passing to $composeFileName (most other PROCEDUREs that take a directory name require that it include the device MODULE, if any, but $composeFileName already has a separate devModStr parameter and cannot deal with a device MODULE prefixed to the path).


previous   next   top   contents   index   framed top   this page unframed

MAINSAIL Language Manual, Section 32.50