SHGetDocumentsFolder

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the path to the documents directory for the volume specified in the pszVolume parameter.

Syntax

BOOL SHGetDocumentsFolder(
  LPCTSTR pszVolume,
  LPTSTR pszDocs
);

Parameters

  • pszVolume
    [in] Pointer to a string that contains the storage volume from which the path to the documents directory should be retrieved.
  • pszDocs
    [out] Pointer to a string that contains the documents directory path. This string must be allocated for a path at least as long as the value of MAX_PATH.

Return Value

Returns TRUE if the documents directory path was successfully copied to pszDocs.

Returns FALSE if a documents directory path does not exist for the specified volume. For example, this function will return FALSE if a storage volume is initially specified but there is no storage card currently inserted.

Requirements

Header commctrl.h, shlobj.h
Library ceshell.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2002 and later, Smartphone 2002 and later