名前¶

Win32::OLE::Variant - OLE バリアント変数の作成と変更

概要¶

        use Win32::OLE::Variant;
        my $var = Variant(VT_DATE, 'Jan 1,1970');
        $OleObject->{value} = $var;
        $OleObject->Method($var);

説明¶

Perl OLE モジュールによって使われる IDispatch インターフェースは バリアント(VARIANT)と呼ばれる汎用的な引数型を使います。 これは基本的にデータ型と実際のデータ値をもったオブジェクトです。 データ型は VT_xxx 定数により指定されます。

関数¶

nothing()

The nothing() function returns an empty VT_DISPATCH variant. It can be used to clear an object reference stored in a property

nothing() 関数は空の VT_DISPATCH 変数を返します。 プロパティに格納されたオブジェクト参照をクリアするために使えます。

        use Win32::OLE::Variant qw(:DEFAULT nothing);
        # ...
        $object->{Property} = nothing;

This has the same effect as the Visual Basic statement

これは以下の Visual Basic ステートメントと同じ効果を持ちます。

        Set object.Property = Nothing

The nothing() function is not exported by default.

nothing() はデフォルトではエクスポート されません。

Variant(TYPE, DATA)

This is just a function alias of the Win32::OLE::Variant-new()> method (see below). This function is exported by default.

これは Win32::OLE::Variant-new()> メソッドの単なる別名関数です。 (下記をご覧ください)この関数はデフォルトでエクスポートされます。

メソッド¶

new(TYPE, DATA)

This method returns a Win32::OLE::Variant object of the specified TYPE that contains the given DATA. The Win32::OLE::Variant object can be used to specify data types other than IV, NV or PV (which are supported transparently). See Variants below for details.

このメソッドは指定された TYPE の与えられた DATA をもった Win32::OLE::Variant オブジェクトを返します。 Win32::OLE::Variant オブジェクトは IV, NV, PV(これらは透過的に サポートされています)以外のデータ型を指定するために使えます。 詳細については下記の "Variants" をご覧ください。

For VT_EMPTY and VT_NULL variants, the DATA argument may be omitted. For all non-VT_ARRAY variants DATA specifies the initial value.

VT_EMPTY と VT_NULL バリアントについては、DATA 引数を省略することができます。 すべての VT_ARRAY ではない variant については、DATA を初期値を指定します。

To create a SAFEARRAY variant, you have to specify the VT_ARRAY flag in addition to the variant base type of the array elemnts. In this cases DATA must be a list specifying the dimensions of the array. Each element can be either an element count (indices 0 to count-1) or an array reference pointing to the lower and upper array bounds of this dimension:

SAFEARRAY バリアントを作るためには、配列要素の基本型に加えて VT_ARRAY フラグを指定する必要があります。 この場合、DATA は配列を次元を指定するリストでなければなりません。 各要素は要素数(0 から指定数 -1 を示します)またはこの次元での上限下限を 示す配列リファレンスのどちらかにすることができます:

        my $Array = Win32::OLE::Variant->new(VT_ARRAY|VT_R8, [1,2], 2);

This creates a 2-dimensional SAFEARRAY of doubles with 4 elements: (1,0), (1,1), (2,0) and (2,1).

