ホーム › UI.Shell › SHGetKnownFolderItem

SHGetKnownFolderItem

関数

既知フォルダーをIShellItem等のオブジェクトとして取得する。

DLLSHELL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

HRESULT SHGetKnownFolderItem(
    const GUID* rfid,
    KNOWN_FOLDER_FLAG flags,
    HANDLE hToken,   // optional
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
rfid	GUID*	in	項目を含むフォルダーを識別する GUID である KNOWNFOLDERID への参照です。
flags	KNOWN_FOLDER_FLAG	in	既知のフォルダーの IShellItem を取得する際に使用する特別なオプションを指定するフラグです。この値には KF_FLAG_DEFAULT を指定できます。それ以外の場合は、KNOWN_FOLDER_FLAG 値の 1 つ以上を指定します。
hToken	HANDLE	inoptional	特定のユーザーを表すために使用するアクセストークンです。このパラメーターは通常 NULL に設定され、その場合、関数は現在のユーザーのフォルダーのインスタンスへのアクセスを試みます。ただし、複数のユーザーを持つことができるものの単一のユーザーに属するものとして扱われるフォルダーについては、hToken に値を割り当てる必要がある場合があります。この種のフォルダーで最もよく使用されるのは Documents フォルダーです。 hToken が null 以外の場合、正しい偽装を行う責任は呼び出し元のアプリケーションにあります。アプリケーションは、TOKEN_QUERY や TOKEN_IMPERSONATE を含む、対象ユーザーに対する適切なセキュリティ特権を保持している必要があり、またそのユーザーのレジストリハイブが現在マウントされている必要があります。アクセス制御の問題に関する詳細については、アクセス制御を参照してください。 hToken パラメーターに値 -1 を割り当てると、Default User を示します。これにより、SHSetKnownFolderPath のクライアントは Default User のフォルダーの場所(Desktop フォルダーなど)を設定できます。Default User のユーザープロファイルは、新しいユーザーアカウントが作成されるときに複製され、Documents や Desktop などの特別なフォルダーが含まれます。Default User フォルダーに追加された項目は、新しいユーザーアカウントにも表示されます。なお、Default User フォルダーへのアクセスには管理者特権が必要です。
riid	GUID*	in	項目を表すインターフェイスの IID への参照で、通常は IID_IShellItem または IID_IShellItem2 です。
ppv	void**	out	このメソッドが戻るときに、riid で要求されたインターフェイスポインターを格納します。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

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

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

戻りコード

説明

E_INVALIDARG

この値は、特に rfid パラメーターがシステム上に存在しない KNOWNFOLDERID を参照していることを示す場合があります。すべての KNOWNFOLDERID 値がすべてのシステムに存在するわけではありません。現在のシステムの KNOWNFOLDERID 値のセットを取得するには、IKnownFolderManager::GetFolderIds を使用してください。

解説(Remarks)

パブリックな既知のフォルダーに対してこの関数を呼び出すには、呼び出し元が管理者特権を持っている必要があります。ユーザーごとの既知のフォルダーの場合は、呼び出し元はユーザー特権のみを必要とします。

既知のフォルダーの一部、たとえば Documents フォルダーは、ユーザーごとに存在します。すべてのユーザーは、それぞれ異なる Documents フォルダーのパスを持ちます。hToken が NULL の場合、API は呼び出し元アプリケーションのフォルダーのインスタンス、すなわち現在のユーザーのインスタンスへのアクセスを試みます。hToken が有効なユーザートークンの場合、API はこのトークンを使用してそのユーザーを偽装し、そのユーザーのインスタンスへのアクセスを試みます。

この関数は、KF_CATEGORY_FIXED および KF_CATEGORY_VIRTUAL 型のフォルダーに対しては呼び出せません。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

HRESULT SHGetKnownFolderItem(
    const GUID* rfid,
    KNOWN_FOLDER_FLAG flags,
    HANDLE hToken,   // optional
    const GUID* riid,
    void** ppv
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetKnownFolderItem(
    ref Guid rfid,   // GUID*
    int flags,   // KNOWN_FOLDER_FLAG
    IntPtr hToken,   // HANDLE optional
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetKnownFolderItem(
    ByRef rfid As Guid,   ' GUID*
    flags As Integer,   ' KNOWN_FOLDER_FLAG
    hToken As IntPtr,   ' HANDLE optional
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' rfid : GUID*
' flags : KNOWN_FOLDER_FLAG
' hToken : HANDLE optional
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function SHGetKnownFolderItem Lib "shell32" ( _
    ByVal rfid As LongPtr, _
    ByVal flags As Long, _
    ByVal hToken As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHGetKnownFolderItem = ctypes.windll.shell32.SHGetKnownFolderItem
SHGetKnownFolderItem.restype = ctypes.c_int
SHGetKnownFolderItem.argtypes = [
    ctypes.c_void_p,  # rfid : GUID*
    ctypes.c_int,  # flags : KNOWN_FOLDER_FLAG
    wintypes.HANDLE,  # hToken : HANDLE optional
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetKnownFolderItem = Fiddle::Function.new(
  lib['SHGetKnownFolderItem'],
  [
    Fiddle::TYPE_VOIDP,  # rfid : GUID*
    Fiddle::TYPE_INT,  # flags : KNOWN_FOLDER_FLAG
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetKnownFolderItem(
        rfid: *const GUID,  // GUID*
        flags: i32,  // KNOWN_FOLDER_FLAG
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHGetKnownFolderItem(ref Guid rfid, int flags, IntPtr hToken, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetKnownFolderItem' -Namespace Win32 -PassThru
# $api::SHGetKnownFolderItem(rfid, flags, hToken, riid, ppv)

#uselib "SHELL32.dll"
#func global SHGetKnownFolderItem "SHGetKnownFolderItem" sptr, sptr, sptr, sptr, sptr
; SHGetKnownFolderItem varptr(rfid), flags, hToken, varptr(riid), ppv   ; 戻り値は stat
; rfid : GUID* -> "sptr"
; flags : KNOWN_FOLDER_FLAG -> "sptr"
; hToken : HANDLE optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHGetKnownFolderItem "SHGetKnownFolderItem" var, int, sptr, var, sptr
; res = SHGetKnownFolderItem(rfid, flags, hToken, riid, ppv)
; rfid : GUID* -> "var"
; flags : KNOWN_FOLDER_FLAG -> "int"
; hToken : HANDLE optional -> "sptr"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHGetKnownFolderItem "SHGetKnownFolderItem" sptr, int, sptr, sptr, sptr
; res = SHGetKnownFolderItem(varptr(rfid), flags, hToken, varptr(riid), ppv)
; rfid : GUID* -> "sptr"
; flags : KNOWN_FOLDER_FLAG -> "int"
; hToken : HANDLE optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。