Export (0) Print
Expand All
Expand Minimize

CeGetSpecialFolderPath (RAPI) (Compact 7)

3/12/2014

This function retrieves the path to a special shell folder on a remote Windows Embedded Compact-based device.


DWORD CeGetSpecialFolderPath( 
  Int nFolder, 
  DWORD nBufferLength, 
  LPWSTR lpBuffer 
);

nFolder

[in] Value specifying the special shell folder you want. This value can be one of the following symbols defined in the ShlObj.h header file.

Value Description

CSIDL_APPDATA

File system directory that serves as a common repository for application-specific data.

CSIDL_CONTROLS

Not supported.

CSIDL_DESKTOP

Virtual folder that contains the desktop items. This is the folder at the root of the virtual namespace.

CSIDL_DESKTOPDIRECTORY

File system directory used to physically store file objects on the desktop (not to be confused with the desktop folder itself).

CSIDL_FAVORITES

File system directory that serves as a common repository for the user's favorite items.

CSIDL_FONTS

Virtual folder containing fonts.

CSIDL_NETHOOD

Not supported.

CSIDL_PERSONAL

File system directory that serves as a common repository for documents.

CSIDL_PRINTERS

Not supported.

CSIDL_PROFILE

Folder that contains the profile of the user.

CSIDL_PROGRAM_FILES

Program files folder.

CSIDL_PROGRAMS

File system directory that contains the user's program groups (which are also file system directories).

CSIDL_RECENT

File system directory that contains the user's most recently used documents.

CSIDL_SENDTO

Not supported.

CSIDL_STARTMENU

File system directory that contains Start menu items.

CSIDL_STARTUP

File system directory that corresponds to the user's Startup program group. The system starts these programs when a device is powered on.

CSIDL_TEMPLATES

Not supported.

CSIDL_WINDOWS

Windows folder.

nBufferLength

[in] Size of lpBuffer in characters.

lpBuffer

[out] Long pointer to the buffer for the folder path.

The length of the returned string indicates success. FALSE indicates a RAPI-related failure. To get extended error information, call CeGetLastError and CeRapiGetError.

Ee496786.note(en-us,WinEmbedded.70).gifNote:
Do not assume that SHGetSpecialFolderPath sets the last error on failure.

Header

rapi.h,
shlobj.h

Library

rapi.lib

Show:
© 2014 Microsoft