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

IStream_ReadPidl

関数
ストリームからアイテムIDリスト(PIDL)を読み取る。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT IStream_ReadPidl(
    IStream* pstm,
    ITEMIDLIST** ppidlOut
);

パラメーター

名前方向説明
pstmIStream*inPIDL の読み込み元となる IStream へのポインター。
ppidlOutITEMIDLIST**out結果として得られる PIDL へのポインター。

戻り値の型: HRESULT

公式ドキュメント

IStream オブジェクトから項目識別子リスト (PIDL) へのポインターを PIDLIST_RELATIVE オブジェクトに読み込みます。

戻り値

Type: HRESULT

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

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

各言語での呼び出し定義

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

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

IStream_ReadPidl = ctypes.windll.shlwapi.IStream_ReadPidl
IStream_ReadPidl.restype = ctypes.c_int
IStream_ReadPidl.argtypes = [
    ctypes.c_void_p,  # pstm : IStream*
    ctypes.c_void_p,  # ppidlOut : ITEMIDLIST** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procIStream_ReadPidl = shlwapi.NewProc("IStream_ReadPidl")
)

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

extern "shlwapi" fn IStream_ReadPidl(
    pstm: ?*anyopaque, // IStream*
    ppidlOut: [*c][*c]ITEMIDLIST // ITEMIDLIST** out
) callconv(std.os.windows.WINAPI) i32;
proc IStream_ReadPidl(
    pstm: pointer,  # IStream*
    ppidlOut: ptr ITEMIDLIST  # ITEMIDLIST** out
): int32 {.importc: "IStream_ReadPidl", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int IStream_ReadPidl(
    void* pstm,   // IStream*
    ITEMIDLIST** ppidlOut   // ITEMIDLIST** out
);
ccall((:IStream_ReadPidl, "SHLWAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{ITEMIDLIST}),
      pstm, ppidlOut)
# pstm : IStream* -> Ptr{Cvoid}
# ppidlOut : ITEMIDLIST** out -> Ptr{ITEMIDLIST}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t IStream_ReadPidl(
    void* pstm,
    void* ppidlOut);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.IStream_ReadPidl(pstm, ppidlOut)
-- pstm : IStream*
-- ppidlOut : ITEMIDLIST** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const IStream_ReadPidl = lib.func('__stdcall', 'IStream_ReadPidl', 'int32_t', ['void *', 'void *']);
// IStream_ReadPidl(pstm, ppidlOut)
// pstm : IStream* -> 'void *'
// ppidlOut : ITEMIDLIST** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  IStream_ReadPidl: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.IStream_ReadPidl(pstm, ppidlOut)
// pstm : IStream* -> "pointer"
// ppidlOut : ITEMIDLIST** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t IStream_ReadPidl(
    void* pstm,
    void* ppidlOut);
C, "SHLWAPI.dll");
// $ffi->IStream_ReadPidl(pstm, ppidlOut);
// pstm : IStream*
// ppidlOut : 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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class);
    int IStream_ReadPidl(
        Pointer pstm,   // IStream*
        Pointer ppidlOut   // ITEMIDLIST** out
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun IStream_ReadPidl = IStream_ReadPidl(
    pstm : Void*,   # IStream*
    ppidlOut : 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 IStream_ReadPidlNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef IStream_ReadPidlDart = int Function(Pointer<Void>, Pointer<Void>);
final IStream_ReadPidl = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<IStream_ReadPidlNative, IStream_ReadPidlDart>('IStream_ReadPidl');
// pstm : IStream* -> Pointer<Void>
// ppidlOut : ITEMIDLIST** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IStream_ReadPidl(
  pstm: Pointer;   // IStream*
  ppidlOut: Pointer   // ITEMIDLIST** out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'IStream_ReadPidl';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let istream_readpidl =
  foreign "IStream_ReadPidl"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* pstm : IStream* -> (ptr void) *)
(* ppidlOut : ITEMIDLIST** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

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

関連項目

使用する型