Converts a file system path to a symbolic path using the automatic path matching mechanism. This process is described in User's Manual/Sundry Topics/Symbolic Path Names.
Number | Type | Compulsory | Default | Description |
---|---|---|---|---|
1 |
string |
Yes |
|
Path |
2 |
string |
Yes |
|
Options |
May be set to either one of:
Name | Description |
---|---|
'systemonly' | Will only match system symbols to the path. These are: %STARTPATH% %DOCSPATH% %EXEPATH% %APPDATAPATH% %TEMPPATH% %SXAPPDATAPATH% %SHAREPATH% %LIBPATH% %SXDOCSPATH% %COMMON_APPDATAPATH% |
'projectonly' | Will only match symbols listed in the [Locations] section of the configuration file |
Return type: string
|