MAINSAIL Language Manual, Section 37.4

previous   next   top   contents   index   framed top   this page unframed


37.4. $homeDirectory

Figure 37–4. $homeDirectory
STRING
PROCEDURE   $homeDirectory
                        (
OPTIONAL BITS ctrlBits;
                         
PRODUCES OPTIONAL STRING msg);

If the operating system defines a notion of “home file directory”, $homeDirectory returns its name; consult the appropriate system-specific MAINSAIL user's guide for details. If an error occurs, the null STRING is returned, msg is set to a STRING describing the error, and if errorOK is not set in ctrlBits, an error message is issued. errorOK is the only valid bit in ctrlBits.


previous   next   top   contents   index   framed top   this page unframed

MAINSAIL Language Manual, Section 37.4