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

SHPropStgReadMultiple

関数
プロパティ記憶域から複数の値を読み取る。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHPropStgReadMultiple(
    IPropertyStorage* pps,
    DWORD uCodePage,
    DWORD cpspec,
    const PROPSPEC* rgpspec,
    PROPVARIANT* rgvar
);

パラメーター

名前方向説明
ppsIPropertyStorage*in読み取り元のIPropertyStorageインターフェイス。
uCodePageDWORDin文字列プロパティの解釈に使うコードページ番号。
cpspecDWORDin読み取るプロパティの個数。rgpspecとrgvarの要素数を示す。
rgpspecPROPSPEC*in読み取るプロパティを指定するPROPSPEC配列へのポインタ。
rgvarPROPVARIANT*out読み取った値を受け取るPROPVARIANT配列へのポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SHPropStgReadMultiple(
    IPropertyStorage* pps,
    DWORD uCodePage,
    DWORD cpspec,
    const PROPSPEC* rgpspec,
    PROPVARIANT* rgvar
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHPropStgReadMultiple(
    IntPtr pps,   // IPropertyStorage*
    uint uCodePage,   // DWORD
    uint cpspec,   // DWORD
    IntPtr rgpspec,   // PROPSPEC*
    IntPtr rgvar   // PROPVARIANT* out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHPropStgReadMultiple(
    pps As IntPtr,   ' IPropertyStorage*
    uCodePage As UInteger,   ' DWORD
    cpspec As UInteger,   ' DWORD
    rgpspec As IntPtr,   ' PROPSPEC*
    rgvar As IntPtr   ' PROPVARIANT* out
) As Integer
End Function
' pps : IPropertyStorage*
' uCodePage : DWORD
' cpspec : DWORD
' rgpspec : PROPSPEC*
' rgvar : PROPVARIANT* out
Declare PtrSafe Function SHPropStgReadMultiple Lib "shell32" ( _
    ByVal pps As LongPtr, _
    ByVal uCodePage As Long, _
    ByVal cpspec As Long, _
    ByVal rgpspec As LongPtr, _
    ByVal rgvar As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHPropStgReadMultiple = ctypes.windll.shell32.SHPropStgReadMultiple
SHPropStgReadMultiple.restype = ctypes.c_int
SHPropStgReadMultiple.argtypes = [
    ctypes.c_void_p,  # pps : IPropertyStorage*
    wintypes.DWORD,  # uCodePage : DWORD
    wintypes.DWORD,  # cpspec : DWORD
    ctypes.c_void_p,  # rgpspec : PROPSPEC*
    ctypes.c_void_p,  # rgvar : PROPVARIANT* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHPropStgReadMultiple = shell32.NewProc("SHPropStgReadMultiple")
)

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

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

typedef SHPropStgReadMultipleNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>, Pointer<Void>);
typedef SHPropStgReadMultipleDart = int Function(Pointer<Void>, int, int, Pointer<Void>, Pointer<Void>);
final SHPropStgReadMultiple = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHPropStgReadMultipleNative, SHPropStgReadMultipleDart>('SHPropStgReadMultiple');
// pps : IPropertyStorage* -> Pointer<Void>
// uCodePage : DWORD -> Uint32
// cpspec : DWORD -> Uint32
// rgpspec : PROPSPEC* -> Pointer<Void>
// rgvar : PROPVARIANT* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHPropStgReadMultiple(
  pps: Pointer;   // IPropertyStorage*
  uCodePage: DWORD;   // DWORD
  cpspec: DWORD;   // DWORD
  rgpspec: Pointer;   // PROPSPEC*
  rgvar: Pointer   // PROPVARIANT* out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHPropStgReadMultiple';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHPropStgReadMultiple"
  c_SHPropStgReadMultiple :: Ptr () -> Word32 -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- pps : IPropertyStorage* -> Ptr ()
-- uCodePage : DWORD -> Word32
-- cpspec : DWORD -> Word32
-- rgpspec : PROPSPEC* -> Ptr ()
-- rgvar : PROPVARIANT* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shpropstgreadmultiple =
  foreign "SHPropStgReadMultiple"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pps : IPropertyStorage* -> (ptr void) *)
(* uCodePage : DWORD -> uint32_t *)
(* cpspec : DWORD -> uint32_t *)
(* rgpspec : PROPSPEC* -> (ptr void) *)
(* rgvar : PROPVARIANT* 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 ("SHPropStgReadMultiple" shprop-stg-read-multiple :convention :stdcall) :int32
  (pps :pointer)   ; IPropertyStorage*
  (u-code-page :uint32)   ; DWORD
  (cpspec :uint32)   ; DWORD
  (rgpspec :pointer)   ; PROPSPEC*
  (rgvar :pointer))   ; PROPVARIANT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHPropStgReadMultiple = Win32::API::More->new('SHELL32',
    'int SHPropStgReadMultiple(LPVOID pps, DWORD uCodePage, DWORD cpspec, LPVOID rgpspec, LPVOID rgvar)');
# my $ret = $SHPropStgReadMultiple->Call($pps, $uCodePage, $cpspec, $rgpspec, $rgvar);
# pps : IPropertyStorage* -> LPVOID
# uCodePage : DWORD -> DWORD
# cpspec : DWORD -> DWORD
# rgpspec : PROPSPEC* -> LPVOID
# rgvar : PROPVARIANT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型