Share via

SHGetDocumentsFolder (Windows CE 5.0)

  • Article

Send Feedback

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 Values

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

Pocket PC: Pocket PC 2002 and later
Smartphone: Smartphone 2002 and later
OS Versions: Windows CE 3.0 and later
Header: shlobj.h, commctrl.h
Library: ceshell.lib

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.