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

フォルダーのカテゴリ、名前、パス、説明、ツールヒント、アイコン、その他のプロパティを含む、既知のフォルダーの定義要素を含む構造体を取得します。

構文

HRESULT GetFolderDefinition(
  [out] KNOWNFOLDER_DEFINITION *pKFD
);

[out] pKFD

このメソッドが戻るとき、には、KNOWNFOLDER_DEFINITION 構造体へのポインターが含まれます。不要になった場合、呼び出し元のアプリケーションは FreeKnownFolderDefinitionFields を呼び出してこのリソースを解放する必要があります。

種類: HRESULT

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

サードパーティ製アプリケーションは、独自の既知のフォルダーを作成するときに、 KNOWNFOLDER_DEFINITION 構造で定義し、システムに登録することで作成します。登録済みの既知のフォルダー定義情報 (システム提供またはアプリケーションで作成) は、このメソッドを使用して取得できます。

このメソッドを呼び出すには、呼び出し元に少なくともユーザー特権が必要です。


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