This topic has not yet been rated - Rate this topic

IKnownFolder::GetPath method

Applies to: desktop apps only

Retrieves the path of a known folder as a string.

Syntax

Copy

HRESULT GetPath(
  [in]   DWORD dwFlags,
  [out]  LPWSTR *ppszPath
);

Parameters

dwFlags [in]

Type: DWORD

Flags that specify special retrieval options. This value can be 0; otherwise, one or more of the KNOWN_FOLDER_FLAG values.

ppszPath [out]

Type: LPWSTR*

When this method returns, contains the address of a pointer to a null-terminated buffer that contains the path. The calling application is responsible for calling CoTaskMemFree to free this resource when it is no longer needed.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Equivalent to SHGetKnownFolderPath

Requirements