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

SHGetDataFromIDListA

関数
PIDLからファイル情報(ANSI)を取り出す。
DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHGetDataFromIDListA(
    IShellFolder* psf,
    ITEMIDLIST* pidl,
    SHGDFIL_FORMAT nFormat,
    void* pv,
    INT cb
);

パラメーター

名前方向説明
psfIShellFolder*in親となる IShellFolder インターフェイスのアドレスです。これは pidl パラメーターが参照する ITEMIDLIST 構造体の直接の親である必要があります。
pidlITEMIDLIST*inpsf で指定したフォルダーを基準としてオブジェクトを識別する ITEMIDLIST 構造体へのポインターです。
nFormatSHGDFIL_FORMATin

データを要求する形式です。このパラメーターには次のいずれかの値を設定する必要があります。

SHGDFIL_FINDDATA

ファイルシステムオブジェクトに使用する形式です。pv パラメーターは WIN32_FIND_DATA 構造体のアドレスです。

SHGDFIL_NETRESOURCE

ネットワークリソースに使用する形式です。pv パラメーターは NETRESOURCE 構造体のアドレスです。

SHGDFIL_DESCRIPTIONID

バージョン 4.71。ネットワークリソースに使用する形式です。pv パラメーターは SHDESCRIPTIONID 構造体のアドレスです。

pvvoid*out

この関数が正常に返ったときに、要求されたデータを受け取るバッファーへのポインターです。このバッファーの形式は nFormat によって決まります。

nFormatSHGDFIL_NETRESOURCE の場合、2 通りのケースがあります。バッファーが十分大きい場合は、ネットワークリソースの文字列情報(ネットワーク名、ローカル名、プロバイダー、コメントの各フィールド)がバッファーに格納されます。バッファーが十分大きくない場合は、ネットワークリソース構造体のみがバッファーに格納され、文字列情報のポインターは NULL になります。

cbINTinpv にあるバッファーのサイズ(バイト単位)です。

戻り値の型: HRESULT

公式ドキュメント

相対的な識別子リストから拡張プロパティデータを取得します。(ANSI)

戻り値

型: HRESULT

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

解説(Remarks)

この関数は、アイテム識別子リスト(PIDL)へのポインターに含まれている情報のみを抽出します。PIDL の内容は、その PIDL を作成したフォルダーオブジェクトに依存するため、要求したすべての情報が利用できるとは限りません。また、返される情報は PIDL が作成された時点でのオブジェクトの状態を反映しています。オブジェクトの現在の状態は異なる場合があります。たとえば、nFormatSHGDFIL_FINDDATA を設定した場合、この関数は WIN32_FIND_DATA 構造体の一部のメンバーにのみ意味のある値を割り当てることがあります。残りのメンバーはゼロに設定されます。ファイルシステム上のファイルやフォルダーの完全な現在の情報を取得するには、GetFileTimeFindFirstFile などの標準的なファイルシステム関数を使用してください。

psfpidlpv、または cb パラメーターが nFormat パラメーターと一致しない場合、または nFormat が上記の特定の SHGDFIL_ 値のいずれでもない場合は、E_INVALIDARG が返されます。

メモ

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

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

