ホーム › UI.Shell › SHGetFolderLocation

SHGetFolderLocation

関数

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

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

シグネチャ

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

HRESULT SHGetFolderLocation(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    ITEMIDLIST** ppidl
);

パラメーター

名前	型	方向	説明
hwnd	HWND	optional	予約済みです。
csidl	INT	in	検索対象のフォルダーを識別する CSIDL 値です。CSIDL に対応するフォルダーは、特定のシステム上に存在しない場合があります。
hToken	HANDLE	inoptional	特定のユーザーを表すために使用できるアクセストークンです。通常は NULL に設定しますが、単一のユーザーに属するものとして扱われるフォルダーに対して複数のユーザーが存在する場合に必要となることがあります。この種のフォルダーで最もよく使われるのはマイドキュメントです。hToken が NULL 以外の場合、正しい偽装(impersonation)を行うのは呼び出し側アプリケーションの責任です。該当ユーザーに対する適切なセキュリティ特権を持っている必要があり、かつそのユーザーのレジストリハイブが現在マウントされている必要があります。アクセス制御に関する詳細については Access Control を参照してください。 hToken パラメーターに値 -1 を指定すると、Default User(既定のユーザー)を表します。これにより、SHGetFolderLocation の呼び出し側は Default User のフォルダーの場所(デスクトップフォルダーなど)を取得できます。Default User のユーザープロファイルは、新しいユーザーアカウントが作成されるたびに複製され、マイドキュメントやデスクトップなどの特別なフォルダーを含みます。Default User フォルダーに追加した項目は、新しいユーザーアカウントにも反映されます。
dwFlags	DWORD	in
ppidl	ITEMIDLIST**	out	名前空間のルート(デスクトップ)を基準としたフォルダーの場所を指定する、アイテム識別子リスト構造体へのポインターのアドレスです。失敗した場合、ppidl パラメーターは NULL に設定されます。このリソースは ILFree を呼び出して解放するのは呼び出し側アプリケーションの責任です。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

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

戻り値	説明
HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND)	nFolder の CSIDL は有効ですが、フォルダーが存在しません。
E_INVALIDARG	nFolder の CSIDL が無効です。

解説(Remarks)

注 Windows Vista 以降、この関数は単に SHGetKnownFolderIDList のラッパーにすぎません。CSIDL 値は対応する KNOWNFOLDERID に変換され、SHGetKnownFolderIDList が呼び出されます。新しいアプリケーションでは、後方互換性のためにのみサポートされている従来の CSIDL システムではなく、Known Folder(既知のフォルダー)システムを使用してください。

SHGetFolderLocation、SHGetFolderPath、SHGetSpecialFolderLocation、および SHGetSpecialFolderPath の各関数は、Windows Vista より前のシステムでフォルダーへのハンドルを取得するための推奨される方法です。環境変数名を %VariableName% の形式で直接使用する ExpandEnvironmentStrings のような関数は、信頼できない場合があります。

この関数は、以前のバージョンの Shell に含まれていた SHGetSpecialFolderLocation のスーパーセットです。

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

各言語での呼び出し定義

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

HRESULT SHGetFolderLocation(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    ITEMIDLIST** ppidl
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetFolderLocation(
    IntPtr hwnd,   // HWND optional
    int csidl,   // INT
    IntPtr hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    IntPtr ppidl   // ITEMIDLIST** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetFolderLocation(
    hwnd As IntPtr,   ' HWND optional
    csidl As Integer,   ' INT
    hToken As IntPtr,   ' HANDLE optional
    dwFlags As UInteger,   ' DWORD
    ppidl As IntPtr   ' ITEMIDLIST** out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

SHGetFolderLocation = ctypes.windll.shell32.SHGetFolderLocation
SHGetFolderLocation.restype = ctypes.c_int
SHGetFolderLocation.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    ctypes.c_int,  # csidl : INT
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # ppidl : ITEMIDLIST** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetFolderLocation = Fiddle::Function.new(
  lib['SHGetFolderLocation'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_INT,  # csidl : INT
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # ppidl : ITEMIDLIST** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetFolderLocation(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        csidl: i32,  // INT
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        dwFlags: u32,  // DWORD
        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 SHGetFolderLocation(IntPtr hwnd, int csidl, IntPtr hToken, uint dwFlags, IntPtr ppidl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetFolderLocation' -Namespace Win32 -PassThru
# $api::SHGetFolderLocation(hwnd, csidl, hToken, dwFlags, ppidl)

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

出力引数:

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