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

この関数を呼び出す際には、ファイルシステムのパスを受け取るための null 終端の Unicode バッファを渡します。このバッファのサイズは cchPath です。

この関数が戻ると、ファイルシステムのパスを格納した null 終端の Unicode バッファのアドレスが格納されます。このバッファのサイズは cchPath です。

cchPathDWORDinpszPath が指すバッファのサイズ(文字数)です。
uOptsGPFIDL_FLAGSin

これらのフラグは、返されるパスの種類を決定します。

GPFIDL_DEFAULT (0x0000)

Win32 ファイル名、サーバー、ルートドライブが含まれます。

GPFIDL_ALTNAME (0x0001)

短いファイル名を使用します。

GPFIDL_UNCPRINTER (0x0002)

UNC プリンター名の項目を含めます。

戻り値の型: BOOL

公式ドキュメント

アイテム識別子リストをファイルシステムのパスに変換します。この関数は SHGetPathFromIDList を拡張したもので、文字列バッファの初期サイズを設定し、以下のオプションを指定できます。

戻り値

型: BOOL

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

UNC プリンター名を除き、pidl パラメーターで指定された場所がファイルシステムの一部でない場合、この関数は失敗します。

pidl パラメーターがショートカットを指定している場合、pszPath にはショートカットのパスが格納され、ショートカットのターゲットのパスは格納されません。

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

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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)。
const std = @import("std");

extern "shell32" fn SHGetPathFromIDListEx(
    pidl: [*c]ITEMIDLIST, // ITEMIDLIST*
    pszPath: [*c]u16, // LPWSTR out
    cchPath: u32, // DWORD
    uOpts: u32 // GPFIDL_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc SHGetPathFromIDListEx(
    pidl: ptr ITEMIDLIST,  # ITEMIDLIST*
    pszPath: ptr uint16,  # LPWSTR out
    cchPath: uint32,  # DWORD
    uOpts: uint32  # GPFIDL_FLAGS
): int32 {.importc: "SHGetPathFromIDListEx", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHGetPathFromIDListEx(
    ITEMIDLIST* pidl,   // ITEMIDLIST*
    wchar* pszPath,   // LPWSTR out
    uint cchPath,   // DWORD
    uint uOpts   // GPFIDL_FLAGS
);
ccall((:SHGetPathFromIDListEx, "SHELL32.dll"), stdcall, Int32,
      (Ptr{ITEMIDLIST}, Ptr{UInt16}, UInt32, UInt32),
      pidl, pszPath, cchPath, uOpts)
# pidl : ITEMIDLIST* -> Ptr{ITEMIDLIST}
# pszPath : LPWSTR out -> Ptr{UInt16}
# cchPath : DWORD -> UInt32
# uOpts : GPFIDL_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetPathFromIDListEx(
    void* pidl,
    uint16_t* pszPath,
    uint32_t cchPath,
    uint32_t uOpts);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts)
-- pidl : ITEMIDLIST*
-- pszPath : LPWSTR out
-- cchPath : DWORD
-- uOpts : GPFIDL_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHGetPathFromIDListEx = lib.func('__stdcall', 'SHGetPathFromIDListEx', 'int32_t', ['void *', 'uint16_t *', 'uint32_t', 'uint32_t']);
// SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts)
// pidl : ITEMIDLIST* -> 'void *'
// pszPath : LPWSTR out -> 'uint16_t *'
// cchPath : DWORD -> 'uint32_t'
// uOpts : GPFIDL_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHGetPathFromIDListEx: { parameters: ["pointer", "buffer", "u32", "u32"], result: "i32" },
});
// lib.symbols.SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts)
// pidl : ITEMIDLIST* -> "pointer"
// pszPath : LPWSTR out -> "buffer"
// cchPath : DWORD -> "u32"
// uOpts : GPFIDL_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetPathFromIDListEx(
    void* pidl,
    uint16_t* pszPath,
    uint32_t cchPath,
    uint32_t uOpts);
C, "SHELL32.dll");
// $ffi->SHGetPathFromIDListEx(pidl, pszPath, cchPath, uOpts);
// pidl : ITEMIDLIST*
// pszPath : LPWSTR out
// cchPath : DWORD
// uOpts : GPFIDL_FLAGS
// 構造体/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);
    boolean SHGetPathFromIDListEx(
        Pointer pidl,   // ITEMIDLIST*
        char[] pszPath,   // LPWSTR out
        int cchPath,   // DWORD
        int uOpts   // GPFIDL_FLAGS
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHGetPathFromIDListEx = SHGetPathFromIDListEx(
    pidl : ITEMIDLIST*,   # ITEMIDLIST*
    pszPath : UInt16*,   # LPWSTR out
    cchPath : UInt32,   # DWORD
    uOpts : UInt32   # GPFIDL_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHGetPathFromIDListExNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Uint32);
typedef SHGetPathFromIDListExDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int);
final SHGetPathFromIDListEx = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetPathFromIDListExNative, SHGetPathFromIDListExDart>('SHGetPathFromIDListEx');
// pidl : ITEMIDLIST* -> Pointer<Void>
// pszPath : LPWSTR out -> Pointer<Utf16>
// cchPath : DWORD -> Uint32
// uOpts : GPFIDL_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetPathFromIDListEx(
  pidl: Pointer;   // ITEMIDLIST*
  pszPath: PWideChar;   // LPWSTR out
  cchPath: DWORD;   // DWORD
  uOpts: DWORD   // GPFIDL_FLAGS
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetPathFromIDListEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetPathFromIDListEx"
  c_SHGetPathFromIDListEx :: Ptr () -> CWString -> Word32 -> Word32 -> IO CInt
-- pidl : ITEMIDLIST* -> Ptr ()
-- pszPath : LPWSTR out -> CWString
-- cchPath : DWORD -> Word32
-- uOpts : GPFIDL_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shgetpathfromidlistex =
  foreign "SHGetPathFromIDListEx"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* pidl : ITEMIDLIST* -> (ptr void) *)
(* pszPath : LPWSTR out -> (ptr uint16_t) *)
(* cchPath : DWORD -> uint32_t *)
(* uOpts : GPFIDL_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHGetPathFromIDListEx" shget-path-from-idlist-ex :convention :stdcall) :int32
  (pidl :pointer)   ; ITEMIDLIST*
  (psz-path :pointer)   ; LPWSTR out
  (cch-path :uint32)   ; DWORD
  (u-opts :uint32))   ; GPFIDL_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetPathFromIDListEx = Win32::API::More->new('SHELL32',
    'BOOL SHGetPathFromIDListEx(LPVOID pidl, LPWSTR pszPath, DWORD cchPath, DWORD uOpts)');
# my $ret = $SHGetPathFromIDListEx->Call($pidl, $pszPath, $cchPath, $uOpts);
# pidl : ITEMIDLIST* -> LPVOID
# pszPath : LPWSTR out -> LPWSTR
# cchPath : DWORD -> DWORD
# uOpts : GPFIDL_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型