IKnownFolderManager::GetFolderByName メソッド (shobjidl_core.h)
正規名で識別される既知のフォルダーを表す オブジェクトを取得します。 オブジェクトを使用すると、特定のフォルダー プロパティのクエリを実行したり、フォルダーの現在のパスを取得したり、フォルダーを別の場所にリダイレクトしたり、 ITEMIDLIST としてフォルダーのパスを取得したりできます。
構文
HRESULT GetFolderByName(
[in] LPCWSTR pszCanonicalName,
[out] IKnownFolder **ppkf
);
パラメーター
[in] pszCanonicalName
種類: LPCWSTR
null で終わる Unicode 文字列として格納されている、既知のフォルダーのローカライズされていない正規名へのポインター。 このフォルダーが 共通 フォルダーまたは ユーザー単位 のフォルダーである場合、この値は "User Shell Folders" レジストリ設定の値名としても使用されます。 この値は、フォルダーの KNOWNFOLDER_DEFINITION 構造体の pszName メンバーを介して取得されます。
[out] ppkf
種類: IKnownFolder**
このメソッドから制御が戻るときに、既知のフォルダーを表す IKnownFolder オブジェクトへのポインターのアドレスが格納されます。
戻り値
型: HRESULT
このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。
注釈
使用するタイミング
探している既知のフォルダーが正確にわかっており、直接アクセスする場合は、この方法を使用します。要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | shobjidl_core.h (Shobjidl.h を含む) |