Win32-OLE-0.1502 > Win32::OLE::Const
Win32-OLE-0.1502
Other versions:
libwin32-0.26

名前

Win32::OLE::Const - Extract constant definitions from TypeLib

Win32::OLE::Const - タイプライブラリから定数定義を取り出す

概要

    use Win32::OLE::Const 'Microsoft Excel';
    printf "xlMarkerStyleDot = %d\n", xlMarkerStyleDot;

    my $wd = Win32::OLE::Const->Load("Microsoft Word 8\\.0 Object Library");
    foreach my $key (keys %$wd) {
        printf "$key = %s\n", $wd->{$key};
    }

説明

This modules makes all constants from a registered OLE type library available to the Perl program. The constant definitions can be imported as functions, providing compile time name checking. Alternatively the constants can be returned in a hash reference which avoids defining lots of functions of unknown names.

このモジュールはすべての定数を登録された OLE タイプライブラリから Perl プログラムで利用できるようにします。 定数定義は関数としてインポートされ、コンパイル時の名前チェックが 提供されます。 多くの知らない関数を定義することを避けて、代わりとして定数を ハッシュリファレンスとして返すこともできます。

関数/メソッド

use Win32::OLE::Const

The use statement can be used to directly import the constant names and values into the users namespace.

use ステートメントで直接、定数名と変数をユーザ名前空間に インポートするために使うことができます。

    use Win32::OLE::Const (TYPELIB,MAJOR,MINOR,LANGUAGE);

The TYPELIB argument specifies a regular expression for searching through the registry for the type library. Note that this argument is implicitly prefixed with ^ to speed up matches in the most common cases. Use a typelib name like ".*Excel" to match anywhere within the description. TYPELIB is the only required argument.

TYPELIB 引数はタイプライブラリをレジストリで探すための正規表現を指定します。 この引数は暗黙のうちに、マッチングのスピードをほとんどの場合あげるように、 頭に ^ がつけられることに注意してください。 記述のどこであってもマッチングするようにするには、".*Excel" のような タイプライブラリ名を使ってください。 TYPELIB だけが必須の引数です。

The MAJOR and MINOR arguments specify the requested version of the type specification. If the MAJOR argument is used then only typelibs with exactly this major version number will be matched. The MINOR argument however specifies the minimum acceptable minor version. MINOR is ignored if MAJOR is undefined.

MAJOR と MINOR 引数はタイプ仕様の必要とされるバージョンを指定します。 MAJOR 引数が使われると、厳密にこのメジャーバージョン番号をもった タイプライブラリだけがマッチします。 しかし MINOR 引数は最小の受け入れることのできるマイナーバージョンを 指定します。 MAJOR が未定義であれば、MINOR は無視されます。

If the LANGUAGE argument is used then only typelibs with exactly this language id will be matched.

LANGUAGE 引数が使われると、厳密にこの language id を持っている タイプライブラリだけがマッチします。

The module will select the typelib with the highest version number satisfying the request. If no language id is specified then a the default language (0) will be preferred over the others.

モジュールは要求を満たす最も高いバージョン番号のタイプライブラリを 選択します。 language id が指定されなければ、デフォルトの language (0) が他のものよりも 優先されます。

Note that only constants with valid Perl variable names will be exported, i.e. names matching this regexp: /^[a-zA-Z_][a-zA-Z0-9_]*$/.

正しい Perl 変数名つまり名前が以下の正規表現にマッチングする: /^[a-zA-Z_][a-zA-Z0-9_]*$/ を持つ定数だけがエクスポートされることに 注意してください。

Win32::OLE::Const->Load

The Win32::OLE::Const->Load method returns a reference to a hash of constant definitions.

Win32::OLE::Const->Load メソッドは定数定義のハッシュへのリファレンスを 返します。

    my $const = Win32::OLE::Const->Load(TYPELIB,MAJOR,MINOR,LANGUAGE);

The parameters are the same as for the use case.

パラメータは use の場合と同じです。

This method is generally preferrable when the typelib uses a non-english language and the constant names contain locale specific characters not allowed in Perl variable names.

このメソッドは一般的にタイプライブラリが英語以外の言語を使っているときや 定数名にロケール特有の Perl 変数名として許されない文字が入っているときに 好まれます。

Another advantage is that all available constants can now be enumerated.

もう一つの利点は、利用できるすべての定数を列挙できることです。

The load method also accepts an OLE object as a parameter. In this case the OLE object is queried about its containing type library and no registry search is done at all. Interestingly this seems to be slower.

load メソッドは OLE オブジェクトもパラメータとして受け入れます。 この場合、OLE オブジェクトは、それが持っているタイプライブラリを 問い合わせられ、レジストリ検索はおこなわれなせん。 面白いことに、これはより遅いようです。

The first example imports all Excel constants names into the main namespace and prints the value of xlMarkerStyleDot (-4118).

最初の例では、すべての Excel 定数名をメインの名前空間にインポートし、 xlMarkerStyleDot (-4118) の値を出力します。

    use Win32::OLE::Const ('Microsoft Excel 8.0 Object Library');
    print "xlMarkerStyleDot = %d\n", xlMarkerStyleDot;

The second example returns all Word constants in a hash ref.

2 番目の例はすべての Word 定数をハッシュリファレンスとして返します:

    use Win32::OLE::Const;
    my $wd = Win32::OLE::Const->Load("Microsoft Word 8.0 Object Library");
    foreach my $key (keys %$wd) {
        printf "$key = %s\n", $wd->{$key};
    }
    printf "wdGreen = %s\n", $wd->{wdGreen};

The last example uses an OLE object to specify the type library:

最後の例は OLE オブジェクトをタイプライブラリを指定するために使います:

    use Win32::OLE;
    use Win32::OLE::Const;
    my $Excel = Win32::OLE->new('Excel.Application', 'Quit');
    my $xl = Win32::OLE::Const->Load($Excel);

AUTHORS/COPYRIGHT

This module is part of the Win32::OLE distribution.

このモジュールは Win32::OLE ディストリビューションの一部です。