これは double で四つの要素：((1,0), (1,1), (2,0), (2,1) をもった 2 次元の SAFEARRAY を作成します。

A special case is the the creation of one-dimensional VT_UI1 arrays with a string DATA argument:

特別なケースは、文字列 DATA 引数をもった 1 次元の VT_UI1 配列の作成です:

        my $String = Variant(VT_ARRAY|VT_UI1, "String");

This creates a 6 element character array initialized to "String". For backward compatibility VT_UI1 with a string initializer automatically implies VT_ARRAY. The next line is equivalent to the previous example:

これは "String" で初期化された六つの文字配列を作成します。 後方互換性のため、文字列初期値をもった VT_UI1 は自動的に VT_ARRAY が 暗黙のうちに設定されます。 次の行は前の例と同じです:

        my $String = Variant(VT_UI1, "String");

If you really need a single character VT_UI1 variant, you have to create it using a numeric intializer:

本当に 1 文字 VT_UI1 バリアントが必要なのであれば、数値の初期値を使って 作らなければなりません:

        my $Char = Variant(VT_UI1, ord('A'));

As(TYPE)

As converts the VARIANT to the new type before converting to a Perl value. This take the current LCID setting into account. For example a string might contain a ',' as the decimal point character. Using $variant-As(VT_R8)> will correctly return the floating point value.

As は VARIANT を Perl の値に変換される前に新しい型に変換します。 これは現在の LCID 設定も勘案します。 例えばある文字列は小数点文字として ',' が入っているかもしれません。 $variant-As(VT_R8)> を使うと浮動小数点値を返します。

The underlying variant object is NOT changed by this method.

元になるバリアントは、このメソッドによって変更されません。

ChangeType(TYPE)

This method changes the type of the contained VARIANT in place. It returns the object itself, not the converted value.

このメソッドは入っているバリアントの型をその場で変更します。 変換された値ではなく、オブジェクトそれ自身を返します。

Copy([DIM])

This method creates a copy of the object. If the original variant had the VT_BYREF bit set then the new object will contain a copy of the referenced data and not a reference to the same old data. The new object will not have the VT_BYREF bit set.

このメソッドはオブジェクトのコピーを作成します。 元のバリアントの VT_BYREF ビットが設定されていれば、新しいオブジェクトは 同じ古いデータのリファレンスではなく参照されているデータのコピーを持ちます。 新しいオブジェクトでは VT_BYREF ビットは設定されていません。

        my $Var = Variant(VT_I4|VT_ARRAY|VT_BYREF, [1,5], 3);
        my $Copy = $Var->Copy;

The type of $Copy is now VT_I4|VT_ARRAY and the value is a copy of the other SAFEARRAY. Changes to elements of $Var will not be reflected in $Copy and vice versa.

$Copy の型は今や VT_I4|VT_ARRAY であり、値は他の SAFEARRAY のコピーです。 $Var の要素を変更しても $Copy には反映されませんし、その逆でも同じです。

The Copy method can also be used to extract a single element of a VT_ARRAY | VT_VARIANT object. In this case the array indices must be specified as a list DIM:

Copy メソッドはVT_ARRAY | VT_VARIANT オブジェクトの一つの要素を 取り出すために使うこともできます。 この場合、配列のインデックスはリスト DIM で指定されなければなりません:

        my $Int = $Var->Copy(1, 2);

$Int is now a VT_I4 Variant object containing the value of element (1,2).

$Int は今や要素 (1,2) の値をもった VT_I4 バリアントオブジェクトです。

Currency([FORMAT[, LCID]])

This method converts the VARIANT value into a formatted curency string. The FORMAT can be either an integer constant or a hash reference. Valid constants are 0 and LOCALE_NOUSEROVERRIDE. You get the value of LOCALE_NOUSEROVERRIDE from the Win32::OLE::NLS module:

このメソッドはバリアントの値を書式設定された通貨文字列に変換します。 FORMAT は整数定数またはハッシュリファレンスのどちらかにすることができます。 適切な定数は 0 と LOCALE_NOUSEROVERRIDE です。 Win32::OLE::NLS モジュールから LOCALE_NOUSEROVERRIDE の値を取得できます:

        use Win32::OLE::NLS qw(:LOCALE);

LOCALE_NOUSEROVERRIDE tells the method to use the system default currency format for the specified locale, disregarding any changes that might have been made through the control panel application.

LOCALE_NOUSEROVERRIDE は、コントロールパネルアプリケーションを通して 行われた変更をすべて無視しして、指定されたロケールのための システムデフォルト通貨フォーマットを使うように指示します。

The hash reference could contain the following keys:

ハッシュリファレンスには以下のキーを入れることができます:

        NumDigits       number of fractional digits
        LeadingZero     whether to use leading zeroes in decimal fields
        Grouping        size of each group of digits to the left of the decimal
        DecimalSep      decimal separator string
        ThousandSep     thousand separator string
        NegativeOrder   see L<Win32::OLE::NLS/LOCALE_ICURRENCY>
        PositiveOrder   see L<Win32::OLE::NLS/LOCALE_INEGCURR>
        CurrencySymbol  currency symbol string