HRESULT SHGetDataFromIDListA(
    IShellFolder* psf,
    ITEMIDLIST* pidl,
    SHGDFIL_FORMAT nFormat,
    void* pv,
    INT cb
);
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHGetDataFromIDListA(
    IntPtr psf,   // IShellFolder*
    IntPtr pidl,   // ITEMIDLIST*
    int nFormat,   // SHGDFIL_FORMAT
    IntPtr pv,   // void* out
    int cb   // INT
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHGetDataFromIDListA(
    psf As IntPtr,   ' IShellFolder*
    pidl As IntPtr,   ' ITEMIDLIST*
    nFormat As Integer,   ' SHGDFIL_FORMAT
    pv As IntPtr,   ' void* out
    cb As Integer   ' INT
) As Integer
End Function
' psf : IShellFolder*
' pidl : ITEMIDLIST*
' nFormat : SHGDFIL_FORMAT
' pv : void* out
' cb : INT
Declare PtrSafe Function SHGetDataFromIDListA Lib "shell32" ( _
    ByVal psf As LongPtr, _
    ByVal pidl As LongPtr, _
    ByVal nFormat As Long, _
    ByVal pv As LongPtr, _
    ByVal cb As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetDataFromIDListA = ctypes.windll.shell32.SHGetDataFromIDListA
SHGetDataFromIDListA.restype = ctypes.c_int
SHGetDataFromIDListA.argtypes = [
    ctypes.c_void_p,  # psf : IShellFolder*
    ctypes.c_void_p,  # pidl : ITEMIDLIST*
    ctypes.c_int,  # nFormat : SHGDFIL_FORMAT
    ctypes.POINTER(None),  # pv : void* out
    ctypes.c_int,  # cb : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetDataFromIDListA = Fiddle::Function.new(
  lib['SHGetDataFromIDListA'],
  [
    Fiddle::TYPE_VOIDP,  # psf : IShellFolder*
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST*
    Fiddle::TYPE_INT,  # nFormat : SHGDFIL_FORMAT
    Fiddle::TYPE_VOIDP,  # pv : void* out
    Fiddle::TYPE_INT,  # cb : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHGetDataFromIDListA(
        psf: *mut core::ffi::c_void,  // IShellFolder*
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST*
        nFormat: i32,  // SHGDFIL_FORMAT
        pv: *mut (),  // void* out
        cb: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern int SHGetDataFromIDListA(IntPtr psf, IntPtr pidl, int nFormat, IntPtr pv, int cb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetDataFromIDListA' -Namespace Win32 -PassThru
# $api::SHGetDataFromIDListA(psf, pidl, nFormat, pv, cb)
#uselib "SHELL32.dll"
#func global SHGetDataFromIDListA "SHGetDataFromIDListA" sptr, sptr, sptr, sptr, sptr
; SHGetDataFromIDListA psf, varptr(pidl), nFormat, pv, cb   ; 戻り値は stat
; psf : IShellFolder* -> "sptr"
; pidl : ITEMIDLIST* -> "sptr"
; nFormat : SHGDFIL_FORMAT -> "sptr"
; pv : void* out -> "sptr"
; cb : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHGetDataFromIDListA "SHGetDataFromIDListA" sptr, var, int, sptr, int
; res = SHGetDataFromIDListA(psf, pidl, nFormat, pv, cb)
; psf : IShellFolder* -> "sptr"
; pidl : ITEMIDLIST* -> "var"
; nFormat : SHGDFIL_FORMAT -> "int"
; pv : void* out -> "sptr"
; cb : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHGetDataFromIDListA(IShellFolder* psf, ITEMIDLIST* pidl, SHGDFIL_FORMAT nFormat, void* pv, INT cb)
#uselib "SHELL32.dll"
#cfunc global SHGetDataFromIDListA "SHGetDataFromIDListA" intptr, var, int, intptr, int
; res = SHGetDataFromIDListA(psf, pidl, nFormat, pv, cb)
; psf : IShellFolder* -> "intptr"
; pidl : ITEMIDLIST* -> "var"
; nFormat : SHGDFIL_FORMAT -> "int"
; pv : void* out -> "intptr"
; cb : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetDataFromIDListA = shell32.NewProc("SHGetDataFromIDListA")
)

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

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

typedef SHGetDataFromIDListANative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32, Pointer<Void>, Int32);
typedef SHGetDataFromIDListADart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, int);
final SHGetDataFromIDListA = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetDataFromIDListANative, SHGetDataFromIDListADart>('SHGetDataFromIDListA');
// psf : IShellFolder* -> Pointer<Void>
// pidl : ITEMIDLIST* -> Pointer<Void>
// nFormat : SHGDFIL_FORMAT -> Int32
// pv : void* out -> Pointer<Void>
// cb : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetDataFromIDListA(
  psf: Pointer;   // IShellFolder*
  pidl: Pointer;   // ITEMIDLIST*
  nFormat: Integer;   // SHGDFIL_FORMAT
  pv: Pointer;   // void* out
  cb: Integer   // INT
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetDataFromIDListA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetDataFromIDListA"
  c_SHGetDataFromIDListA :: Ptr () -> Ptr () -> Int32 -> Ptr () -> Int32 -> IO Int32
-- psf : IShellFolder* -> Ptr ()
-- pidl : ITEMIDLIST* -> Ptr ()
-- nFormat : SHGDFIL_FORMAT -> Int32
-- pv : void* out -> Ptr ()
-- cb : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shgetdatafromidlista =
  foreign "SHGetDataFromIDListA"
    ((ptr void) @-> (ptr void) @-> int32_t @-> (ptr void) @-> int32_t @-> returning int32_t)
(* psf : IShellFolder* -> (ptr void) *)
(* pidl : ITEMIDLIST* -> (ptr void) *)
(* nFormat : SHGDFIL_FORMAT -> int32_t *)
(* pv : void* out -> (ptr void) *)
(* cb : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHGetDataFromIDListA" shget-data-from-idlist-a :convention :stdcall) :int32
  (psf :pointer)   ; IShellFolder*
  (pidl :pointer)   ; ITEMIDLIST*
  (n-format :int32)   ; SHGDFIL_FORMAT
  (pv :pointer)   ; void* out
  (cb :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetDataFromIDListA = Win32::API::More->new('SHELL32',
    'int SHGetDataFromIDListA(LPVOID psf, LPVOID pidl, int nFormat, LPVOID pv, int cb)');
# my $ret = $SHGetDataFromIDListA->Call($psf, $pidl, $nFormat, $pv, $cb);
# psf : IShellFolder* -> LPVOID
# pidl : ITEMIDLIST* -> LPVOID
# nFormat : SHGDFIL_FORMAT -> int
# pv : void* out -> LPVOID
# cb : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型