ホーム › System.Variant › VariantChangeTypeEx

VariantChangeTypeEx

関数

ロケールを指定してVARIANTを指定した型に変換する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VariantChangeTypeEx(
    VARIANT* pvargDest,
    const VARIANT* pvarSrc,
    DWORD lcid,
    VAR_CHANGE_FLAGS wFlags,
    VARENUM vt
);

パラメーター

名前

型

方向

説明

pvargDest

VARIANT*

inout

変換先のバリアント。これが pvarSrc と同じ場合、バリアントはその場で変換されます。

pvarSrc

VARIANT*

変換元のバリアント。

lcid

DWORD

ロケール識別子。LCID は、変換元または変換先の VARIANTARG の型が VT_BSTR、VT_DISPATCH、または VT_DATE である場合に役立ちます。

wFlags

VAR_CHANGE_FLAGS

フラグ。

値	意味
VARIANT_NOVALUEPROP	Value プロパティを取得することでオブジェクトを基本型に強制変換しようとする動作を抑止します。このフラグを設定すると他のアプリケーションと動作が一貫しなくなるため、アプリケーションは必要な場合にのみ設定してください。
VARIANT_ALPHABOOL	VT_BOOL の値を "True" または "False" を含む文字列に変換します。
VARIANT_NOUSEROVERRIDE	VT_BSTR との間の変換において、コアの強制変換ルーチンに LOCALE_NOUSEROVERRIDE を渡します。
VARIANT_LOCALBOOL	VT_BOOL から VT_BSTR への変換およびその逆の変換において、ローカルコンピューターで使用中のロケールで指定される言語を使用します。

VARENUM

変換先の型。戻り値が S_OK の場合、*pvargDest の vt フィールドは必ずこの値と等しくなります。

戻り値の型: HRESULT

公式ドキュメント

LCID を使用して、バリアントをある型から別の型へ変換します。

戻り値

この関数は次のいずれかの値を返すことがあります。

戻り値	説明
S_OK	成功しました。
DISP_E_BADVARTYPE	バリアントの型が有効なバリアント型ではありません。
DISP_E_OVERFLOW	pvarSrc が指すデータが変換先の型に収まりません。
DISP_E_TYPEMISMATCH	引数を指定された型に強制変換できませんでした。
E_INVALIDARG	引数のいずれかが無効です。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。

解説(Remarks)

VariantChangeTypeEx 関数は、基本型どうしの強制変換 (数値から文字列、文字列から数値への強制変換を含む) を処理します。VT_BYREF が設定されているバリアントは、参照先の値を取得することで値に強制変換されます。オブジェクトは、そのオブジェクトの Value プロパティ (DISPID_VALUE) を呼び出すことで値に強制変換されます。

通常、IDispatch::Invoke の実装者は、どのメンバーがアクセスされているかを判断し、次に VariantChangeType を呼び出して 1 つ以上の引数の値を取得します。たとえば、IDispatch の呼び出しが文字列引数を 1 つ取る SetTitle メンバーを指定している場合、実装者は VariantChangeTypeEx を呼び出して、その引数を VT_BSTR に強制変換しようとします。

VariantChangeTypeEx がエラーを返さなければ、引数は VARIANTARG の bstrVal フィールドから直接取得できます。VariantChangeTypeEx が DISP_E_TYPEMISMATCH を返した場合、実装者は *puArgErr に 0 (エラーとなった引数を示す) を設定し、IDispatch::Invoke から DISP_E_TYPEMISMATCH を返します。

この関数では、ある型の配列を別の型の配列に変換することはできません。

メモ rgvarg 配列内の VARIANTARG の型を、その場で変更しないでください。

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

各言語での呼び出し定義

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

