SHGetDocumentsFolder

  • Article

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

BOOL SHGetDocumentsFolder (
  LPCTSTR pszVolume,
  LPTSTR pszDocs
);

Parameters

  • pszVolume
    The storage volume for which the path to the documents directory should be retrieved.
  • pszDocs
    [out] Reference to a string containing the documents directory path (must be 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: Windows Mobile 2002 and later
OS Versions: Windows CE 3.0 and later
Header: shlobj.h
Library: ceshell.lib

Send feedback on this topic to the authors.

© 2005 Microsoft Corporation. All rights reserved.