IKnownFolderManager::GetFolder メソッド (shobjidl_core.h)

  • [アーティクル]

KNOWNFOLDERID によって識別される既知のフォルダーを表す オブジェクトを取得します。 オブジェクトを使用すると、特定のフォルダー プロパティのクエリを実行したり、フォルダーの現在のパスを取得したり、フォルダーを別の場所にリダイレクトしたり、 ITEMIDLIST としてフォルダーのパスを取得したりできます。

構文

HRESULT GetFolder(
  [in]  REFKNOWNFOLDERID rfid,
  [out] IKnownFolder     **ppkf
);

パラメーター

[in] rfid

型: REFKNOWNFOLDERID

KNOWNFOLDERID への参照。

[out] ppkf

種類: IKnownFolder**

このメソッドが戻るときに、 フォルダーを表す IKnownFolder オブジェクトへのインターフェイス ポインターを格納します。

戻り値

種類: HRESULT

成功した場合はS_OKを返し、それ以外の場合は次のようなエラー値を返します。

リターン コード 説明
E_INVALIDARG
 特に、この値は 、rfid パラメーターがシステムに存在しない KNOWNFOLDERID を 参照していることを示している可能性があります。 すべての KNOWNFOLDERID 値がすべてのシステムに存在するわけではありません。 現在のシステムの KNOWNFOLDERID 値のセットを取得するには、IKnownFolderManager::GetFolderIds を使用します。

注釈

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

使用するタイミング

探している既知のフォルダーが正確にわかっており、直接アクセスする場合は、このメソッドを使用します。

要件

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

こちらもご覧ください

IKnownFolderManager

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