ホーム › UI.Shell › SHGetKnownFolderIDList

SHGetKnownFolderIDList

関数

KNOWNFOLDERIDで指定した既知フォルダーのPIDLを取得する。

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

シグネチャ

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

HRESULT SHGetKnownFolderIDList(
    const GUID* rfid,
    DWORD dwFlags,
    HANDLE hToken,   // optional
    ITEMIDLIST** ppidl
);

パラメーター

名前	型	方向	説明
rfid	GUID*	in	フォルダーを識別する KNOWNFOLDERID への参照です。既知のフォルダー ID に関連付けられたフォルダーは、特定のシステム上に存在しない場合があります。
dwFlags	DWORD	in	特殊な取得オプションを指定するフラグです。この値は 0 を指定できます。それ以外の場合は、1 つ以上の KNOWN_FOLDER_FLAG 値を指定します。
hToken	HANDLE	inoptional	特定のユーザーを表すために使用されるアクセストークンです。このパラメーターは通常 NULL に設定され、その場合、関数は現在のユーザーのフォルダーインスタンスへのアクセスを試みます。ただし、複数のユーザーを持ち得るが単一ユーザーに属するものとして扱われるフォルダーについては、hToken に値を割り当てる必要がある場合があります。このタイプのフォルダーで最もよく使用されるのは Documents です。 hToken が非 NULL の場合、正しい偽装を行う責任は呼び出し元のアプリケーションにあります。アプリケーションは、TOKEN_QUERY および TOKEN_IMPERSONATE を含む、当該ユーザーに対する適切なセキュリティ特権を持っている必要があり、またそのユーザーのレジストリハイブが現在マウントされている必要があります。アクセス制御に関する詳細は、Access Control を参照してください。 hToken パラメーターに -1 の値を割り当てると、Default User を示します。これにより、SHGetKnownFolderIDList のクライアントは Default User の (Desktop フォルダーなどの) フォルダーの場所を見つけることができます。Default User のユーザープロファイルは、新しいユーザーアカウントが作成されるたびに複製され、Documents や Desktop などの特殊フォルダーを含みます。Default User フォルダーに追加された項目は、新しいユーザーアカウントにも反映されます。Default User フォルダーへのアクセスには管理者特権が必要であることに注意してください。
ppidl	ITEMIDLIST**	out	このメソッドが返るとき、フォルダーの PIDL へのポインターが格納されます。このパラメーターは初期化されずに渡されます。返された PIDL が不要になったときに ILFree を呼び出して解放する責任は、呼び出し元にあります。

戻り値の型: HRESULT

公式ドキュメント

既知のフォルダーのパスを ITEMIDLIST 構造体として取得します。

戻り値

型: HRESULT

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

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

戻り値

説明

E_INVALIDARG

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

解説(Remarks)

この関数は SHGetFolderLocation を置き換えるものです。その古い関数は、現在では単に SHGetKnownFolderIDList のラッパーになっています。

この関数を使用する呼び出し元は、少なくとも User 特権を持っている必要があります。

たとえば Documents フォルダーのように、一部の既知のフォルダーはユーザーごとに固有です。各ユーザーは Documents フォルダーに対して異なるパスを持ちます。hToken が NULL の場合、API は現在のユーザーのフォルダーインスタンスへのアクセスを試みます。hToken が有効なユーザートークンの場合、API はそのトークンを使用してユーザーを偽装し、そのユーザーのフォルダーインスタンスへのアクセスを試みます。

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

各言語での呼び出し定義

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

HRESULT SHGetKnownFolderIDList(
    const GUID* rfid,
    DWORD dwFlags,
    HANDLE hToken,   // optional
    ITEMIDLIST** ppidl
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetKnownFolderIDList(
    ref Guid rfid,   // GUID*
    uint dwFlags,   // DWORD
    IntPtr hToken,   // HANDLE optional
    IntPtr ppidl   // ITEMIDLIST** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetKnownFolderIDList(
    ByRef rfid As Guid,   ' GUID*
    dwFlags As UInteger,   ' DWORD
    hToken As IntPtr,   ' HANDLE optional
    ppidl As IntPtr   ' ITEMIDLIST** out
) As Integer
End Function

' rfid : GUID*
' dwFlags : DWORD
' hToken : HANDLE optional
' ppidl : ITEMIDLIST** out
Declare PtrSafe Function SHGetKnownFolderIDList Lib "shell32" ( _
    ByVal rfid As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal hToken As LongPtr, _
    ByVal ppidl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHGetKnownFolderIDList = ctypes.windll.shell32.SHGetKnownFolderIDList
SHGetKnownFolderIDList.restype = ctypes.c_int
SHGetKnownFolderIDList.argtypes = [
    ctypes.c_void_p,  # rfid : GUID*
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.HANDLE,  # hToken : HANDLE optional
    ctypes.c_void_p,  # ppidl : ITEMIDLIST** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetKnownFolderIDList = Fiddle::Function.new(
  lib['SHGetKnownFolderIDList'],
  [
    Fiddle::TYPE_VOIDP,  # rfid : GUID*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # ppidl : ITEMIDLIST** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetKnownFolderIDList(
        rfid: *const GUID,  // GUID*
        dwFlags: u32,  // DWORD
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        ppidl: *mut *mut ITEMIDLIST  // ITEMIDLIST** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHGetKnownFolderIDList(ref Guid rfid, uint dwFlags, IntPtr hToken, IntPtr ppidl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetKnownFolderIDList' -Namespace Win32 -PassThru
# $api::SHGetKnownFolderIDList(rfid, dwFlags, hToken, ppidl)

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

出力引数:

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