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

SHGetPathFromIDListA

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

シグネチャ

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

BOOL SHGetPathFromIDListA(
    ITEMIDLIST* pidl,
    LPSTR pszPath
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

解説(Remarks)

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

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

メモ

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

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

各言語での呼び出し定義

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

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

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

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetPathFromIDListA = shell32.NewProc("SHGetPathFromIDListA")
)

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

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

typedef SHGetPathFromIDListANative = Int32 Function(Pointer<Void>, Pointer<Utf8>);
typedef SHGetPathFromIDListADart = int Function(Pointer<Void>, Pointer<Utf8>);
final SHGetPathFromIDListA = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetPathFromIDListANative, SHGetPathFromIDListADart>('SHGetPathFromIDListA');
// pidl : ITEMIDLIST* -> Pointer<Void>
// pszPath : LPSTR out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetPathFromIDListA(
  pidl: Pointer;   // ITEMIDLIST*
  pszPath: PAnsiChar   // LPSTR out
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetPathFromIDListA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shgetpathfromidlista =
  foreign "SHGetPathFromIDListA"
    ((ptr void) @-> string @-> returning int32_t)
(* pidl : ITEMIDLIST* -> (ptr void) *)
(* pszPath : LPSTR out -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

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

関連項目

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