CeGetSpecialFolderPath
The CeGetSpecialFolderPath function gets the path to a special shell folder.
Syntax
DWORD CeGetSpecialFolderPath( int nFolder, DWORD nBufferLength, LPWSTR lpBuffer);
At a Glance
| Header file: |
Rapi.h |
| Platforms: |
H/PC |
| Windows CE versions: |
2.0 and later |
Parameters
- nFolder
- Value specifying the folder for which to retrieve the location. This parameter can be one of the following values:
- CSIDL_BITBUCKET
- Recycle bin—file system directory containing file objects in the user's recycle bin. The location of this directory is not in the registry; it is marked with the hidden and system attributes to prevent the user from moving or deleting it.
- CSIDL_COMMON_DESKTOP
- File system directory that contains files and folders that appear on the desktop for all users.
- CSIDL_COMMON_PROGRAMS
- File system directory that contains the directories for the common program groups that appear on the Start menu for all users.
- CSIDL_COMMON_STARTMENU
- File system directory that contains the programs and folders that appear on the Start menu for all users.
- CSIDL_COMMON_STARTUP
- File system directory that contains the programs that appear in the Startup folder for all users. The system starts these programs whenever any user logs on to a Windows desktop platform.
- CSIDL_CONTROLS
- Control Panel—virtual folder containing icons for the control panel applications.
- CSIDL_DESKTOP
- Windows desktop—virtual folder at the root of the name space.
- CSIDL_DESKTOPDIRECTORY
- File system directory used to physically store file objects on the desktop — not to be confused with the desktop folder itself.
- CSIDL_DRIVES
- My Computer—virtual folder containing everything on the local computer: storage devices, printers, and Control Panel. The folder can also contain mapped network drives.
- CSIDL_FONTS
- Virtual folder containing fonts.
- CSIDL_NETHOOD
- File system directory containing objects that appear in the network neighborhood.
- CSIDL_NETWORK
- Network Neighborhood—virtual folder representing the top level of the network hierarchy.
- CSIDL_PERSONAL
- File system directory that serves as a common repository for documents.
- CSIDL_PRINTERS
- Printers folder—virtual folder containing installed printers.
- CSIDL_PROGRAMS
- File system directory that contains the user's program groups which are also file system directories.
- CSIDL_RECENT
- File system directory containing the user's most recently used documents.
- CSIDL_SENDTO
- File system directory containing Send To menu items.
- CSIDL_STARTMENU
- File system directory containing Start menu items.
- CSIDL_STARTUP
- File system directory that corresponds to the user's Startup program group.
- CSIDL_TEMPLATES
- File system directory that serves as a common repository for document templates.
- nBufferLength
- Size of lpBuffer in characters.
- lpBuffer
- Address of the buffer for the folder path.
Return Values
The return value is the length of the returned string; if a RAPI related failure, return value is FALSE.