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

StgPropertyLengthAsVariant

関数
シリアル化プロパティをPROPVARIANTにした場合のサイズを算出する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD StgPropertyLengthAsVariant(
    const SERIALIZEDPROPERTYVALUE* pProp,
    DWORD cbProp,
    WORD CodePage,
    BYTE bReserved   // optional
);

パラメーター

名前方向説明
pPropSERIALIZEDPROPERTYVALUE*in対象のシリアライズ済みプロパティ値SERIALIZEDPROPERTYVALUEへのポインタ。
cbPropDWORDinpPropが指すプロパティデータの利用可能バイト数。
CodePageWORDin文字列の解釈に用いるコードページ。
bReservedBYTEoptional予約パラメータ。0を指定する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD StgPropertyLengthAsVariant(
    const SERIALIZEDPROPERTYVALUE* pProp,
    DWORD cbProp,
    WORD CodePage,
    BYTE bReserved   // optional
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern uint StgPropertyLengthAsVariant(
    IntPtr pProp,   // SERIALIZEDPROPERTYVALUE*
    uint cbProp,   // DWORD
    ushort CodePage,   // WORD
    byte bReserved   // BYTE optional
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function StgPropertyLengthAsVariant(
    pProp As IntPtr,   ' SERIALIZEDPROPERTYVALUE*
    cbProp As UInteger,   ' DWORD
    CodePage As UShort,   ' WORD
    bReserved As Byte   ' BYTE optional
) As UInteger
End Function
' pProp : SERIALIZEDPROPERTYVALUE*
' cbProp : DWORD
' CodePage : WORD
' bReserved : BYTE optional
Declare PtrSafe Function StgPropertyLengthAsVariant Lib "ole32" ( _
    ByVal pProp As LongPtr, _
    ByVal cbProp As Long, _
    ByVal CodePage As Integer, _
    ByVal bReserved As Byte) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StgPropertyLengthAsVariant = ctypes.windll.ole32.StgPropertyLengthAsVariant
StgPropertyLengthAsVariant.restype = wintypes.DWORD
StgPropertyLengthAsVariant.argtypes = [
    ctypes.c_void_p,  # pProp : SERIALIZEDPROPERTYVALUE*
    wintypes.DWORD,  # cbProp : DWORD
    ctypes.c_ushort,  # CodePage : WORD
    ctypes.c_ubyte,  # bReserved : BYTE optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procStgPropertyLengthAsVariant = ole32.NewProc("StgPropertyLengthAsVariant")
)

// pProp (SERIALIZEDPROPERTYVALUE*), cbProp (DWORD), CodePage (WORD), bReserved (BYTE optional)
r1, _, err := procStgPropertyLengthAsVariant.Call(
	uintptr(pProp),
	uintptr(cbProp),
	uintptr(CodePage),
	uintptr(bReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function StgPropertyLengthAsVariant(
  pProp: Pointer;   // SERIALIZEDPROPERTYVALUE*
  cbProp: DWORD;   // DWORD
  CodePage: Word;   // WORD
  bReserved: Byte   // BYTE optional
): DWORD; stdcall;
  external 'OLE32.dll' name 'StgPropertyLengthAsVariant';
result := DllCall("OLE32\StgPropertyLengthAsVariant"
    , "Ptr", pProp   ; SERIALIZEDPROPERTYVALUE*
    , "UInt", cbProp   ; DWORD
    , "UShort", CodePage   ; WORD
    , "UChar", bReserved   ; BYTE optional
    , "UInt")   ; return: DWORD
●StgPropertyLengthAsVariant(pProp, cbProp, CodePage, bReserved) = DLL("OLE32.dll", "dword StgPropertyLengthAsVariant(void*, dword, int, byte)")
# 呼び出し: StgPropertyLengthAsVariant(pProp, cbProp, CodePage, bReserved)
# pProp : SERIALIZEDPROPERTYVALUE* -> "void*"
# cbProp : DWORD -> "dword"
# CodePage : WORD -> "int"
# bReserved : BYTE optional -> "byte"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef StgPropertyLengthAsVariantNative = Uint32 Function(Pointer<Void>, Uint32, Uint16, Uint8);
typedef StgPropertyLengthAsVariantDart = int Function(Pointer<Void>, int, int, int);
final StgPropertyLengthAsVariant = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<StgPropertyLengthAsVariantNative, StgPropertyLengthAsVariantDart>('StgPropertyLengthAsVariant');
// pProp : SERIALIZEDPROPERTYVALUE* -> Pointer<Void>
// cbProp : DWORD -> Uint32
// CodePage : WORD -> Uint16
// bReserved : BYTE optional -> Uint8
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StgPropertyLengthAsVariant(
  pProp: Pointer;   // SERIALIZEDPROPERTYVALUE*
  cbProp: DWORD;   // DWORD
  CodePage: Word;   // WORD
  bReserved: Byte   // BYTE optional
): DWORD; stdcall;
  external 'OLE32.dll' name 'StgPropertyLengthAsVariant';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StgPropertyLengthAsVariant"
  c_StgPropertyLengthAsVariant :: Ptr () -> Word32 -> Word16 -> Word8 -> IO Word32
-- pProp : SERIALIZEDPROPERTYVALUE* -> Ptr ()
-- cbProp : DWORD -> Word32
-- CodePage : WORD -> Word16
-- bReserved : BYTE optional -> Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let stgpropertylengthasvariant =
  foreign "StgPropertyLengthAsVariant"
    ((ptr void) @-> uint32_t @-> uint16_t @-> uint8_t @-> returning uint32_t)
(* pProp : SERIALIZEDPROPERTYVALUE* -> (ptr void) *)
(* cbProp : DWORD -> uint32_t *)
(* CodePage : WORD -> uint16_t *)
(* bReserved : BYTE optional -> uint8_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("StgPropertyLengthAsVariant" stg-property-length-as-variant :convention :stdcall) :uint32
  (p-prop :pointer)   ; SERIALIZEDPROPERTYVALUE*
  (cb-prop :uint32)   ; DWORD
  (code-page :uint16)   ; WORD
  (b-reserved :uint8))   ; BYTE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StgPropertyLengthAsVariant = Win32::API::More->new('OLE32',
    'DWORD StgPropertyLengthAsVariant(LPVOID pProp, DWORD cbProp, WORD CodePage, BYTE bReserved)');
# my $ret = $StgPropertyLengthAsVariant->Call($pProp, $cbProp, $CodePage, $bReserved);
# pProp : SERIALIZEDPROPERTYVALUE* -> LPVOID
# cbProp : DWORD -> DWORD
# CodePage : WORD -> WORD
# bReserved : BYTE optional -> BYTE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型