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

BSTR_UserSize

関数
BSTRのマーシャリングに必要なバッファサイズを算出する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

DWORD BSTR_UserSize(
    DWORD* param0,
    DWORD param1,
    LPWSTR* param2
);

パラメーター

名前方向説明
param0DWORD*inMIDLが渡すフラグ(下位ワードがマーシャリングコンテキスト)へのポインター。
param1DWORDin現在のバッファオフセット(開始バイト位置)。
param2LPWSTR*inサイズ計算対象のBSTRへのポインター。マーシャリングに必要なバイト数を求める。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD BSTR_UserSize(
    DWORD* param0,
    DWORD param1,
    LPWSTR* param2
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern uint BSTR_UserSize(
    ref uint param0,   // DWORD*
    uint param1,   // DWORD
    IntPtr param2   // LPWSTR*
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function BSTR_UserSize(
    ByRef param0 As UInteger,   ' DWORD*
    param1 As UInteger,   ' DWORD
    param2 As IntPtr   ' LPWSTR*
) As UInteger
End Function
' param0 : DWORD*
' param1 : DWORD
' param2 : LPWSTR*
Declare PtrSafe Function BSTR_UserSize Lib "oleaut32" ( _
    ByRef param0 As Long, _
    ByVal param1 As Long, _
    ByVal param2 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BSTR_UserSize = ctypes.windll.oleaut32.BSTR_UserSize
BSTR_UserSize.restype = wintypes.DWORD
BSTR_UserSize.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # param0 : DWORD*
    wintypes.DWORD,  # param1 : DWORD
    ctypes.c_void_p,  # param2 : LPWSTR*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procBSTR_UserSize = oleaut32.NewProc("BSTR_UserSize")
)

// param0 (DWORD*), param1 (DWORD), param2 (LPWSTR*)
r1, _, err := procBSTR_UserSize.Call(
	uintptr(param0),
	uintptr(param1),
	uintptr(param2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function BSTR_UserSize(
  param0: Pointer;   // DWORD*
  param1: DWORD;   // DWORD
  param2: PPWideChar   // LPWSTR*
): DWORD; stdcall;
  external 'OLEAUT32.dll' name 'BSTR_UserSize';
result := DllCall("OLEAUT32\BSTR_UserSize"
    , "Ptr", param0   ; DWORD*
    , "UInt", param1   ; DWORD
    , "Ptr", param2   ; LPWSTR*
    , "UInt")   ; return: DWORD
●BSTR_UserSize(param0, param1, param2) = DLL("OLEAUT32.dll", "dword BSTR_UserSize(void*, dword, void*)")
# 呼び出し: BSTR_UserSize(param0, param1, param2)
# param0 : DWORD* -> "void*"
# param1 : DWORD -> "dword"
# param2 : LPWSTR* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef BSTR_UserSizeNative = Uint32 Function(Pointer<Uint32>, Uint32, Pointer<Pointer<Utf16>>);
typedef BSTR_UserSizeDart = int Function(Pointer<Uint32>, int, Pointer<Pointer<Utf16>>);
final BSTR_UserSize = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<BSTR_UserSizeNative, BSTR_UserSizeDart>('BSTR_UserSize');
// param0 : DWORD* -> Pointer<Uint32>
// param1 : DWORD -> Uint32
// param2 : LPWSTR* -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BSTR_UserSize(
  param0: Pointer;   // DWORD*
  param1: DWORD;   // DWORD
  param2: PPWideChar   // LPWSTR*
): DWORD; stdcall;
  external 'OLEAUT32.dll' name 'BSTR_UserSize';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BSTR_UserSize"
  c_BSTR_UserSize :: Ptr Word32 -> Word32 -> Ptr CWString -> IO Word32
-- param0 : DWORD* -> Ptr Word32
-- param1 : DWORD -> Word32
-- param2 : LPWSTR* -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bstr_usersize =
  foreign "BSTR_UserSize"
    ((ptr uint32_t) @-> uint32_t @-> (ptr (ptr uint16_t)) @-> returning uint32_t)
(* param0 : DWORD* -> (ptr uint32_t) *)
(* param1 : DWORD -> uint32_t *)
(* param2 : LPWSTR* -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("BSTR_UserSize" bstr-user-size :convention :stdcall) :uint32
  (param0 :pointer)   ; DWORD*
  (param1 :uint32)   ; DWORD
  (param2 :pointer))   ; LPWSTR*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BSTR_UserSize = Win32::API::More->new('OLEAUT32',
    'DWORD BSTR_UserSize(LPVOID param0, DWORD param1, LPVOID param2)');
# my $ret = $BSTR_UserSize->Call($param0, $param1, $param2);
# param0 : DWORD* -> LPVOID
# param1 : DWORD -> DWORD
# param2 : LPWSTR* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API