VarBstrFromDisp

関数

IDispatchオブジェクトの既定値をBSTR文字列に変換する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarBstrFromDisp(
    IDispatch* pdispIn,
    DWORD lcid,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

パラメーター

名前	型	方向	説明
pdispIn	IDispatch*	in	変換する値。
lcid	DWORD	in	ロケール識別子。
dwFlags	DWORD	in	予約済み。ゼロを設定します。
pbstrOut	LPWSTR*	out	変換結果の値。

戻り値の型: HRESULT

公式ドキュメント

IDispatch インスタンスの既定のプロパティを BSTR 値に変換します。

戻り値

この関数は次のいずれかの値を返します。

戻り値	説明
S_OK	成功しました。
DISP_E_BADVARTYPE	入力パラメーターが有効な variant の型ではありません。
DISP_E_OVERFLOW	出力パラメーターが指す데이터が変換先の型に収まりません。
DISP_E_TYPEMISMATCH	引数を指定された型に変換できませんでした。
E_INVALIDARG	引数のいずれかが無効です。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。

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

各言語での呼び出し定義

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

HRESULT VarBstrFromDisp(
    IDispatch* pdispIn,
    DWORD lcid,
    DWORD dwFlags,
    LPWSTR* pbstrOut
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarBstrFromDisp(
    IntPtr pdispIn,   // IDispatch*
    uint lcid,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr pbstrOut   // LPWSTR* out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarBstrFromDisp(
    pdispIn As IntPtr,   ' IDispatch*
    lcid As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    pbstrOut As IntPtr   ' LPWSTR* out
) As Integer
End Function

' pdispIn : IDispatch*
' lcid : DWORD
' dwFlags : DWORD
' pbstrOut : LPWSTR* out
Declare PtrSafe Function VarBstrFromDisp Lib "oleaut32" ( _
    ByVal pdispIn As LongPtr, _
    ByVal lcid As Long, _
    ByVal dwFlags As Long, _
    ByVal pbstrOut As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VarBstrFromDisp = ctypes.windll.oleaut32.VarBstrFromDisp
VarBstrFromDisp.restype = ctypes.c_int
VarBstrFromDisp.argtypes = [
    ctypes.c_void_p,  # pdispIn : IDispatch*
    wintypes.DWORD,  # lcid : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pbstrOut : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarBstrFromDisp = Fiddle::Function.new(
  lib['VarBstrFromDisp'],
  [
    Fiddle::TYPE_VOIDP,  # pdispIn : IDispatch*
    -Fiddle::TYPE_INT,  # lcid : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbstrOut : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VarBstrFromDisp(
        pdispIn: *mut core::ffi::c_void,  // IDispatch*
        lcid: u32,  // DWORD
        dwFlags: u32,  // DWORD
        pbstrOut: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int VarBstrFromDisp(IntPtr pdispIn, uint lcid, uint dwFlags, IntPtr pbstrOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarBstrFromDisp' -Namespace Win32 -PassThru
# $api::VarBstrFromDisp(pdispIn, lcid, dwFlags, pbstrOut)

#uselib "OLEAUT32.dll"
#func global VarBstrFromDisp "VarBstrFromDisp" sptr, sptr, sptr, sptr
; VarBstrFromDisp pdispIn, lcid, dwFlags, varptr(pbstrOut)   ; 戻り値は stat
; pdispIn : IDispatch* -> "sptr"
; lcid : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; pbstrOut : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global VarBstrFromDisp "VarBstrFromDisp" sptr, int, int, var
; res = VarBstrFromDisp(pdispIn, lcid, dwFlags, pbstrOut)
; pdispIn : IDispatch* -> "sptr"
; lcid : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pbstrOut : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global VarBstrFromDisp "VarBstrFromDisp" sptr, int, int, sptr
; res = VarBstrFromDisp(pdispIn, lcid, dwFlags, varptr(pbstrOut))
; pdispIn : IDispatch* -> "sptr"
; lcid : DWORD -> "int"
; dwFlags : DWORD -> "int"
; pbstrOut : LPWSTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。