ホーム › 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
);

パラメーター

名前	型	方向	説明
hwnd	HWND	optional	予約済み。
csidl	INT	in	パスを取得するフォルダーを識別する CSIDL 値です。実在するフォルダーのみが有効です。仮想フォルダーを指定した場合、この関数は失敗します。フォルダーの CSIDL に CSIDL_FLAG_CREATE を組み合わせることで、SHGetFolderPathAndSubDir によるフォルダーの作成を強制できます。
hToken	HANDLE	inoptional	特定のユーザーを表すアクセストークンです。Windows 2000 より前のシステムでは、この値を NULL に設定します。それ以降のシステムでは、通常 hToken は NULL に設定されますが、常にそうとは限りません。複数のユーザーが利用できるものの単一のユーザーに属するものとして扱われるフォルダーについては、hToken に値を割り当てる必要がある場合があります。この種のフォルダーで最もよく使用されるのは My Documents です。
dwFlags	DWORD	in	返されるパスがフォルダーの実際のパスか、それとも既定のパスかを指定します。この値は、CSIDL 値に関連付けられたフォルダーがユーザーによって移動または名前変更される可能性がある場合に使用されます。 SHGFP_TYPE_CURRENT フォルダーの現在のパスを返します。 SHGFP_TYPE_DEFAULT フォルダーの既定のパスを返します。
pszSubDir	LPCWSTR	inoptional	フォルダーのパスに追加するサブパスへのポインターです。これは長さ MAX_PATH の null 終端文字列です。新しいディレクトリを作成しない場合、これは既存のサブディレクトリでなければならず、そうでない場合この関数はエラーを返します。サブパスを追加しない場合、この値は NULL にできます。
pszPath	LPWSTR	out	この関数が戻るとき、この値はディレクトリのパスと追加されたサブパスを指します。これは長さ MAX_PATH の null 終端文字列です。この文字列は、関数がエラーコードを返すときには空になります。 - dwFlags.SHGFP_TYPE_CURRENT フォルダーの現在のパスを返します。 - dwFlags.SHGFP_TYPE_DEFAULT フォルダーの既定のパスを返します。

戻り値の型: HRESULT

公式ドキュメント

フォルダーのパスを取得し、ユーザーが指定したサブフォルダーのパスを追加します。(Unicode)

戻り値

型: HRESULT

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 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 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHGetFolderPathAndSubDirW "SHGetFolderPathAndSubDirW" sptr, int, sptr, int, wstr, sptr
; res = SHGetFolderPathAndSubDirW(hwnd, csidl, hToken, dwFlags, pszSubDir, varptr(pszPath))
; hwnd : HWND optional -> "sptr"
; csidl : INT -> "int"
; hToken : HANDLE optional -> "sptr"
; dwFlags : DWORD -> "int"
; pszSubDir : LPCWSTR optional -> "wstr"
; pszPath : LPWSTR out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; 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, intptr
; res = SHGetFolderPathAndSubDirW(hwnd, csidl, hToken, dwFlags, pszSubDir, varptr(pszPath))
; hwnd : HWND optional -> "intptr"
; csidl : INT -> "int"
; hToken : HANDLE optional -> "intptr"
; dwFlags : DWORD -> "int"
; pszSubDir : LPCWSTR optional -> "wstr"
; pszPath : LPWSTR out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 版の利用を推奨。

const std = @import("std");

