ホーム › UI.Shell › SHGetFolderPathAndSubDirA

SHGetFolderPathAndSubDirA

関数

特殊フォルダー配下のサブディレクトリパス(ANSI)を取得し作成する。

DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

HRESULT SHGetFolderPathAndSubDirA(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCSTR pszSubDir,   // optional
    LPSTR pszPath
);

パラメーター

名前	型	方向
hwnd	HWND	optional
csidl	INT	in
hToken	HANDLE	inoptional
dwFlags	DWORD	in
pszSubDir	LPCSTR	inoptional
pszPath	LPSTR	out

戻り値の型: HRESULT

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

HRESULT SHGetFolderPathAndSubDirA(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCSTR pszSubDir,   // optional
    LPSTR pszPath
);

[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHGetFolderPathAndSubDirA(
    IntPtr hwnd,   // HWND optional
    int csidl,   // INT
    IntPtr hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string pszSubDir,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath   // LPSTR out
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHGetFolderPathAndSubDirA(
    hwnd As IntPtr,   ' HWND optional
    csidl As Integer,   ' INT
    hToken As IntPtr,   ' HANDLE optional
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszSubDir As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder   ' LPSTR out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

SHGetFolderPathAndSubDirA = ctypes.windll.shell32.SHGetFolderPathAndSubDirA
SHGetFolderPathAndSubDirA.restype = ctypes.c_int
SHGetFolderPathAndSubDirA.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    ctypes.c_int,  # csidl : INT
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCSTR,  # pszSubDir : LPCSTR optional
    wintypes.LPSTR,  # pszPath : LPSTR out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetFolderPathAndSubDirA = Fiddle::Function.new(
  lib['SHGetFolderPathAndSubDirA'],
  [
    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 : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pszPath : LPSTR out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetFolderPathAndSubDirA(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        csidl: i32,  // INT
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        dwFlags: u32,  // DWORD
        pszSubDir: *const u8,  // LPCSTR optional
        pszPath: *mut u8  // LPSTR out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern int SHGetFolderPathAndSubDirA(IntPtr hwnd, int csidl, IntPtr hToken, uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] string pszSubDir, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetFolderPathAndSubDirA' -Namespace Win32 -PassThru
# $api::SHGetFolderPathAndSubDirA(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath)

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

出力引数:

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

出力引数:

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

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetFolderPathAndSubDirA = shell32.NewProc("SHGetFolderPathAndSubDirA")
)

// hwnd (HWND optional), csidl (INT), hToken (HANDLE optional), dwFlags (DWORD), pszSubDir (LPCSTR optional), pszPath (LPSTR out)
r1, _, err := procSHGetFolderPathAndSubDirA.Call(
	uintptr(hwnd),
	uintptr(csidl),
	uintptr(hToken),
	uintptr(dwFlags),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSubDir))),
	uintptr(pszPath),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function SHGetFolderPathAndSubDirA(
  hwnd: THandle;   // HWND optional
  csidl: Integer;   // INT
  hToken: THandle;   // HANDLE optional
  dwFlags: DWORD;   // DWORD
  pszSubDir: PAnsiChar;   // LPCSTR optional
  pszPath: PAnsiChar   // LPSTR out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetFolderPathAndSubDirA';

result := DllCall("SHELL32\SHGetFolderPathAndSubDirA"
    , "Ptr", hwnd   ; HWND optional
    , "Int", csidl   ; INT
    , "Ptr", hToken   ; HANDLE optional
    , "UInt", dwFlags   ; DWORD
    , "AStr", pszSubDir   ; LPCSTR optional
    , "Ptr", pszPath   ; LPSTR out
    , "Int")   ; return: HRESULT

●SHGetFolderPathAndSubDirA(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath) = DLL("SHELL32.dll", "int SHGetFolderPathAndSubDirA(void*, int, void*, dword, char*, char*)")
# 呼び出し: SHGetFolderPathAndSubDirA(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath)
# hwnd : HWND optional -> "void*"
# csidl : INT -> "int"
# hToken : HANDLE optional -> "void*"
# dwFlags : DWORD -> "dword"
# pszSubDir : LPCSTR optional -> "char*"
# pszPath : LPSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。