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

SHGetPathFromIDListW

関数
PIDLからファイルシステムパス(Unicode)を取得する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL SHGetPathFromIDListW(
    ITEMIDLIST* pidl,
    LPWSTR pszPath
);

パラメーター

名前方向説明
pidlITEMIDLIST*in名前空間のルート(デスクトップ)を基準としたファイルまたはディレクトリの場所を指定するアイテム識別子リストのアドレスです。
pszPathLPWSTRoutファイルシステムのパスを受け取るバッファーのアドレスです。このバッファーのサイズは少なくとも MAX_PATH 文字分必要です。

戻り値の型: BOOL

公式ドキュメント

アイテム識別子リストをファイルシステムのパスに変換します。(Unicode)

戻り値

型: BOOL

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

解説(Remarks)

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

pidl パラメーターがショートカットを指定している場合、pszPath にはショートカットのターゲットではなく、ショートカット自体へのパスが格納されます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL SHGetPathFromIDListW(
    ITEMIDLIST* pidl,
    LPWSTR pszPath
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SHGetPathFromIDListW(
    IntPtr pidl,   // ITEMIDLIST*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath   // LPWSTR out
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHGetPathFromIDListW(
    pidl As IntPtr,   ' ITEMIDLIST*
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder   ' LPWSTR out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pidl : ITEMIDLIST*
' pszPath : LPWSTR out
Declare PtrSafe Function SHGetPathFromIDListW Lib "shell32" ( _
    ByVal pidl 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

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

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetPathFromIDListW = shell32.NewProc("SHGetPathFromIDListW")
)

// pidl (ITEMIDLIST*), pszPath (LPWSTR out)
r1, _, err := procSHGetPathFromIDListW.Call(
	uintptr(pidl),
	uintptr(pszPath),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHGetPathFromIDListW(
  pidl: Pointer;   // ITEMIDLIST*
  pszPath: PWideChar   // LPWSTR out
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetPathFromIDListW';
result := DllCall("SHELL32\SHGetPathFromIDListW"
    , "Ptr", pidl   ; ITEMIDLIST*
    , "Ptr", pszPath   ; LPWSTR out
    , "Int")   ; return: BOOL
●SHGetPathFromIDListW(pidl, pszPath) = DLL("SHELL32.dll", "bool SHGetPathFromIDListW(void*, char*)")
# 呼び出し: SHGetPathFromIDListW(pidl, pszPath)
# pidl : ITEMIDLIST* -> "void*"
# 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 SHGetPathFromIDListW(
    pidl: [*c]ITEMIDLIST, // ITEMIDLIST*
    pszPath: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHGetPathFromIDListW(
    pidl: ptr ITEMIDLIST,  # ITEMIDLIST*
    pszPath: ptr uint16  # LPWSTR out
): int32 {.importc: "SHGetPathFromIDListW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shell32");
extern(Windows)
int SHGetPathFromIDListW(
    ITEMIDLIST* pidl,   // ITEMIDLIST*
    wchar* pszPath   // LPWSTR out
);
ccall((:SHGetPathFromIDListW, "SHELL32.dll"), stdcall, Int32,
      (Ptr{ITEMIDLIST}, Ptr{UInt16}),
      pidl, pszPath)
# pidl : ITEMIDLIST* -> Ptr{ITEMIDLIST}
# pszPath : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetPathFromIDListW(
    void* pidl,
    uint16_t* pszPath);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetPathFromIDListW(pidl, pszPath)
-- pidl : ITEMIDLIST*
-- 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 SHGetPathFromIDListW = lib.func('__stdcall', 'SHGetPathFromIDListW', 'int32_t', ['void *', 'uint16_t *']);
// SHGetPathFromIDListW(pidl, pszPath)
// pidl : ITEMIDLIST* -> 'void *'
// pszPath : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHGetPathFromIDListW: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.SHGetPathFromIDListW(pidl, pszPath)
// pidl : ITEMIDLIST* -> "pointer"
// pszPath : LPWSTR out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetPathFromIDListW(
    void* pidl,
    uint16_t* pszPath);
C, "SHELL32.dll");
// $ffi->SHGetPathFromIDListW(pidl, pszPath);
// pidl : ITEMIDLIST*
// 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);
    boolean SHGetPathFromIDListW(
        Pointer pidl,   // ITEMIDLIST*
        char[] pszPath   // LPWSTR out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shell32")]
lib LibSHELL32
  fun SHGetPathFromIDListW = SHGetPathFromIDListW(
    pidl : ITEMIDLIST*,   # ITEMIDLIST*
    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 SHGetPathFromIDListWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>);
typedef SHGetPathFromIDListWDart = int Function(Pointer<Void>, Pointer<Utf16>);
final SHGetPathFromIDListW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetPathFromIDListWNative, SHGetPathFromIDListWDart>('SHGetPathFromIDListW');
// pidl : ITEMIDLIST* -> Pointer<Void>
// pszPath : LPWSTR out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetPathFromIDListW(
  pidl: Pointer;   // ITEMIDLIST*
  pszPath: PWideChar   // LPWSTR out
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetPathFromIDListW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shgetpathfromidlistw =
  foreign "SHGetPathFromIDListW"
    ((ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* pidl : ITEMIDLIST* -> (ptr void) *)
(* 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 ("SHGetPathFromIDListW" shget-path-from-idlist-w :convention :stdcall) :int32
  (pidl :pointer)   ; ITEMIDLIST*
  (psz-path :pointer))   ; LPWSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetPathFromIDListW = Win32::API::More->new('SHELL32',
    'BOOL SHGetPathFromIDListW(LPVOID pidl, LPWSTR pszPath)');
# my $ret = $SHGetPathFromIDListW->Call($pidl, $pszPath);
# pidl : ITEMIDLIST* -> LPVOID
# pszPath : LPWSTR out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型