Win32 API 日本語リファレンス
ホームUI.Shell › SHGetFolderPathW

SHGetFolderPathW

関数
CSIDLで指定したフォルダーのパス(Unicode)を取得する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHGetFolderPathW(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPWSTR pszPath
);

パラメーター

名前方向説明
hwndHWNDoptional予約済みです。
csidlINTinパスを取得するフォルダーを識別する CSIDL 値です。実在するフォルダーのみが有効です。仮想フォルダーを指定した場合、この関数は失敗します。フォルダーの CSIDLCSIDL_FLAG_CREATE と組み合わせることで、フォルダーの作成を強制できます。
hTokenHANDLEinoptional

特定のユーザーを表すために使用できる アクセス トークンです。

Microsoft Windows 2000 以前: このパラメーターには常に NULL を設定してください。

Windows XP 以降: このパラメーターには通常 NULL を設定しますが、複数のユーザーを持ちながら単一ユーザーに属するものとして扱われるフォルダーについては、hTokenNULL 以外の値を割り当てる必要がある場合があります。この種のフォルダーで最もよく使用されるのは Documents です。

hTokenNULL 以外の場合、正しい偽装処理を行う責任は呼び出し側のプロセスにあります。呼び出し側のプロセスは、TOKEN_QUERY および TOKEN_IMPERSONATE を含む、対象ユーザーに対する適切なセキュリティ特権を持っている必要があり、また、そのユーザーのレジストリ ハイブが現在マウントされている必要があります。アクセス制御に関する詳細は Access Control を参照してください。

hToken パラメーターに -1 の値を割り当てると、Default User を示します。これにより、SHGetFolderPath のクライアントは Default User に対するフォルダーの場所(デスクトップ フォルダーなど)を取得できます。Default User のユーザー プロファイルは、新しいユーザー アカウントが作成されるたびに複製され、My Documents や Desktop などの特殊フォルダーを含みます。Default User フォルダーに追加された項目は、新しいユーザー アカウントにも表示されます。

dwFlagsDWORDin

返されるパスを指定するフラグです。この値は、KNOWNFOLDERID(または CSIDL)に関連付けられたフォルダーが、ユーザーまたは管理者によって移動、名前変更、リダイレクト、または言語間でローミングされる可能性がある場合に使用されます。

SHGetFolderPath の基盤となる既知のフォルダー システムでは、ユーザーまたは管理者が既知のフォルダーを必要に応じた場所にリダイレクトできます。これは IKnownFolderManager::Redirect を呼び出すことで実現され、SHGFP_TYPE_CURRENT フラグに関連付けられたフォルダーの「現在の」値を設定します。

フォルダーの既定値、すなわちユーザーまたは管理者がリダイレクトしていなかった場合のフォルダーの場所は、SHGFP_TYPE_DEFAULT フラグを指定することで取得されます。この値は、既知のフォルダーに対する「既定値に戻す」機能を実装するために使用できます。

たとえば、FOLDERID_Music(CSIDL_MYMUSIC)の既定値(SHGFP_TYPE_DEFAULT)は "C:\Users\user name\Music" です。フォルダーがリダイレクトされている場合、現在の値(SHGFP_TYPE_CURRENT)は "D:\Music" などになります。フォルダーがリダイレクトされていない場合、SHGFP_TYPE_DEFAULTSHGFP_TYPE_CURRENT は同じパスを取得します。

SHGFP_TYPE_CURRENT

フォルダーの現在のパスを取得します。

SHGFP_TYPE_DEFAULT

フォルダーの既定のパスを取得します。

pszPathLPWSTRout

パスを受け取る、長さ MAX_PATHnull 終端文字列へのポインターです。エラーが発生した場合や S_FALSE が返された場合、この文字列は空になります。返されるパスには末尾のバックスラッシュは含まれません。たとえば、"C:\Users\" ではなく "C:\Users" が返されます。

- dwFlags.SHGFP_TYPE_CURRENT

フォルダーの現在のパスを取得します。

- dwFlags.SHGFP_TYPE_DEFAULT

フォルダーの既定のパスを取得します。

戻り値の型: HRESULT

公式ドキュメント

非推奨です。(SHGetFolderPathW)

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

解説(Remarks)

この関数は SHGetSpecialFolderPath のスーパーセットです。

サポートされる CSIDL 値は一部のみであり、以下が含まれます:

使用例

次のコード例では、SHGetFolderPath を使用してフォルダーを検索または作成し、その中にファイルを作成します。

TCHAR szPath[MAX_PATH];

if(SUCCEEDED(SHGetFolderPath(NULL, 
                             CSIDL_PERSONAL|CSIDL_FLAG_CREATE, 
                             NULL, 
                             0, 
                             szPath))) 
{
    PathAppend(szPath, TEXT("New Doc.txt"));
    HANDLE hFile = CreateFile(szPath, ...);
}
メモ

shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHGetFolderPath を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不整合が生じてコンパイル エラーや実行時エラーを引き起こす可能性があります。詳細については Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHGetFolderPathW(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPWSTR pszPath
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHGetFolderPathW(
    IntPtr hwnd,   // HWND optional
    int csidl,   // INT
    IntPtr hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath   // LPWSTR out
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHGetFolderPathW(
    hwnd As IntPtr,   ' HWND optional
    csidl As Integer,   ' INT
    hToken As IntPtr,   ' HANDLE optional
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder   ' LPWSTR out
) As Integer
End Function
' hwnd : HWND optional
' csidl : INT
' hToken : HANDLE optional
' dwFlags : DWORD
' pszPath : LPWSTR out
Declare PtrSafe Function SHGetFolderPathW Lib "shell32" ( _
    ByVal hwnd As LongPtr, _
    ByVal csidl As Long, _
    ByVal hToken As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pszPath As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetFolderPathW = ctypes.windll.shell32.SHGetFolderPathW
SHGetFolderPathW.restype = ctypes.c_int
SHGetFolderPathW.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    ctypes.c_int,  # csidl : INT
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPWSTR,  # pszPath : LPWSTR out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetFolderPathW = Fiddle::Function.new(
  lib['SHGetFolderPathW'],
  [
    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,  # pszPath : LPWSTR out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shell32")]
extern "system" {
    fn SHGetFolderPathW(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        csidl: i32,  // INT
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        dwFlags: u32,  // DWORD
        pszPath: *mut u16  // LPWSTR out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHGetFolderPathW(IntPtr hwnd, int csidl, IntPtr hToken, uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetFolderPathW' -Namespace Win32 -PassThru
# $api::SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath)
#uselib "SHELL32.dll"
#func global SHGetFolderPathW "SHGetFolderPathW" wptr, wptr, wptr, wptr, wptr
; SHGetFolderPathW hwnd, csidl, hToken, dwFlags, varptr(pszPath)   ; 戻り値は stat
; hwnd : HWND optional -> "wptr"
; csidl : INT -> "wptr"
; hToken : HANDLE optional -> "wptr"
; dwFlags : DWORD -> "wptr"
; pszPath : LPWSTR out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHGetFolderPathW "SHGetFolderPathW" sptr, int, sptr, int, var
; res = SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath)
; hwnd : HWND optional -> "sptr"
; csidl : INT -> "int"
; hToken : HANDLE optional -> "sptr"
; dwFlags : DWORD -> "int"
; pszPath : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHGetFolderPathW(HWND hwnd, INT csidl, HANDLE hToken, DWORD dwFlags, LPWSTR pszPath)
#uselib "SHELL32.dll"
#cfunc global SHGetFolderPathW "SHGetFolderPathW" intptr, int, intptr, int, var
; res = SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath)
; hwnd : HWND optional -> "intptr"
; csidl : INT -> "int"
; hToken : HANDLE optional -> "intptr"
; dwFlags : DWORD -> "int"
; pszPath : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetFolderPathW = shell32.NewProc("SHGetFolderPathW")
)

// hwnd (HWND optional), csidl (INT), hToken (HANDLE optional), dwFlags (DWORD), pszPath (LPWSTR out)
r1, _, err := procSHGetFolderPathW.Call(
	uintptr(hwnd),
	uintptr(csidl),
	uintptr(hToken),
	uintptr(dwFlags),
	uintptr(pszPath),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHGetFolderPathW(
  hwnd: THandle;   // HWND optional
  csidl: Integer;   // INT
  hToken: THandle;   // HANDLE optional
  dwFlags: DWORD;   // DWORD
  pszPath: PWideChar   // LPWSTR out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetFolderPathW';
result := DllCall("SHELL32\SHGetFolderPathW"
    , "Ptr", hwnd   ; HWND optional
    , "Int", csidl   ; INT
    , "Ptr", hToken   ; HANDLE optional
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pszPath   ; LPWSTR out
    , "Int")   ; return: HRESULT
●SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath) = DLL("SHELL32.dll", "int SHGetFolderPathW(void*, int, void*, dword, char*)")
# 呼び出し: SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath)
# hwnd : HWND optional -> "void*"
# csidl : INT -> "int"
# hToken : HANDLE optional -> "void*"
# dwFlags : DWORD -> "dword"
# pszPath : LPWSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shell32" fn SHGetFolderPathW(
    hwnd: ?*anyopaque, // HWND optional
    csidl: i32, // INT
    hToken: ?*anyopaque, // HANDLE optional
    dwFlags: u32, // DWORD
    pszPath: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHGetFolderPathW(
    hwnd: pointer,  # HWND optional
    csidl: int32,  # INT
    hToken: pointer,  # HANDLE optional
    dwFlags: uint32,  # DWORD
    pszPath: ptr uint16  # LPWSTR out
): int32 {.importc: "SHGetFolderPathW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shell32");
extern(Windows)
int SHGetFolderPathW(
    void* hwnd,   // HWND optional
    int csidl,   // INT
    void* hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    wchar* pszPath   // LPWSTR out
);
ccall((:SHGetFolderPathW, "SHELL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, UInt32, Ptr{UInt16}),
      hwnd, csidl, hToken, dwFlags, pszPath)
# hwnd : HWND optional -> Ptr{Cvoid}
# csidl : INT -> Int32
# hToken : HANDLE optional -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# pszPath : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetFolderPathW(
    void* hwnd,
    int32_t csidl,
    void* hToken,
    uint32_t dwFlags,
    uint16_t* pszPath);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath)
-- hwnd : HWND optional
-- csidl : INT
-- hToken : HANDLE optional
-- dwFlags : DWORD
-- pszPath : LPWSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHGetFolderPathW = lib.func('__stdcall', 'SHGetFolderPathW', 'int32_t', ['void *', 'int32_t', 'void *', 'uint32_t', 'uint16_t *']);
// SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath)
// hwnd : HWND optional -> 'void *'
// csidl : INT -> 'int32_t'
// hToken : HANDLE optional -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// pszPath : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHGetFolderPathW: { parameters: ["pointer", "i32", "pointer", "u32", "buffer"], result: "i32" },
});
// lib.symbols.SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath)
// hwnd : HWND optional -> "pointer"
// csidl : INT -> "i32"
// hToken : HANDLE optional -> "pointer"
// dwFlags : DWORD -> "u32"
// pszPath : LPWSTR out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetFolderPathW(
    void* hwnd,
    int32_t csidl,
    void* hToken,
    uint32_t dwFlags,
    uint16_t* pszPath);