extern "shell32" fn SHGetFolderPathAndSubDirW(
    hwnd: ?*anyopaque, // HWND optional
    csidl: i32, // INT
    hToken: ?*anyopaque, // HANDLE optional
    dwFlags: u32, // DWORD
    pszSubDir: [*c]const u16, // LPCWSTR optional
    pszPath: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。

proc SHGetFolderPathAndSubDirW(
    hwnd: pointer,  # HWND optional
    csidl: int32,  # INT
    hToken: pointer,  # HANDLE optional
    dwFlags: uint32,  # DWORD
    pszSubDir: WideCString,  # LPCWSTR optional
    pszPath: ptr uint16  # LPWSTR out
): int32 {.importc: "SHGetFolderPathAndSubDirW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "shell32");
extern(Windows)
int SHGetFolderPathAndSubDirW(
    void* hwnd,   // HWND optional
    int csidl,   // INT
    void* hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    const(wchar)* pszSubDir,   // LPCWSTR optional
    wchar* pszPath   // LPWSTR out
);

ccall((:SHGetFolderPathAndSubDirW, "SHELL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, UInt32, Cwstring, Ptr{UInt16}),
      hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath)
# hwnd : HWND optional -> Ptr{Cvoid}
# csidl : INT -> Int32
# hToken : HANDLE optional -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# pszSubDir : LPCWSTR optional -> Cwstring
# pszPath : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。

local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetFolderPathAndSubDirW(
    void* hwnd,
    int32_t csidl,
    void* hToken,
    uint32_t dwFlags,
    const uint16_t* pszSubDir,
    uint16_t* pszPath);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetFolderPathAndSubDirW(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath)
-- hwnd : HWND optional
-- csidl : INT
-- hToken : HANDLE optional
-- dwFlags : DWORD
-- pszSubDir : LPCWSTR optional
-- 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 SHGetFolderPathAndSubDirW = lib.func('__stdcall', 'SHGetFolderPathAndSubDirW', 'int32_t', ['void *', 'int32_t', 'void *', 'uint32_t', 'str16', 'uint16_t *']);
// SHGetFolderPathAndSubDirW(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath)
// hwnd : HWND optional -> 'void *'
// csidl : INT -> 'int32_t'
// hToken : HANDLE optional -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// pszSubDir : LPCWSTR optional -> 'str16'
// pszPath : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("SHELL32.dll", {
  SHGetFolderPathAndSubDirW: { parameters: ["pointer", "i32", "pointer", "u32", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.SHGetFolderPathAndSubDirW(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath)
// hwnd : HWND optional -> "pointer"
// csidl : INT -> "i32"
// hToken : HANDLE optional -> "pointer"
// dwFlags : DWORD -> "u32"
// pszSubDir : LPCWSTR optional -> "buffer"
// pszPath : LPWSTR out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetFolderPathAndSubDirW(
    void* hwnd,
    int32_t csidl,
    void* hToken,
    uint32_t dwFlags,
    const uint16_t* pszSubDir,
    uint16_t* pszPath);
C, "SHELL32.dll");
// $ffi->SHGetFolderPathAndSubDirW(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath);
// hwnd : HWND optional
// csidl : INT
// hToken : HANDLE optional
// dwFlags : DWORD
// pszSubDir : LPCWSTR optional
// 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 SHGetFolderPathAndSubDirW(
        Pointer hwnd,   // HWND optional
        int csidl,   // INT
        Pointer hToken,   // HANDLE optional
        int dwFlags,   // DWORD
        WString pszSubDir,   // LPCWSTR optional
        char[] pszPath   // LPWSTR out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。

@[Link("shell32")]
lib LibSHELL32
  fun SHGetFolderPathAndSubDirW = SHGetFolderPathAndSubDirW(
    hwnd : Void*,   # HWND optional
    csidl : Int32,   # INT
    hToken : Void*,   # HANDLE optional
    dwFlags : UInt32,   # DWORD
    pszSubDir : UInt16*,   # LPCWSTR optional
    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 SHGetFolderPathAndSubDirWNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Utf16>);
typedef SHGetFolderPathAndSubDirWDart = int Function(Pointer<Void>, int, Pointer<Void>, int, Pointer<Utf16>, Pointer<Utf16>);
final SHGetFolderPathAndSubDirW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetFolderPathAndSubDirWNative, SHGetFolderPathAndSubDirWDart>('SHGetFolderPathAndSubDirW');
// hwnd : HWND optional -> Pointer<Void>
// csidl : INT -> Int32
// hToken : HANDLE optional -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// pszSubDir : LPCWSTR optional -> Pointer<Utf16>
// pszPath : LPWSTR out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
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';

import Foreign
import Foreign.C.Types
import Foreign.C.String

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

open Ctypes
open Foreign

let shgetfolderpathandsubdirw =
  foreign "SHGetFolderPathAndSubDirW"
    ((ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr uint16_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 *)
(* pszSubDir : LPCWSTR optional -> (ptr uint16_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 ("SHGetFolderPathAndSubDirW" shget-folder-path-and-sub-dir-w :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND optional
  (csidl :int32)   ; INT
  (h-token :pointer)   ; HANDLE optional
  (dw-flags :uint32)   ; DWORD
  (psz-sub-dir (:string :encoding :utf-16le))   ; LPCWSTR optional
  (psz-path :pointer))   ; LPWSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SHGetFolderPathAndSubDirW = Win32::API::More->new('SHELL32',
    'int SHGetFolderPathAndSubDirW(HANDLE hwnd, int csidl, HANDLE hToken, DWORD dwFlags, LPCWSTR pszSubDir, LPWSTR pszPath)');
# my $ret = $SHGetFolderPathAndSubDirW->Call($hwnd, $csidl, $hToken, $dwFlags, $pszSubDir, $pszPath);
# hwnd : HWND optional -> HANDLE
# csidl : INT -> int
# hToken : HANDLE optional -> HANDLE
# dwFlags : DWORD -> DWORD
# pszSubDir : LPCWSTR optional -> LPCWSTR
# pszPath : LPWSTR out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

SHGetFolderPathAndSubDirW

シグネチャ

パラメーター

SHGFP_TYPE_CURRENT

SHGFP_TYPE_DEFAULT

- dwFlags.SHGFP_TYPE_CURRENT

- dwFlags.SHGFP_TYPE_DEFAULT

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目