 |
Icetips Utilities Documentation
11/16/2009 Shell Class: GetSpecialFolder |
|
Previous Top Next |
| Prototype: | (Long pFolderID),String |
| pFolderID | One of the IT_CSIDL equates to is appropriate for the folder. |
| Returns | String with the path or empty string if the CSIDL doesn't exist. |
This method uses SHGetSpecialFolderPath API to retrieve the appropriate path string. Currently the Icetips Utilities do not support KNOWNFOLDERID. However, CSIDL are supported on Vista, Windows 2008 and Windows 7 so this method is fully valid on those operating systems. We expect to add support for KNOWNFOLDERID in early 2010.
Valid values for pFolderID are:
IT_CSIDL_DESKTOP
IT_CSIDL_INTERNET
IT_CSIDL_PROGRAMS
IT_CSIDL_CONTROLS
IT_CSIDL_PRINTERS
IT_CSIDL_PERSONAL
IT_CSIDL_FAVORITES
IT_CSIDL_STARTUP
IT_CSIDL_RECENT
IT_CSIDL_SENDTO
IT_CSIDL_BITBUCKET
IT_CSIDL_STARTMENU
IT_CSIDL_DESKTOPDIRECTORY
IT_CSIDL_DRIVES
IT_CSIDL_NETWORK
IT_CSIDL_NETHOOD
IT_CSIDL_FONTS
IT_CSIDL_TEMPLATES
IT_CSIDL_COMMON_STARTMENU
IT_CSIDL_COMMON_PROGRAMS
IT_CSIDL_COMMON_STARTUP
IT_CSIDL_COMMON_DESKTOPDIRECTORY
IT_CSIDL_APPDATA
IT_CSIDL_PRINTHOOD
IT_CSIDL_LOCAL_APPDATA
IT_CSIDL_ALTSTARTUP
IT_CSIDL_COMMON_ALTSTARTUP
IT_CSIDL_COMMON_FAVORITES
IT_CSIDL_INTERNET_CACHE
IT_CSIDL_COOKIES
IT_CSIDL_HISTORY
IT_CSIDL_COMMON_APPDATA
IT_CSIDL_WINDOWS
IT_CSIDL_SYSTEM
IT_CSIDL_PROGRAM_FILES
IT_CSIDL_MYPICTURES
IT_CSIDL_PROFILE
IT_CSIDL_SYSTEMX86
IT_CSIDL_PROGRAM_FILESX86
IT_CSIDL_PROGRAM_FILES_COMMON
IT_CSIDL_PROGRAM_FILES_COMMONX86
IT_CSIDL_COMMON_TEMPLATES
IT_CSIDL_COMMON_DOCUMENTS
IT_CSIDL_COMMON_ADMINTOOLS
IT_CSIDL_ADMINTOOLS
Example:
ITS ITShellClass
Code
Message('Path to My Documents: ' & ITS.GetSpecialFolder(IT_CSIDL_PERSONAL))
This would result in a message like this:
See also:
http://msdn.microsoft.com/en-us/library/bb762494(VS.85).aspx
http://msdn.microsoft.com/en-us/library/bb762204(VS.85).aspx