IRAPISession::CeGetSpecialFolderPath (Windows Embedded CE 6.0)

  • Article

1/6/2010

This method retrieves the path to a special shell folder on a remote Windows Embedded CE–based device.

Syntax

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

Parameters

  • 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_BITBUCKET

    File system directory that contains 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. Not valid for Windows CE 5.0 and later.

    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_DRIVES

    My Computer, which is a virtual folder that contains everything on the local computer: storage devices, and printers. The folder may also contain mapped network drives. Not valid for Windows CE 5.0 and later.

    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_NETWORK

    Network Neighborhood Folder, which is a virtual folder that represents the top level of the network hierarchy. Not valid for Windows CE 5.0 and later.

    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 corrsponds 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.

Return Value

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

Requirements

Header rapi2.h, shlobj.h
Library ole32.lib, rapiuuid.lib
Windows Embedded CE Windows Embedded CE 6.0 and later

See Also

Reference

IRAPISession
IRAPISession::CeGetTempPath