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

SHGetFolderPathAndSubDirW

関数
特殊フォルダー配下のサブディレクトリパス(Unicode)を取得し作成する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

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

パラメーター

名前方向
hwndHWNDoptional
csidlINTin
hTokenHANDLEinoptional
dwFlagsDWORDin
pszSubDirLPCWSTRinoptional
pszPathLPWSTRout

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SHGetFolderPathAndSubDirW(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCWSTR pszSubDir,   // optional
    LPWSTR pszPath
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHGetFolderPathAndSubDirW(
    IntPtr hwnd,   // HWND optional
    int csidl,   // INT
    IntPtr hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pszSubDir,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath   // LPWSTR out
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHGetFolderPathAndSubDirW(
    hwnd As IntPtr,   ' HWND optional
    csidl As Integer,   ' INT
    hToken As IntPtr,   ' HANDLE optional
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszSubDir As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder   ' LPWSTR out
) As Integer
End Function
' hwnd : HWND optional
' csidl : INT
' hToken : HANDLE optional
' dwFlags : DWORD
' pszSubDir : LPCWSTR optional
' pszPath : LPWSTR out
Declare PtrSafe Function SHGetFolderPathAndSubDirW Lib "shell32" ( _
    ByVal hwnd As LongPtr, _
    ByVal csidl As Long, _
    ByVal hToken As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pszSubDir As LongPtr, _
    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

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

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetFolderPathAndSubDirW = shell32.NewProc("SHGetFolderPathAndSubDirW")
)

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