GetKnownPath Method (RUNTIME)
9.8
The GetKnownPath method retrieves a limited set of Windows operating system folder paths that are documented as 'known' folders. The method uses the following format:
|
|
|
|
Where:
Optional. A Program Execution Label.
Required. A RUNTIME object.
Optional. A Character String Variable that returns the path that is known by Windows.
Optional. A Numeric Variable or decimal number that identifies the folder path to be retrieved.
Flags Affected: EOS, OVER, ZERO
Note the following:
The EOS flag is set true if the {return} character variable is too small and the returned string is truncated.
The ZERO and OVER flag are always cleared.
The {type} value identifies the folder path retreived from Windows. The supported values are defined as follows which are included in the 'plbmeth.inc' descriptions:
|
TYPE |
CONST Value |
|
$FOLDERID_Desktop |
"0" |
|
$FOLDERID_Documents |
"1" |
|
$FOLDERID_Downloads |
"2" |
|
$FOLDERID_Fonts |
"3" |
|
$FOLDERID_Music |
"4" |
|
$FOLDERID_OneDrive |
"5" |
|
$FOLDERID_Pictures |
"6" |
|
$FOLDERID_Programs |
"7" |
|
$FOLDERID_ProgramData |
"8" |
|
$FOLDERID_ProgramFiles |
"9" |
|
$FOLDERID_RoamingAppData |
"10" |
|
$FOLDERID_System |
"11" |
|
$FOLDERID_SystemX86 |
"12" |
|
$FOLDERID_Videos |
"13" |
|
$FOLDERID_Windows |
"14" |
|
|
|
|
$FOLDERID_LocalAppData |
"15" |
|
$FOLDERID_LocalDocuments |
"16" |
|
$FOLDERID_LocalDownloads |
"17" |
|
$FOLDERID_LocalMusic |
"18" |
|
$FOLDERID_LocalPictures |
"19" |
|
$FOLDERID_LocalVideos |
"20" |
|
|
|
|
$FOLDERID_Public |
"21" |
|
$FOLDERID_PublicDesktop |
"22" |
|
$FOLDERID_PublicDocuments |
"23" |
|
$FOLDERID_PublicDownloads |
"24" |
|
$FOLDERID_PublicPictures |
"25" |
|
$FOLDERID_PublicMusic |
"26" |
|
$FOLDERID_PublicVideos |
"27" |
This method is not available under Windows CE or the PL/B WebServer.
See Also: RUNTIME, RUNTIME Methods, Method Syntax
|
|