バリアント型（COM）

バリアント型は、 Visual Basic、OCaml、^{[1] 、}Delphi、C++などの特定のプログラミング言語において、コンポーネントオブジェクトモデル（COM）を使用する際に用いられるデータ型です。これは、コンピュータサイエンスにおける同名のコンセプトの実装です。

Visual Basic（およびVisual Basic for Applications）では、バリアント型はタグ付き共用体であり、固定長文字列型を除くあらゆるデータ型（整数、浮動小数点、単精度および倍精度、オブジェクトなど）を表すために使用できます。Visual Basicでは、明示的に宣言されていない変数、または型が明示的に宣言されていない変数はすべてバリアント型とみなされます。

明示的に宣言されていないバリアントの使用は推奨されませんが、必要なデータ型が実行時にのみ判明する場合、データ型が変化すると予想される場合、あるいはオプションのパラメータやパラメータ配列が必要な場合には、バリアントが有用です。実際、動的型システムを備えた言語では、変数に使用できる型としてバリアントが唯一存在することがよくあります。

Visual Basic .NETにおける主要な変更点の一つとして、.NET 言語であるという事実が挙げられます。バリアント型は .NETオブジェクト型に置き換えられました。概念的には類似点がありますが、大きな違いもあり、これら 2 つの型の間には直接的な変換は存在しません。Visual Basic .NET コードが Visual Basic 6 COM オブジェクトとやり取りする際に必要となる可能性のある変換については、通常は.NET マーシャリングを使用します。

例

Visual Basic では、A という名前のバリアントを明示的または暗黙的に宣言できます。

Dim A Dim Aのバリエーション

Delphiでは、 A という名前のバリアントは次のように宣言されます。

var A :バリアント;

フォーマット

Visual Basicで定義されているバリアント型変数（略して「バリアント」と呼ばれます）は、16バイトの記憶域を必要とし、そのレイアウトは次のとおりです

オフセット	サイズ	説明
0	2	VarType によって返される値は、バリアントに含まれるデータの種類を指定します。
2	6	予約バイト。VT_DECIMAL型のみに使用されます。
8	最大8	バリアントに含まれるデータ。

型

Visual Basicで遭遇する可能性のあるバリアントの例をいくつか示します。他の言語では、他の種類のバリアントも使用できます

変数型	16進数	プロパバリアント型	プロパバリアントメンバー	型名	データバイト	CおよびC++型
0	0x00	VT_EMPTY	なし	空¹
1	0x01	VT_NULL	なし	ヌル²
2	0x02	VT_I2	iVal	整数	2A00	ショート
3	0x03	VT_I4	lVal	ロング	2A000000	ロング
4	0x04	VT_R4	浮動小数点値	単一	00002842	浮動小数点数
5	0x05	VT_R8	ダブル値	ダブル	0000000000004540	ダブル
6	0x06	VT_CY	cyVal	通貨	A068060000000000	CY構造
7	0x07	VT_DATE	日付	日付	00000000C0D5E140	日付（倍精度浮動小数点数）
8	0x08	VT_BSTR	bstrVal	文字列	xxxxxxxx	(BSTR):(OLECHAR ):(WCHAR ):( wchar_t *)
9	0x09	VT_DISPATCH	pdispVal
10	0x0a	VT_ERROR	scode	エラー	2A000A80	HRESULT (long int)
11	0x0b	VT_BOOL	ブール値	ブール型	FFFF	VARIANT_BOOL (short)
12	0x0c	VT_VARIANT	pvarVal	バリアント		バリアント
13	0x0d	VT_UNKNOWN	パンク値	なし⁴	00000000	不明*
14	0x0e	VT_DECIMAL	10進数値			10進数
16	0x10	VT_I1	cVal	バイト		文字
17	0x11	VT_UI1	bVal	バイト	2A	バイト（符号なし文字）
18	0x12	VT_UI2	uiVal			ワード（符号なしショート）
19	0x13	VT_UI4	ulVal			DWORD (符号なし整数)
20	0x14	VT_I8	hVal
21	0x15	VT_UI8	uhVal
22	0x16	VT_INT	整数値
23	0x17	VT_UINT	uintVal
24	0x18	VT_VOID
25	0x19	VT_HRESULT		³が見つかりません	80020004	HRESULT (long int)
26	0x1a	VT_PTR
27	0x1b	VT_SAFEARRAY	パラレイ
28	0x1c	VT_CARRAY
29	0x1d	VT_ユーザー定義
30	0x1e	VT_LPSTR	pszVal
31	0x1f	VT_LPWSTR	pwszVal
36	0x24	VT_RECORD
37	0x25	VT_INT_PTR	ピン値
38	0x26	VT_UINT_PTR	ポインタ値
8192	0x2000	VT_ARRAY	パラレイ
9				オブジェクト参照⁵	xxxxxxxx	IUnknown *

¹初期化されていないバリアントの型
²データベース内の NULL 値の型。つまり、初期化されておらず、C++ のNULL ポインターと同等ではありません。
³不足している引数は、実際には「パラメータが見つかりません」という特定のエラー値です。
⁴オブジェクトタイプが null 参照に設定されました。
⁵ TypeNameは、含まれるオブジェクトのクラス名を返します。データはインターフェースポインタ、つまり仮想メソッドテーブル（関数ポインタの配列）へのポインタへのポインタになります。

一般的な用途

コレクション

OLEオートメーションCollectionのクラスは、異なるデータ型の項目を格納できます。これらの項目のデータ型はコンパイル時に不明であるため、コレクションに項目を追加したり、コレクションから項目を取得したりするメソッドではバリアントを使用します。Visual Basicでこの構造を使用する場合、反復子変数はオブジェクト型またはバリアント型でなければなりませんFor Each

ディスパッチメソッド呼び出し

OLEオートメーションでは、IDispatchオブジェクトのクラスを事前に知ることができない場合にインターフェースが使用されます。したがって、そのようなオブジェクトのメソッドを呼び出す場合、引数と戻り値の型はコンパイル時にはわかりません。引数はバリアントの配列として渡され、呼び出しが完了するとバリアントが返されます

オプションパラメータ

Visual Basicでは、プロシージャの引数にキーワードを接頭辞として付けることで、引数を省略可能と宣言できます。引数が省略された場合、Visual Basicは上記の表でMissingOptionalと呼ばれる特別な値をプロシージャに渡します。この値は、引数が欠落していることを示します。この値は指定値または特別な値のいずれかであるため、バリアントを使用する必要があります。

Function GetText ( Optional ByVal Index ) As String If IsMissing ( Index ) Then GetText = Item ( CurrentItem ) Else GetText = Item ( Index ) End If End Function

同様に、キーワードをParamArray使用して、後続のすべての引数をバリアント配列で渡すこともできます。

参照

^ “第6章バリアント / Real World OCaml”. v1.realworldocaml.org . 2019年5月8日時点のオリジナルよりアーカイブ。

外部リンク

C++ Boost.Variant
https://msdn.microsoft.com/en-ca/library/cc237865.aspx
https://msdn.microsoft.com/en-us/library/windows/desktop/aa380072(v=vs.85).aspx

[1] “第6章バリアント / Real World OCaml”. v1.realworldocaml.org . 2019年5月8日時点のオリジナルよりアーカイブ。