IKnownFolder::SetPath メソッド (shobjidl_core.h)

  • [アーティクル]

既知のフォルダーに新しいパスを割り当てます。

構文

HRESULT SetPath(
  [in] DWORD   dwFlags,
  [in] LPCWSTR pszPath
);

パラメーター

[in] dwFlags

型: DWORD

0 または次の値のいずれか。

KF_FLAG_DONT_UNEXPAND

環境文字列を使用せずに完全なパスを設定します。 このフラグが設定されていない場合、 pszPath のパスの一部は、 などの %USERPROFILE%環境文字列で表される場合があります。

[in] pszPath

種類: LPCWSTR

フォルダーの新しいパスへのポインター。 これは、長さがMAX_PATHの null で終わる Unicode 文字列です。 このパスの長さを 0 にすることはできません。 この値が NULL の場合、 IKnownFolder::SetPath はパスを既定値に設定します。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

このメソッドは、 KF_CATEGORY_FIXED または KF_CATEGORY_VIRTUALの種類のフォルダーでは呼び出すことができません。

KF_CATEGORY_COMMON型のフォルダーでこのメソッドを呼び出すには、呼び出し元のアプリケーションが昇格された特権で実行されている必要があります。

このメソッドは SHSetKnownFolderPath と同じです。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shobjidl_core.h (Shobjidl.h を含む)
[DLL] Shell32.dll

こちらもご覧ください

IKnownFolder

既知のフォルダーのサンプル

SHSetKnownFolderPath