SHGetKnownFolderItem 関数 (shlobj_core.h)

  • [アーティクル]

既知のフォルダーを表す IShellItem オブジェクトを取得します。

構文

HRESULT SHGetKnownFolderItem(
  [in]  REFKNOWNFOLDERID  rfid,
  [in]  KNOWN_FOLDER_FLAG flags,
  [in]  HANDLE            hToken,
  [in]  REFIID            riid,
  [out] void              **ppv
);

パラメーター

[in] rfid

型: REFKNOWNFOLDERID

アイテムを含むフォルダーを識別する GUID である KNOWNFOLDERID への参照。

[in] flags

種類: KNOWN_FOLDER_FLAG

既知のフォルダー IShellItem の取得に使用される特別なオプションを指定するフラグ。 この値は KF_FLAG_DEFAULTできます。それ以外の場合は、 KNOWN_FOLDER_FLAG 値の 1 つ以上。

[in] hToken

型: HANDLE

特定のユーザーを表すために使用される アクセス トークン 。 通常、このパラメーターは NULL に設定されます。この場合、関数はフォルダーの現在のユーザーのインスタンスにアクセスしようとします。 ただし、複数のユーザーを持つことができますが、1 人のユーザーに属するフォルダーに対して hToken に値を割り当てる必要がある場合があります。 この種類の最も一般的に使用されるフォルダーは Documents です。

hToken が null 以外の場合、呼び出し元のアプリケーションは正しい偽装を担当します。 TOKEN_QUERYやTOKEN_IMPERSONATEなど、特定のユーザーに適切なセキュリティ特権が必要であり、ユーザーのレジストリ ハイブが現在マウントされている必要があります。 アクセス制御の問題の詳細については、「Access Control」を参照してください。

hToken パラメーターに -1 の値を割り当てると、既定のユーザーが示されます。 これにより、 SHSetKnownFolderPath のクライアントは、既定のユーザーのフォルダーの場所 ( デスクトップ フォルダーなど) を設定できます。 既定のユーザー ユーザー プロファイルは、新しいユーザー アカウントが作成されると複製され、 ドキュメント や デスクトップなどの特別なフォルダーが含まれます。 [既定のユーザー] フォルダーに追加されたすべての項目は、新しいユーザー アカウントにも表示されます。 既定のユーザー フォルダーへのアクセスには管理者特権が必要であることに注意してください。

[in] riid

種類: REFIID

項目を表すインターフェイスの IID への参照 (通常はIID_IShellItemまたはIID_IShellItem2)。

[out] ppv

型: void**

このメソッドが戻るとき、 には 、riid で要求されたインターフェイス ポインターが含まれます。

戻り値

種類: HRESULT

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

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

注釈

この関数の呼び出し元には管理者特権が必要です。 既知のパブリック フォルダーでこの関数を呼び出すには、呼び出し元に管理者特権が必要です。 ユーザーごとの既知のフォルダーの場合、呼び出し元にはユーザー特権のみが必要です。

一部の既知のフォルダー ( ドキュメント フォルダーなど) は、ユーザーごとです。 すべてのユーザーは、 ドキュメント フォルダーのパスが異なります。 hToken が NULL の場合、API は呼び出し元のアプリケーションのフォルダーのインスタンス (現在のユーザーのインスタンス) にアクセスしようとします。 hToken が有効なユーザー トークンの場合、API はこのトークンを使用してユーザーの偽装を試み、そのユーザーのインスタンスへのアクセスを試みます。

この関数は、 KF_CATEGORY_FIXED 型と KF_CATEGORY_VIRTUALのフォルダーでは呼び出すことができません。

KF_CATEGORY_COMMON型のフォルダーでこの関数を呼び出すには、呼び出し元のアプリケーションが管理者特権で実行されている必要があります。

要件

要件 値
サポートされている最小のクライアント Windows 7 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shlobj_core.h (Shlobj.h を含む)
Library Shell32.lib
[DLL] Shell32.dll (バージョン 6.1 以降)
API セット ext-ms-win-shell-shell32-l1-2-1 (Windows 10 バージョン 10.0.10240 で導入)

こちらもご覧ください

IKnownFolder::GetPath

IKnownFolderManager::Redirect

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

SHCreateItemInKnownFolder

SHGetKnownFolderIDList

SHGetKnownFolderPath