Win32 API 日本語リファレンス
ホームSystem.Com.StructuredStorage › StgSerializePropVariant

StgSerializePropVariant

関数
PROPVARIANTをシリアル化されたプロパティ値のバイト列へ変換する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT StgSerializePropVariant(
    const PROPVARIANT* ppropvar,
    SERIALIZEDPROPERTYVALUE** ppProp,
    DWORD* pcb
);

パラメーター

名前方向説明
ppropvarPROPVARIANT*inシリアライズ対象のPROPVARIANTへのポインタ。入力値を保持する。
ppPropSERIALIZEDPROPERTYVALUE**outシリアライズ結果のバイト列を受け取る出力ポインタ。CoTaskMemFreeで解放する。
pcbDWORD*outシリアライズ結果のバイトサイズを受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT StgSerializePropVariant(
    const PROPVARIANT* ppropvar,
    SERIALIZEDPROPERTYVALUE** ppProp,
    DWORD* pcb
);
[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int StgSerializePropVariant(
    IntPtr ppropvar,   // PROPVARIANT*
    IntPtr ppProp,   // SERIALIZEDPROPERTYVALUE** out
    out uint pcb   // DWORD* out
);
<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function StgSerializePropVariant(
    ppropvar As IntPtr,   ' PROPVARIANT*
    ppProp As IntPtr,   ' SERIALIZEDPROPERTYVALUE** out
    <Out> ByRef pcb As UInteger   ' DWORD* out
) As Integer
End Function
' ppropvar : PROPVARIANT*
' ppProp : SERIALIZEDPROPERTYVALUE** out
' pcb : DWORD* out
Declare PtrSafe Function StgSerializePropVariant Lib "propsys" ( _
    ByVal ppropvar As LongPtr, _
    ByVal ppProp As LongPtr, _
    ByRef pcb As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StgSerializePropVariant = ctypes.windll.propsys.StgSerializePropVariant
StgSerializePropVariant.restype = ctypes.c_int
StgSerializePropVariant.argtypes = [
    ctypes.c_void_p,  # ppropvar : PROPVARIANT*
    ctypes.c_void_p,  # ppProp : SERIALIZEDPROPERTYVALUE** out
    ctypes.POINTER(wintypes.DWORD),  # pcb : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procStgSerializePropVariant = propsys.NewProc("StgSerializePropVariant")
)

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

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

typedef StgSerializePropVariantNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef StgSerializePropVariantDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final StgSerializePropVariant = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<StgSerializePropVariantNative, StgSerializePropVariantDart>('StgSerializePropVariant');
// ppropvar : PROPVARIANT* -> Pointer<Void>
// ppProp : SERIALIZEDPROPERTYVALUE** out -> Pointer<Void>
// pcb : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StgSerializePropVariant(
  ppropvar: Pointer;   // PROPVARIANT*
  ppProp: Pointer;   // SERIALIZEDPROPERTYVALUE** out
  pcb: Pointer   // DWORD* out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'StgSerializePropVariant';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StgSerializePropVariant"
  c_StgSerializePropVariant :: Ptr () -> Ptr () -> Ptr Word32 -> IO Int32
-- ppropvar : PROPVARIANT* -> Ptr ()
-- ppProp : SERIALIZEDPROPERTYVALUE** out -> Ptr ()
-- pcb : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let stgserializepropvariant =
  foreign "StgSerializePropVariant"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* ppropvar : PROPVARIANT* -> (ptr void) *)
(* ppProp : SERIALIZEDPROPERTYVALUE** out -> (ptr void) *)
(* pcb : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("StgSerializePropVariant" stg-serialize-prop-variant :convention :stdcall) :int32
  (ppropvar :pointer)   ; PROPVARIANT*
  (pp-prop :pointer)   ; SERIALIZEDPROPERTYVALUE** out
  (pcb :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StgSerializePropVariant = Win32::API::More->new('PROPSYS',
    'int StgSerializePropVariant(LPVOID ppropvar, LPVOID ppProp, LPVOID pcb)');
# my $ret = $StgSerializePropVariant->Call($ppropvar, $ppProp, $pcb);
# ppropvar : PROPVARIANT* -> LPVOID
# ppProp : SERIALIZEDPROPERTYVALUE** out -> LPVOID
# pcb : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型