C, "SHELL32.dll");
// $ffi->SHGetFolderPathW(hwnd, csidl, hToken, dwFlags, pszPath);
// hwnd : HWND optional
// csidl : INT
// hToken : HANDLE optional
// dwFlags : DWORD
// pszPath : LPWSTR out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.UNICODE_OPTIONS);
    int SHGetFolderPathW(
        Pointer hwnd,   // HWND optional
        int csidl,   // INT
        Pointer hToken,   // HANDLE optional
        int dwFlags,   // DWORD
        char[] pszPath   // LPWSTR out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shell32")]
lib LibSHELL32
  fun SHGetFolderPathW = SHGetFolderPathW(
    hwnd : Void*,   # HWND optional
    csidl : Int32,   # INT
    hToken : Void*,   # HANDLE optional
    dwFlags : UInt32,   # DWORD
    pszPath : UInt16*   # LPWSTR out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHGetFolderPathWNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>, Uint32, Pointer<Utf16>);
typedef SHGetFolderPathWDart = int Function(Pointer<Void>, int, Pointer<Void>, int, Pointer<Utf16>);
final SHGetFolderPathW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetFolderPathWNative, SHGetFolderPathWDart>('SHGetFolderPathW');
// hwnd : HWND optional -> Pointer<Void>
// csidl : INT -> Int32
// hToken : HANDLE optional -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// pszPath : LPWSTR out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetFolderPathW(
  hwnd: THandle;   // HWND optional
  csidl: Integer;   // INT
  hToken: THandle;   // HANDLE optional
  dwFlags: DWORD;   // DWORD
  pszPath: PWideChar   // LPWSTR out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetFolderPathW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetFolderPathW"
  c_SHGetFolderPathW :: Ptr () -> Int32 -> Ptr () -> Word32 -> CWString -> IO Int32
-- hwnd : HWND optional -> Ptr ()
-- csidl : INT -> Int32
-- hToken : HANDLE optional -> Ptr ()
-- dwFlags : DWORD -> Word32
-- pszPath : LPWSTR out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shgetfolderpathw =
  foreign "SHGetFolderPathW"
    ((ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* hwnd : HWND optional -> (ptr void) *)
(* csidl : INT -> int32_t *)
(* hToken : HANDLE optional -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* pszPath : LPWSTR out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHGetFolderPathW" shget-folder-path-w :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND optional
  (csidl :int32)   ; INT
  (h-token :pointer)   ; HANDLE optional
  (dw-flags :uint32)   ; DWORD
  (psz-path :pointer))   ; LPWSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetFolderPathW = Win32::API::More->new('SHELL32',
    'int SHGetFolderPathW(HANDLE hwnd, int csidl, HANDLE hToken, DWORD dwFlags, LPWSTR pszPath)');
# my $ret = $SHGetFolderPathW->Call($hwnd, $csidl, $hToken, $dwFlags, $pszPath);
# hwnd : HWND optional -> HANDLE
# csidl : INT -> int
# hToken : HANDLE optional -> HANDLE
# dwFlags : DWORD -> DWORD
# pszPath : LPWSTR out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い