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

SHGetPathFromIDListEx

関数
PIDLからオプション指定でファイルシステムパスを取得する。
DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

BOOL SHGetPathFromIDListEx(
    ITEMIDLIST* pidl,
    LPWSTR pszPath,
    DWORD cchPath,
    GPFIDL_FLAGS uOpts
);

パラメーター

名前方向
pidlITEMIDLIST*in
pszPathLPWSTRout
cchPathDWORDin
uOptsGPFIDL_FLAGSin

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SHGetPathFromIDListEx(
    ITEMIDLIST* pidl,
    LPWSTR pszPath,
    DWORD cchPath,
    GPFIDL_FLAGS uOpts
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern bool SHGetPathFromIDListEx(
    IntPtr pidl,   // ITEMIDLIST*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath,   // LPWSTR out
    uint cchPath,   // DWORD
    uint uOpts   // GPFIDL_FLAGS
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetPathFromIDListEx(
    pidl As IntPtr,   ' ITEMIDLIST*
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder,   ' LPWSTR out
    cchPath As UInteger,   ' DWORD
    uOpts As UInteger   ' GPFIDL_FLAGS
) As Boolean
End Function
' pidl : ITEMIDLIST*
' pszPath : LPWSTR out
' cchPath : DWORD
' uOpts : GPFIDL_FLAGS
Declare PtrSafe Function SHGetPathFromIDListEx Lib "shell32" ( _
    ByVal pidl As LongPtr, _
    ByVal pszPath As LongPtr, _
    ByVal cchPath As Long, _
    ByVal uOpts As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetPathFromIDListEx = ctypes.windll.shell32.SHGetPathFromIDListEx
SHGetPathFromIDListEx.restype = wintypes.BOOL
SHGetPathFromIDListEx.argtypes = [
    ctypes.c_void_p,  # pidl : ITEMIDLIST*
    wintypes.LPWSTR,  # pszPath : LPWSTR out
    wintypes.DWORD,  # cchPath : DWORD
    wintypes.DWORD,  # uOpts : GPFIDL_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetPathFromIDListEx = Fiddle::Function.new(
  lib['SHGetPathFromIDListEx'],
  [
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST*
    Fiddle::TYPE_VOIDP,  # pszPath : LPWSTR out
    -Fiddle::TYPE_INT,  # cchPath : DWORD
    -Fiddle::TYPE_INT,  # uOpts : GPFIDL_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHGetPathFromIDListEx(
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST*
        pszPath: *mut u16,  // LPWSTR out
        cchPath: u32,  // DWORD
        uOpts: u32  // GPFIDL_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll")]
public static extern bool SHGetPathFromIDListEx(IntPtr pidl, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath, uint cchPath, uint uOpts);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetPathFromIDListEx' -Namespace Win32 -PassThru
# $api::SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts)
#uselib "SHELL32.dll"
#func global SHGetPathFromIDListEx "SHGetPathFromIDListEx" sptr, sptr, sptr, sptr
; SHGetPathFromIDListEx varptr(pidl), varptr(pszPath), cchPath, uOpts   ; 戻り値は stat
; pidl : ITEMIDLIST* -> "sptr"
; pszPath : LPWSTR out -> "sptr"
; cchPath : DWORD -> "sptr"
; uOpts : GPFIDL_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHGetPathFromIDListEx "SHGetPathFromIDListEx" var, var, int, int
; res = SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts)
; pidl : ITEMIDLIST* -> "var"
; pszPath : LPWSTR out -> "var"
; cchPath : DWORD -> "int"
; uOpts : GPFIDL_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SHGetPathFromIDListEx(ITEMIDLIST* pidl, LPWSTR pszPath, DWORD cchPath, GPFIDL_FLAGS uOpts)
#uselib "SHELL32.dll"
#cfunc global SHGetPathFromIDListEx "SHGetPathFromIDListEx" var, var, int, int
; res = SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts)
; pidl : ITEMIDLIST* -> "var"
; pszPath : LPWSTR out -> "var"
; cchPath : DWORD -> "int"
; uOpts : GPFIDL_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetPathFromIDListEx = shell32.NewProc("SHGetPathFromIDListEx")
)

// pidl (ITEMIDLIST*), pszPath (LPWSTR out), cchPath (DWORD), uOpts (GPFIDL_FLAGS)
r1, _, err := procSHGetPathFromIDListEx.Call(
	uintptr(pidl),
	uintptr(pszPath),
	uintptr(cchPath),
	uintptr(uOpts),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHGetPathFromIDListEx(
  pidl: Pointer;   // ITEMIDLIST*
  pszPath: PWideChar;   // LPWSTR out
  cchPath: DWORD;   // DWORD
  uOpts: DWORD   // GPFIDL_FLAGS
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetPathFromIDListEx';
result := DllCall("SHELL32\SHGetPathFromIDListEx"
    , "Ptr", pidl   ; ITEMIDLIST*
    , "Ptr", pszPath   ; LPWSTR out
    , "UInt", cchPath   ; DWORD
    , "UInt", uOpts   ; GPFIDL_FLAGS
    , "Int")   ; return: BOOL
●SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts) = DLL("SHELL32.dll", "bool SHGetPathFromIDListEx(void*, char*, dword, dword)")
# 呼び出し: SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts)
# pidl : ITEMIDLIST* -> "void*"
# pszPath : LPWSTR out -> "char*"
# cchPath : DWORD -> "dword"
# uOpts : GPFIDL_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。