SHGetDataFromIDListW
関数シグネチャ
// SHELL32.dll (Unicode / -W)
#include <windows.h>
HRESULT SHGetDataFromIDListW(
IShellFolder* psf,
ITEMIDLIST* pidl,
SHGDFIL_FORMAT nFormat,
void* pv,
INT cb
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| psf | IShellFolder* | in | 親の IShellFolder インターフェイスのアドレスです。これは、pidl パラメーターが参照する ITEMIDLIST 構造体の直接の親である必要があります。 |
| pidl | ITEMIDLIST* | in | psf で指定したフォルダーを基準とするオブジェクトを識別する ITEMIDLIST 構造体へのポインターです。 |
| nFormat | SHGDFIL_FORMAT | in | データを要求する形式です。このパラメーターには、次のいずれかの値を設定する必要があります。 SHGDFIL_FINDDATAファイル システム オブジェクトに使用される形式です。pv パラメーターは WIN32_FIND_DATA 構造体のアドレスです。 SHGDFIL_NETRESOURCEネットワーク リソースに使用される形式です。pv パラメーターは NETRESOURCE 構造体のアドレスです。 SHGDFIL_DESCRIPTIONIDバージョン 4.71。ネットワーク リソースに使用される形式です。pv パラメーターは SHDESCRIPTIONID 構造体のアドレスです。 |
| pv | void* | out | この関数が正常に終了したときに、要求されたデータを受け取るバッファーへのポインターです。このバッファーの形式は nFormat によって決まります。 nFormat が SHGDFIL_NETRESOURCE の場合、2 通りの結果が考えられます。バッファーが十分に大きければ、ネットワーク リソースの文字列情報 (ネットワーク名、ローカル名、プロバイダー、コメントの各フィールド) がバッファーに格納されます。バッファーが十分でない場合は、ネットワーク リソース構造体のみがバッファーに格納され、文字列情報のポインターは NULL になります。 |
| cb | INT | in | pv のバッファーのサイズ (バイト単位) です。 |
戻り値の型: HRESULT
公式ドキュメント
相対識別子リストから拡張プロパティ データを取得します。(Unicode)
戻り値
型: HRESULT
成功した場合は S_OK を、それ以外の場合は E_INVALIDARG を返します。
解説(Remarks)
この関数は、アイテム識別子リスト (PIDL) へのポインターに含まれている情報のみを抽出します。PIDL の内容は、その PIDL を作成したフォルダー オブジェクトに依存するため、要求したすべての情報が利用可能であるとは限りません。さらに、返される情報は PIDL が作成された時点でのオブジェクトの状態を反映しています。オブジェクトの現在の状態は異なる場合があります。たとえば、nFormat に SHGDFIL_FINDDATA を設定した場合、この関数は WIN32_FIND_DATA 構造体の一部のメンバーにのみ意味のある値を割り当てることがあります。残りのメンバーは 0 に設定されます。ファイル システム上のファイルやフォルダーの完全な最新情報を取得するには、GetFileTime や FindFirstFile などの標準的なファイル システム関数を使用してください。
psf、pidl、pv、cb のいずれかのパラメーターが nFormat パラメーターと一致しない場合、または nFormat が上記に示した特定の SHGDFIL_ 値のいずれでもない場合は、E_INVALIDARG が返されます。
shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHGetDataFromIDList を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイル エラーや実行時エラーが発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll (Unicode / -W)
#include <windows.h>
HRESULT SHGetDataFromIDListW(
IShellFolder* psf,
ITEMIDLIST* pidl,
SHGDFIL_FORMAT nFormat,
void* pv,
INT cb
);[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHGetDataFromIDListW(
IntPtr psf, // IShellFolder*
IntPtr pidl, // ITEMIDLIST*
int nFormat, // SHGDFIL_FORMAT
IntPtr pv, // void* out
int cb // INT
);<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHGetDataFromIDListW(
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 SHGetDataFromIDListW Lib "shell32" ( _
ByVal psf As LongPtr, _
ByVal pidl As LongPtr, _
ByVal nFormat As Long, _
ByVal pv As LongPtr, _
ByVal cb As Long) 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
SHGetDataFromIDListW = ctypes.windll.shell32.SHGetDataFromIDListW
SHGetDataFromIDListW.restype = ctypes.c_int
SHGetDataFromIDListW.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')
SHGetDataFromIDListW = Fiddle::Function.new(
lib['SHGetDataFromIDListW'],
[
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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shell32")]
extern "system" {
fn SHGetDataFromIDListW(
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.Unicode)]
public static extern int SHGetDataFromIDListW(IntPtr psf, IntPtr pidl, int nFormat, IntPtr pv, int cb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetDataFromIDListW' -Namespace Win32 -PassThru
# $api::SHGetDataFromIDListW(psf, pidl, nFormat, pv, cb)#uselib "SHELL32.dll"
#func global SHGetDataFromIDListW "SHGetDataFromIDListW" wptr, wptr, wptr, wptr, wptr
; SHGetDataFromIDListW psf, varptr(pidl), nFormat, pv, cb ; 戻り値は stat
; psf : IShellFolder* -> "wptr"
; pidl : ITEMIDLIST* -> "wptr"
; nFormat : SHGDFIL_FORMAT -> "wptr"
; pv : void* out -> "wptr"
; cb : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHELL32.dll" #cfunc global SHGetDataFromIDListW "SHGetDataFromIDListW" sptr, var, int, sptr, int ; res = SHGetDataFromIDListW(psf, pidl, nFormat, pv, cb) ; psf : IShellFolder* -> "sptr" ; pidl : ITEMIDLIST* -> "var" ; nFormat : SHGDFIL_FORMAT -> "int" ; pv : void* out -> "sptr" ; cb : INT -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll" #cfunc global SHGetDataFromIDListW "SHGetDataFromIDListW" sptr, sptr, int, sptr, int ; res = SHGetDataFromIDListW(psf, varptr(pidl), nFormat, pv, cb) ; psf : IShellFolder* -> "sptr" ; pidl : ITEMIDLIST* -> "sptr" ; nFormat : SHGDFIL_FORMAT -> "int" ; pv : void* out -> "sptr" ; cb : INT -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; HRESULT SHGetDataFromIDListW(IShellFolder* psf, ITEMIDLIST* pidl, SHGDFIL_FORMAT nFormat, void* pv, INT cb) #uselib "SHELL32.dll" #cfunc global SHGetDataFromIDListW "SHGetDataFromIDListW" intptr, var, int, intptr, int ; res = SHGetDataFromIDListW(psf, pidl, nFormat, pv, cb) ; psf : IShellFolder* -> "intptr" ; pidl : ITEMIDLIST* -> "var" ; nFormat : SHGDFIL_FORMAT -> "int" ; pv : void* out -> "intptr" ; cb : INT -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT SHGetDataFromIDListW(IShellFolder* psf, ITEMIDLIST* pidl, SHGDFIL_FORMAT nFormat, void* pv, INT cb) #uselib "SHELL32.dll" #cfunc global SHGetDataFromIDListW "SHGetDataFromIDListW" intptr, intptr, int, intptr, int ; res = SHGetDataFromIDListW(psf, varptr(pidl), nFormat, pv, cb) ; psf : IShellFolder* -> "intptr" ; pidl : ITEMIDLIST* -> "intptr" ; nFormat : SHGDFIL_FORMAT -> "int" ; pv : void* out -> "intptr" ; cb : INT -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procSHGetDataFromIDListW = shell32.NewProc("SHGetDataFromIDListW")
)
// psf (IShellFolder*), pidl (ITEMIDLIST*), nFormat (SHGDFIL_FORMAT), pv (void* out), cb (INT)
r1, _, err := procSHGetDataFromIDListW.Call(
uintptr(psf),
uintptr(pidl),
uintptr(nFormat),
uintptr(pv),
uintptr(cb),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SHGetDataFromIDListW(
psf: Pointer; // IShellFolder*
pidl: Pointer; // ITEMIDLIST*
nFormat: Integer; // SHGDFIL_FORMAT
pv: Pointer; // void* out
cb: Integer // INT
): Integer; stdcall;
external 'SHELL32.dll' name 'SHGetDataFromIDListW';result := DllCall("SHELL32\SHGetDataFromIDListW"
, "Ptr", psf ; IShellFolder*
, "Ptr", pidl ; ITEMIDLIST*
, "Int", nFormat ; SHGDFIL_FORMAT
, "Ptr", pv ; void* out
, "Int", cb ; INT
, "Int") ; return: HRESULT●SHGetDataFromIDListW(psf, pidl, nFormat, pv, cb) = DLL("SHELL32.dll", "int SHGetDataFromIDListW(void*, void*, int, void*, int)")
# 呼び出し: SHGetDataFromIDListW(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)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shell32" fn SHGetDataFromIDListW(
psf: ?*anyopaque, // IShellFolder*
pidl: [*c]ITEMIDLIST, // ITEMIDLIST*
nFormat: i32, // SHGDFIL_FORMAT
pv: ?*anyopaque, // void* out
cb: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHGetDataFromIDListW(
psf: pointer, # IShellFolder*
pidl: ptr ITEMIDLIST, # ITEMIDLIST*
nFormat: int32, # SHGDFIL_FORMAT
pv: pointer, # void* out
cb: int32 # INT
): int32 {.importc: "SHGetDataFromIDListW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shell32");
extern(Windows)
int SHGetDataFromIDListW(
void* psf, // IShellFolder*
ITEMIDLIST* pidl, // ITEMIDLIST*
int nFormat, // SHGDFIL_FORMAT
void* pv, // void* out
int cb // INT
);ccall((:SHGetDataFromIDListW, "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 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetDataFromIDListW(
void* psf,
void* pidl,
int32_t nFormat,
void* pv,
int32_t cb);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetDataFromIDListW(psf, pidl, nFormat, pv, cb)
-- psf : IShellFolder*
-- pidl : ITEMIDLIST*
-- nFormat : SHGDFIL_FORMAT
-- pv : void* out
-- cb : INT
-- 構造体/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 SHGetDataFromIDListW = lib.func('__stdcall', 'SHGetDataFromIDListW', 'int32_t', ['void *', 'void *', 'int32_t', 'void *', 'int32_t']);
// SHGetDataFromIDListW(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", {
SHGetDataFromIDListW: { parameters: ["pointer", "pointer", "i32", "pointer", "i32"], result: "i32" },
});
// lib.symbols.SHGetDataFromIDListW(psf, pidl, nFormat, pv, cb)
// psf : IShellFolder* -> "pointer"
// pidl : ITEMIDLIST* -> "pointer"
// nFormat : SHGDFIL_FORMAT -> "i32"
// pv : void* out -> "pointer"
// cb : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetDataFromIDListW(
void* psf,
void* pidl,
int32_t nFormat,
void* pv,
int32_t cb);
C, "SHELL32.dll");
// $ffi->SHGetDataFromIDListW(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.UNICODE_OPTIONS);
int SHGetDataFromIDListW(
Pointer psf, // IShellFolder*
Pointer pidl, // ITEMIDLIST*
int nFormat, // SHGDFIL_FORMAT
Pointer pv, // void* out
int cb // INT
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shell32")]
lib LibSHELL32
fun SHGetDataFromIDListW = SHGetDataFromIDListW(
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 SHGetDataFromIDListWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32, Pointer<Void>, Int32);
typedef SHGetDataFromIDListWDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, int);
final SHGetDataFromIDListW = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHGetDataFromIDListWNative, SHGetDataFromIDListWDart>('SHGetDataFromIDListW');
// 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 SHGetDataFromIDListW(
psf: Pointer; // IShellFolder*
pidl: Pointer; // ITEMIDLIST*
nFormat: Integer; // SHGDFIL_FORMAT
pv: Pointer; // void* out
cb: Integer // INT
): Integer; stdcall;
external 'SHELL32.dll' name 'SHGetDataFromIDListW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHGetDataFromIDListW"
c_SHGetDataFromIDListW :: 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 shgetdatafromidlistw =
foreign "SHGetDataFromIDListW"
((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 ("SHGetDataFromIDListW" shget-data-from-idlist-w :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 $SHGetDataFromIDListW = Win32::API::More->new('SHELL32',
'int SHGetDataFromIDListW(LPVOID psf, LPVOID pidl, int nFormat, LPVOID pv, int cb)');
# my $ret = $SHGetDataFromIDListW->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 を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f SHGetDataFromIDListA (ANSI版) — PIDLからファイル情報(ANSI)を取り出す。