HRESULT VariantChangeTypeEx(
    VARIANT* pvargDest,
    const VARIANT* pvarSrc,
    DWORD lcid,
    VAR_CHANGE_FLAGS wFlags,
    VARENUM vt
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VariantChangeTypeEx(
    IntPtr pvargDest,   // VARIANT* in/out
    IntPtr pvarSrc,   // VARIANT*
    uint lcid,   // DWORD
    ushort wFlags,   // VAR_CHANGE_FLAGS
    ushort vt   // VARENUM
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VariantChangeTypeEx(
    pvargDest As IntPtr,   ' VARIANT* in/out
    pvarSrc As IntPtr,   ' VARIANT*
    lcid As UInteger,   ' DWORD
    wFlags As UShort,   ' VAR_CHANGE_FLAGS
    vt As UShort   ' VARENUM
) As Integer
End Function

' pvargDest : VARIANT* in/out
' pvarSrc : VARIANT*
' lcid : DWORD
' wFlags : VAR_CHANGE_FLAGS
' vt : VARENUM
Declare PtrSafe Function VariantChangeTypeEx Lib "oleaut32" ( _
    ByVal pvargDest As LongPtr, _
    ByVal pvarSrc As LongPtr, _
    ByVal lcid As Long, _
    ByVal wFlags As Integer, _
    ByVal vt As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VariantChangeTypeEx = ctypes.windll.oleaut32.VariantChangeTypeEx
VariantChangeTypeEx.restype = ctypes.c_int
VariantChangeTypeEx.argtypes = [
    ctypes.c_void_p,  # pvargDest : VARIANT* in/out
    ctypes.c_void_p,  # pvarSrc : VARIANT*
    wintypes.DWORD,  # lcid : DWORD
    ctypes.c_ushort,  # wFlags : VAR_CHANGE_FLAGS
    ctypes.c_ushort,  # vt : VARENUM
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VariantChangeTypeEx = Fiddle::Function.new(
  lib['VariantChangeTypeEx'],
  [
    Fiddle::TYPE_VOIDP,  # pvargDest : VARIANT* in/out
    Fiddle::TYPE_VOIDP,  # pvarSrc : VARIANT*
    -Fiddle::TYPE_INT,  # lcid : DWORD
    -Fiddle::TYPE_SHORT,  # wFlags : VAR_CHANGE_FLAGS
    -Fiddle::TYPE_SHORT,  # vt : VARENUM
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VariantChangeTypeEx(
        pvargDest: *mut VARIANT,  // VARIANT* in/out
        pvarSrc: *const VARIANT,  // VARIANT*
        lcid: u32,  // DWORD
        wFlags: u16,  // VAR_CHANGE_FLAGS
        vt: u16  // VARENUM
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int VariantChangeTypeEx(IntPtr pvargDest, IntPtr pvarSrc, uint lcid, ushort wFlags, ushort vt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VariantChangeTypeEx' -Namespace Win32 -PassThru
# $api::VariantChangeTypeEx(pvargDest, pvarSrc, lcid, wFlags, vt)

#uselib "OLEAUT32.dll"
#func global VariantChangeTypeEx "VariantChangeTypeEx" sptr, sptr, sptr, sptr, sptr
; VariantChangeTypeEx varptr(pvargDest), varptr(pvarSrc), lcid, wFlags, vt   ; 戻り値は stat
; pvargDest : VARIANT* in/out -> "sptr"
; pvarSrc : VARIANT* -> "sptr"
; lcid : DWORD -> "sptr"
; wFlags : VAR_CHANGE_FLAGS -> "sptr"
; vt : VARENUM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global VariantChangeTypeEx "VariantChangeTypeEx" var, var, int, int, int
; res = VariantChangeTypeEx(pvargDest, pvarSrc, lcid, wFlags, vt)
; pvargDest : VARIANT* in/out -> "var"
; pvarSrc : VARIANT* -> "var"
; lcid : DWORD -> "int"
; wFlags : VAR_CHANGE_FLAGS -> "int"
; vt : VARENUM -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global VariantChangeTypeEx "VariantChangeTypeEx" sptr, sptr, int, int, int
; res = VariantChangeTypeEx(varptr(pvargDest), varptr(pvarSrc), lcid, wFlags, vt)
; pvargDest : VARIANT* in/out -> "sptr"
; pvarSrc : VARIANT* -> "sptr"
; lcid : DWORD -> "int"
; wFlags : VAR_CHANGE_FLAGS -> "int"
; vt : VARENUM -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。