CeGetSpecialFolderPath (RAPI) (Windows CE 5.0)

Send Feedback

This function gets the path to a special shell folder.

CeGetSpecialFolderPath is a remote application programming interface (RAPI), which enables an application running on a desktop computer to make function calls on a Windows CE–based device.

DWORD CeGetSpecialFolderPath( intnFolder,DWORDnBufferLength,LPWSTRlpBuffer);

Parameters

  • nFolder
    [in] Value specifying the folder for which to retrieve the location. This parameter can be one of the following values.
    Value Description
    CSIDL_DESKTOPDIRECTORY Windows desktop, which is a virtual folder at the root of the name space.
    CSIDL_FAVORITES File system directory that serves as a common repository for the user's favorite items.
    CSIDL_FONTS Virtual folder containing fonts.
    CSIDL_PERSONAL File system directory that serves as a common repository for documents.
    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_STARTUP File system directory that corresponds to the user's Startup program group.
  • nBufferLength
    [in] Size of lpBuffer in characters.
  • lpBuffer
    [out] Long pointer to the buffer for the folder path.

Return Values

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

Remarks

When working with RAPI for Windows CE 1.0 and 1.01, use the PegGetSpecialFolderPath function.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Rapi.h.
Link Library: Rapi.lib.

See Also

RAPI Functions | CeRapiGetError

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.