Returns the short name of a file or directory.
// Retrieve the short name of a file
ResShortName = fShortName("C:\MyDirectories\Report March 2001.doc")
// fShortName returns "March~1.doc"
Syntax
<Result> = fShortName(<File path> [, <Options>])
<Result>: Character string
- Short name of the file or directory. Only the short name of the file or directory is returned.
- Empty string ("") if an error occurred (file or directory not found). To get more details on the error, use ErrorInfo with the errMessage constant.
<File path>: Character string
Name and full (or relative) path of the file or directory (up to 260 characters). A UNC path can be used.
<Options>: Optional Integer constant
Used to specify the format of function result. By default, fShortName returns a character string in Ansi format. | |
| fPathUNICODE | <Result> will be a Unicode string. |
Remark: The result of fShortName is always an ANSI character string, the fPathUNICODE constant is only used to store the result in a Unicode character string.
Remarks
Long names
fShortName returns:
- the short name of the file or directory if <File path> is expressed in long names (names exceeding 8 characters).
- the name of the specified file if the name of the file in <File path> is:
- expressed as short name (name containing up to 8 characters, containing a tilde "~"),
- made of 8 characters or less.
- the name of the specified directory if the name of the directory in <File path> is:
- expressed as short name (name containing up to 8 characters, containing a tilde "~"),
- made of 8 characters or less.
Business / UI classification: Business Logic