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

SHGetIDListFromObject

関数
オブジェクトからアイテムIDリストを取得する。
DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

HRESULT SHGetIDListFromObject(
    IUnknown* punk,
    ITEMIDLIST** ppidl
);

パラメーター

名前方向説明
punkIUnknown*inPIDL を取得する対象オブジェクトの IUnknown へのポインター。
ppidlITEMIDLIST**outこの関数が戻るとき、指定されたオブジェクトの PIDL へのポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

オブジェクトの項目識別子リスト (PIDL) へのポインターを取得します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

HRESULT SHGetIDListFromObject(
    IUnknown* punk,
    ITEMIDLIST** ppidl
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetIDListFromObject(
    IntPtr punk,   // IUnknown*
    IntPtr ppidl   // ITEMIDLIST** out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetIDListFromObject(
    punk As IntPtr,   ' IUnknown*
    ppidl As IntPtr   ' ITEMIDLIST** out
) As Integer
End Function
' punk : IUnknown*
' ppidl : ITEMIDLIST** out
Declare PtrSafe Function SHGetIDListFromObject Lib "shell32" ( _
    ByVal punk As LongPtr, _
    ByVal ppidl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetIDListFromObject = ctypes.windll.shell32.SHGetIDListFromObject
SHGetIDListFromObject.restype = ctypes.c_int
SHGetIDListFromObject.argtypes = [
    ctypes.c_void_p,  # punk : IUnknown*
    ctypes.c_void_p,  # ppidl : ITEMIDLIST** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetIDListFromObject = shell32.NewProc("SHGetIDListFromObject")
)

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

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

typedef SHGetIDListFromObjectNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef SHGetIDListFromObjectDart = int Function(Pointer<Void>, Pointer<Void>);
final SHGetIDListFromObject = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetIDListFromObjectNative, SHGetIDListFromObjectDart>('SHGetIDListFromObject');
// punk : IUnknown* -> Pointer<Void>
// ppidl : ITEMIDLIST** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetIDListFromObject(
  punk: Pointer;   // IUnknown*
  ppidl: Pointer   // ITEMIDLIST** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetIDListFromObject';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetIDListFromObject"
  c_SHGetIDListFromObject :: Ptr () -> Ptr () -> IO Int32
-- punk : IUnknown* -> Ptr ()
-- ppidl : ITEMIDLIST** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

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