名前¶

Win32::OLE - OLE オートメーション拡張

概要¶

    $ex = Win32::OLE->new('Excel.Application') or die "oops\n";
    $ex->Amethod("arg")->Bmethod->{'Property'} = "foo";
    $ex->Cmethod(undef,undef,$Arg3);
    $ex->Dmethod($RequiredArg1, {NamedArg1 => $Value1, NamedArg2 => $Value2});

    $wd = Win32::OLE->GetObject("D:\\Data\\Message.doc");
    $xl = Win32::OLE->GetActiveObject("Excel.Application");

説明¶

このモジュールは Perl からの OLE オートメーションへのインターフェースを 提供します。 OLE オートメーションは VisualBasic のようなスクリプトの能力を提供し、 強力な拡張性と Perl スクリプトから数多くの Win32 アプリケーションを 制御する能力を提供します。

Win32::OLE モジュールはもっぱら IDispatch インターフェースを使用します。 カスタム OLE インターフェースにアクセスすることはできません。 OLE インベントと OCX には現在のところ対応していません。

実際には、これは厳密には正しくありません。 このモジュールは OLE イベントに アルファ レベルで対応しています。 これはあまりテストされていませんし、インタフェース仕様は将来 変更される可能性があります。

メソッド¶

Win32::OLE->new(PROGID[, DESTRUCTOR])

The new() class method starts a new instance of an OLE Automation object. It returns a reference to this object or undef if the creation failed.

new() クラスメソッドは OLE オートメーションオブジェクトの新しい インスタンスを開始します。 このオブジェクトのリファレンスか、もし作成が失敗すれば undef を返します。

The PROGID argument must be either the OLE program id or the class id of the required application. The optional DESTRUCTOR specifies a DESTROY-like method. This can be either a CODE reference or a string containing an OLE method name. It can be used to cleanly terminate OLE applications in case the Perl program dies.

PROGID 引数は必要なアプリケーションの OLE プログラム ID または クラス ID でなければなりません。 オプションの DESTRUCTOR には DESTROY のようなメソッドを指定します。 これは CODE リファレンスまたは OLE メソッド名の入った文字列のどちらかに することができます。 これは Perl プログラムが die するときに、OLE アプリケーションを きれいに終らせるために使われます。

To create an object via DCOM on a remote server you can use an array reference in place of PROGID. The referenced array must contain the machine name and the program id or class id. For example:

DCOM を通じてリモートサーバーにオブジェクトを作成するためには、PROGID の ところに配列リファレンスを使えます。 参照される配列にはマシン名と プログラム ID または クラス ID が 入らなければなりません。 例えば:

        my $obj = Win32::OLE->new(['my.machine.com', 'Program.Id']);

If the PROGID is a program id then Win32::OLE will try to resolve the corresponding class id locally. If the program id is not registered locally then the remote registry is queried. This will only succeed if the local process has read access to the remote registry. The safest (and fastest) method is to specify the class id directly.

PROGID が プログラム ID であれば、Win32::OLE はローカルに対応する クラス ID を解決しようとします。 もしローカルに プログラム ID が登録されていなければ、リモートレジストリが 問い合わせられます。 これはローカルなプロセスがリモートレジストリに読み込みアクセスを もっているときにのみ成功します。 もっとも安全な(そしても最も速い)方法は、クラス ID を直接指定することです。

Win32::OLE->EnumAllObjects([CALLBACK])

This class method returns the number Win32::OLE objects currently in existance. It will call the optional CALLBACK function for each of these objects:

このクラスメソッドは現在存在する Win32::OLE オブジェクトの数を返します。 オプションで各オブジェクトへの CALLBACK 関数を呼ぶこともできます:

        $Count = Win32::OLE->EnumAllObjects(sub {
            my $Object = shift;
            my $Class = Win32::OLE->QueryObjectType($Object);
            printf "# Object=%s Class=%s\n", $Object, $Class;
        });

The EnumAllObjects() method is primarily a debugging tool. It can be used e.g. in an END block to check if all external connections have been properly destroyed.

EnumAllObjects() メソッドは主にデバッグのためのツールです。 これは例えば、すべての外部コメンクションが適切に破壊されているかを チェックするために END ブロックに入れて使えます。

Win32::OLE->FreeUnusedLibraries()

The FreeUnusedLibraries() class method unloads all unused OLE resources. These are the libraries of those classes of which all existing objects have been destroyed. The unloading of object libraries is really only important for long running processes that might instantiate a huge number of different objects over time.

FreeUnusedLibraries() クラスメソッドは全ての使われていない OLE リソースを アンロードします。 これらは存在しているオブジェクトのすべてが破壊されたクラスのライブラリです。 オブジェクトライブラリのアンロードは、長時間とても多くの 異なる オブジェクトを繰り返し、インスタンス生成するプロセスを実行したときにだけ 本当に重要です。

Be aware that objects implemented in Visual Basic have a buggy implementation of this functionality: They pretend to be unloadable while they are actually still running their cleanup code. Unloading the DLL at that moment typically produces an access violation. The probability for this problem can be reduced by calling the SpinMessageLoop() method and sleep()ing for a few seconds.

Visual Basic で実装されたオブジェクトはこの機能についてバグを 持っているかもしれないことに注意してください。 実際に彼らのクリーンアップコードを実行するまではアンロード可能に することを拒みます。 その時点でDLLをアンロードすることは典型的には、アクセスバイオレーションを 発生させます。 この問題の可能性は SpinMessageLoop() メソッドを呼び出し、2, 3秒 sleep() することにより減らすことができます。

Win32::OLE->GetActiveObject(CLASS[, DESTRUCTOR])

The GetActiveObject() class method returns an OLE reference to a running instance of the specified OLE automation server. It returns undef if the server is not currently active. It will croak if the class is not even registered. The optional DESTRUCTOR method takes either a method name or a code reference. It is executed when the last reference to this object goes away. It is generally considered impolite to stop applications that you did not start yourself.

GetActiveObject() クラスメソッドは指定された OLE オートメーションサーバーの 動いているインスタンスへの OLE リファレンスを返します。 もしサーバーが現在アクティブでなければ、undef を返します。 そのクラス登録さえもしていなければ、croak します。 オプションの DESTRUCTOR メソッドはメソッド名、あるいはコードリファレンスを とります。 このオブジェクトへの最後のリファレンスが失われるときに実行されます。 一般的にあなたが起動したのではないアプリケーションを止めることは 一般的には無作法だと考えられます。

Win32::OLE->GetObject(MONIKER[, DESTRUCTOR])

The GetObject() class method returns an OLE reference to the specified object. The object is specified by a pathname optionally followed by additional item subcomponent separated by exclamation marks '!'. The optional DESTRUCTOR argument has the same semantics as the DESTRUCTOR in new() or GetActiveObject().

GetObject() クラスメソッドは指定されたオブジェクトへの OLE リファレンスを 返します。 そのオブジェクトはパス名で指定され、オプションで後ろに エクスクラメーションマーク '!'によって区切られた追加の要素 サブコンポーネントがつきます。 オプションの DESTRUCTOR 引数は new() や GetActiveObject() と 同じ意味を持ちます。

Win32::OLE->Initialize([COINIT])

The Initialize() class method can be used to specify an alternative apartment model for the Perl thread. It must be called before the first OLE object is created. If the Win32::OLE::Const module is used then the call to the Initialize() method must be made from a BEGIN block before the first use statement for the Win32::OLE::Const module.

Initialize() クラスメソッドは Perl スレッドのための代わりの アパートメントモデルを指定するために使えます。 これは最初の OLE オブジェクトが作成される 前 に呼ばれなければなりません。 もし Win32::OLE::Const モジュールが使われていれば、Initialize() メソッドの 呼び出しは最初の Win32::OLE::Const モジュールのための use ステートメントの前の BEGIN ブロックでされなければなりません。

Valid values for COINIT are:

COINTへの正しい値は以下の通りです:

  Win32::OLE::COINIT_APARTMENTTHREADED  - single threaded
  Win32::OLE::COINIT_MULTITHREADED      - the default
  Win32::OLE::COINIT_OLEINITIALIZE      - single threaded, additional OLE stuff

  Win32::OLE::COINIT_APARTMENTTHREADED  - シングルスレッド
  Win32::OLE::COINIT_MULTITHREADED      - デフォルト
  Win32::OLE::COINIT_OLEINITIALIZE      - シングルスレッド、追加の OLE 機能

COINIT_OLEINITIALIZE is sometimes needed when an OLE object uses additional OLE compound document technologies not available from the normal COM subsystem (for example MAPI.Session seems to require it). Both COINIT_OLEINITIALIZE and COINIT_APARTMENTTHREADED create a hidden top level window and a message queue for the Perl process. This may create problems with other application, because Perl normally doesn't process its message queue. This means programs using synchronous communication between applications (such as DDE initiation), may hang until Perl makes another OLE method call/property access or terminates. This applies to InstallShield setups and many things started to shell associations. Please try to utilize the Win32::OLE->SpinMessageLoop and Win32::OLE->Uninitialize methods if you can not use the default COINIT_MULTITHREADED model.

COINIT_OLEINITIALIZE は OLE オブジェクトが、通常の COM サブシステムでは 利用できない、追加の OLE コンパウンドドキュメント技術を使っているさいに、 ときおり必要になります(例えば MAPI セッションはこれが必要なようです)。 COINIT_OLEINITIALIZE と COINIT_APARTMENTTHREADED は隠れたトップレベル ウィンドウと Perl プロセスのためのメッセージキューを作成します。 これは他のアプリケーションとの問題を発生させるかもしれません。 というのも Perl は通常そのメッセージキューを処理しないからです。 つまりアプリケーション間で同期型通信(DDE イニシエーションのような)を 使っているプログラムは Perl が他の OLE メソッド呼び出し/プロパティアクセスを おこすか、終了するまで止まってしまうかもしれません。 これは InstallShield セットアップやシェル関連から発生する多くの事柄に あてはまります。 デフォルトの COINIT_MULTITHREADED モデルを使うことができないのであれば、 Win32::OLE->SpinMessageLoop と Win32::OLE->Uninitialize メソッドをを使ってみてください。

OBJECT->Invoke(METHOD[, ARGS])

The Invoke() object method is an alternate way to invoke OLE methods. It is normally equivalent to $OBJECT-METHOD(@ARGS)>. This function must be used if the METHOD name contains characters not valid in a Perl variable name (like foreign language characters). It can also be used to invoke the default method of an object even if the default method has not been given a name in the type library. In this case use <undef> or '' as the method name. To invoke an OLE objects native Invoke() method (if such a thing exists), please use:

Invoke() オブジェクトメソッドは OLE メソッドを呼び出す代替方法です。 これは通常 $OBJECT->METHOD(@ARGS) と同じです。 この関数は METHOD 名に Perl 変数名として正しくない文字 (例えば外国の文字) が 入っているときに使わなければなりません。 もしデフォルトのメソッドがライブラリで名前を与えられていなくても、その オブジェクトのデフォルトのメソッドを呼び出すために使えます。 この場合には undef または '' をメソッド名として使います。 OLE オブジェクトネイティブの Invoke() メソッドを (もしそのようなものが あったとして) 呼び出すためには、以下のようにします:

        $Object->Invoke('Invoke', @Args);

Win32::OLE->LastError()

The LastError() class method returns the last recorded OLE error. This is a dual value like the $! variable: in a numeric context it returns the error number and in a string context it returns the error message. The error number is a signed HRESULT value. Please use the HRESULT(ERROR) function to convert an unsigned hexadecimal constant to a signed HRESULT.

LastError() クラスメソッドは最後に記録された OLE エラーを返します。 これは $! 変数のように二つの値を持ちます: 数値コンテキストでは エラー番号を返し、文字列コンテキストではエラーメッセージを返します。 エラー番号は符号付きの HRESULT の値です。 符号なしの 16 進定数を符号付きの HRESULT に変換するためには HRESULT(ERROR) 関数を使ってください。

The last OLE error is automatically reset by a successful OLE call. The numeric value can also explicitly be set by a call (which will discard the string value):

最後の OLE エラーは、後の正常な OLE 呼び出しによって自動的にリセットされます。 数値は明示的に呼び出すことによって設定することができます(それは文字列の値を 捨てます):

        Win32::OLE->LastError(0);

OBJECT->LetProperty(NAME,ARGS,VALUE)

In Win32::OLE property assignment using the hash syntax is equivalent to the Visual Basic Set syntax (by reference assignment):

Win32::OLE では、ハッシュの書き方を使ったプロパティ設定は Visual Basic の Set と同じです(リファレンスによる 代入):

        $Object->{Property} = $OtherObject;

corresponds to this Visual Basic statement:

これは以下の Visual Basic ステートメントに対応します:

        Set Object.Property = OtherObject

To get the by value treatment of the Visual Basic Let statement

Visual Basic の Let ステートメントの 値による 扱いを得るには:

        Object.Property = OtherObject

you have to use the LetProperty() object method in Perl:

Perl では LetProperty() オブジェクトメソッドを使う必要があります:

        $Object->LetProperty($Property, $OtherObject);

LetProperty() also supports optional arguments for the property assignment. See OBJECT-SetProperty(NAME,ARGS,VALUE)> for details.

LetProperty() はプロパティ設定のためのオプションの引数もサポートしています。 詳しくは OBJECT->SetProperty(NAME,ARGS,VALUE) を参照してください。

Win32::OLE->MessageLoop()

The MessageLoop() class method will run a standard Windows message loop, dispatching messages until the QuitMessageLoop() class method is called. It is used to wait for OLE events.

MessageLoop() クラスメソッドは標準の Windows メッセージループを実行し、 QuitMessageLoop() クラスメソッドが呼ばれるまで、メッセージを処理します。 これは OLE イベントを待つために使われます。

Win32::OLE->Option(OPTION)

The Option() class method can be used to inspect and modify "Module Options". The single argument form retrieves the value of an option:

Option() クラスメソッドは "Module Options" を検査し、変更するために 使えます。 一つだけ引数を指定すると、そのオプションの値を取り出します:

        my $CP = Win32::OLE->Option('CP');

A single call can be used to set multiple options simultaneously:

一回の呼び出しで複数のオプションを同時に設定することもできます。

        Win32::OLE->Option(CP => CP_ACP, Warn => 3);

Win32::OLE->QueryObjectType(OBJECT)

The QueryObjectType() class method returns a list of the type library name and the objects class name. In a scalar context it returns the class name only. It returns undef when the type information is not available.

QueryObjectType() クラスメソッドはタイプライブラリ名と オブジェクトクラス名のリストを返します。 スカラコンテキストではそれはクラス名だけを返します。 タイプ情報が使えなければ、undef を返します。

Win32::OLE->QuitMessageLoop()

The QuitMessageLoop() class method posts a (user-level) "Quit" message to the current threads message loop. QuitMessageLoop() is typically called from an event handler. The MessageLoop() class method will return when it receives this "Quit" method.

QuitMessageLoop() クラスメソッドは(ユーザーレベルで) "Quit" メッセージを 現在のスレッドメッセージループにポストします。 QuitMessageLoop() は典型的にはイベントハンドラから呼ばれます。 MessageLoop() クラスメソッドは、この "Quit" メソッドを受け取ると、戻ります。

OBJECT->SetProperty(NAME,ARGS,VALUE)

The SetProperty() method allows to modify properties with arguments, which is not supported by the hash syntax. The hash form

SetProperty() メソッドはハッシュの書き方をサポートしていないプロパティを 引数の値に変更できます。 ハッシュ形式は以下の通りです

        $Object->{Property} = $Value;

is equivalent to

これは以下のものと同じです

        $Object->SetProperty('Property', $Value);

Arguments must be specified between the property name and the new value:

引数はプロパティ名と新しい値の間に指定されなければなりません:

        $Object->SetProperty('Property', @Args, $Value);

It is not possible to use "named argument" syntax with this function because the new value must be the last argument to SetProperty().

新しい値は SetProperty() への最後の引数でなければならないので、この関数で 「名前付き引数」の書き方を使うことはできません。

This method hides any native OLE object method called SetProperty(). The native method will still be available through the Invoke() method:

このメソッドは SetProperty() と呼ばれるネイティブな OLE オブジェクト メソッドを隠してしまいます。 そのネイティブなメソッドは Invoke() メソッドを使って呼び出すことができます:

        $Object->Invoke('SetProperty', @Args);

Win32::OLE->SpinMessageLoop

This class method retrieves all pending messages from the message queue and dispatches them to their respective window procedures. Calling this method is only necessary when not using the COINIT_MULTITHREADED model. All OLE method calls and property accesses automatically process the message queue.

このクラスメソッドはすべてのメッセージキューに保留されている メッセージを取り出し、対応する Windows プロシ−ジャーに処理させます。 このメソッドは COINIT_MULTITHREADED モデルを使っていないときにだけ 必要になります。 すべての OLE メソッド呼び出しとプロパティアクセスは自動的に メッセージキューを処理します。

Win32::OLE->Uninitialize

The Uninitialize() class method uninitializes the OLE subsystem. It also destroys the hidden top level window created by OLE for single threaded apartments. All OLE objects will become invalid after this call! It is possible to call the Initialize() class method again with a different apartment model after shutting down OLE with Uninitialize().

Uninitialize() クラスメソッドは OLE サブシステムの反初期化をします。 これはシングルスレッド分離のための OLE によって作られた隠れた トップレベルウィンドウを破壊もします。 これを呼び出した後には、すべての OLE オブジェクトが不適切になります! Uninitialize() で OLE を終了させた後、再び Initialize() クラスメソッドを 異なる分離モデルで呼び出すことは可能です。

Win32::OLE->WithEvents(OBJECT[, HANDLER[, INTERFACE]])

This class method enables and disables the firing of events by the specified OBJECT. If no HANDLER is specified, then events are disconnected. For some objects Win32::OLE is not able to automatically determine the correct event interface. In this case the INTERFACE argument must contain either the COCLASS name of the OBJECT or the name of the event DISPATCH interface. Please read the Events section below for detailed explanation of the Win32::OLE event support.

このクラスメソッドは OBJECT によって指定されたイベントを発火させるのを 可能にも不可能にもできます。 HANDLER が指定されなければ、イベントは接続されません。 いくつかのオブジェクトでは Win32::OLE は自動的に正しい イベントインターフェースを判定できません。 その場合、INTERFACE 引数は OBJECT の COCLASS 名またはイベント DISPATCH インターフェースの名前のどちらかが入っていなければなりません。 Win32::OLE イベントサポートの詳細な説明については下記の "Events" セクションをお読みださい。

Perl が Win32::OLE パッケージでメソッド名を見つけられなかった場合、それは 自動的に OLE メソッドの名前として使われます。 そしてこのメソッド呼び出しは OLE サーバーによって処理されます。

このモジュールには一つの特別な方法が組み込まれています。 もしメソッドまたはプロパティ名が OLE オブジェクトによって解決されなければ、 オブジェクトのデフォルトメソッドがそのメソッド名を第1引数として呼ばれます。 そこで

        my $Sheet = $Worksheets->Table1;

または

        my $Sheet = $Worksheets->{Table1};

は以下のように解決されます

        my $Sheet = $Worksheet->Item('Table1');

$Worksheeets オブジェクトが Table1 メソッドまたはプロパティを 持っていない場合です。 この方法はタイプライブラリではメソッドに名前をつけないコレクションの デフォルトメソッドを呼び出すために導入されています。 「名無しの」デフォルトメソッドを呼び出す推奨される方法は以下の通りです:

        my $Sheet = $Worksheets->Invoke('', 'Table1');

この特殊な方法は use strict 'subs' の元では使えません。

オブジェクトメソッドとプロパティ¶

new() メソッドによって返されるオブジェクトは、特定の OLE クラスのための ドキュメントで説明されているのと同じ形式で、メソッドを呼び出したり、 プロパティを取り出したりするのに使えます。 (例えば Microsoft Excel ドキュメントは OLE アクセスのために公開されている プロパティやメソッドを持ったオブジェクト階層について説明しています)。

メソッド呼び出しでのオプションのパラメータは undef をプレースホルダとして 使うことによって省略できます。 オプションのパラメータの順序は OLE サーバーアプリケーションの後の バージョンでは変更されてしまうかもしれないので、よりよい方法は名前付き 引数を使うことです。 名前付きパラメータはハッシュへのリファレンスをメソッド呼び出しのへの 最後のパラメータとして指定することでできます。

プロパティはハッシュの書き方を使って取得、設定できます。 メソッドは通常のperlメソッド呼び出しの書き方で呼び出すことができます。 keys と each 関数はオブジェクトのプロパティを列挙するために 使えます。 プロパティは常に書込可能そして、読込可能でさえあるわけではないことに 注意してください (時には未定義である間は読み込んだときに例外を起こすこともあります)。

もしメソッドやプロパティが埋め込まれた OLE オブジェクトを返すのであれば、 メソッドとプロパティアクセスは以下の例にあるようにチェーンされます。

関数¶

以下の関数はデフォルトではエクスポートされません。

HRESULT(ERROR)

The HRESULT() function converts an unsigned number into a signed HRESULT error value as used by OLE internally. This is necessary because Perl treats all hexadecimal constants as unsigned. To check if the last OLE function returned "Member not found" (0x80020003) you can write:

HRESULT() 関数は符号なしの数値を符号付きの OLE によって内部的に使われるような HRESULT エラー値に変換します。 これは Perl が全ての 16 進数定数を符号なしとして扱うために必要です。 最後の OLE 関数が "Member not found" (0x80020003) を返したかどうかを チェックしたければ、以下のようにすることができます:

        if (Win32::OLE->LastError == HRESULT(0x80020003)) {
            # your error recovery here
        }

in(COLLECTION)

If COLLECTION is an OLE collection object then in $COLLECTION returns a list of all members of the collection. This is a shortcut for Win32::OLE::Enum-All($COLLECTION)>. It is most commonly used in a foreach loop:

もし COLLECTION が OLE コレクンションオブジェクトであれば、 in $COLLECTION は、そのコレクションのすべての要素のリストを返します。 これは Win32::OLE::Enum->All($COLLECTION) のショートカットです。 これは一般的に foreach ループで使われます:

        foreach my $value (in $collection) {
            # do something with $value here
        }

valof(OBJECT)

Normal assignment of Perl OLE objects creates just another reference to the OLE object. The valof() function explictly dereferences the object (through the default method) and returns the value of the object.

Perl OLE オブジェクトの通常の代入は他の OLE オブジェクトへの他の リファレンスを作成します。 valof() 関数は明示的にオブジェクト(デフォルトメソッドを通じた)と オブジェクトの値を区別します。

        my $RefOf = $Object;
        my $ValOf = valof $Object;
        $Object->{Value} = $NewValue;

Now $ValOf still contains the old value wheras $RefOf would resolve to the $NewValue because it is still a reference to $Object.

いまや $ValOf はまだ古い値を持っているのに、$RefOf はまだ $Object への リファレンスなので、$NewValue を解決します。

The valof() function can also be used to convert Win32::OLE::Variant objects to Perl values.

valof() 関数は Win32::OLE::Variant オブジェクトを Perl 変数に 変換するためにも使えます。

with(OBJECT, PROPERTYNAME => VALUE, ...)

This function provides a concise way to set the values of multiple properties of an object. It iterates over its arguments doing $OBJECT-{PROPERTYNAME} = $VALUE> on each trailing pair.

この関数はあるオブジェクトの複数のプロパティを設定するための簡単な方法を 提供します。 これは後ろについている各組合わせに対して $OBJECT->{PROPERTYNAME} = $VALUE を繰り返しおこないます。

オーバーロード¶

Win32::OLE オブジェクトはブール値、数値、文字列コンテキストで 使われたときにはいつでも、自動的にそれらの値に変換するために オーバーロードできます。 これはデフォルトでは可能ではありません。 OVERLOAD 疑似エクスポートを通して要求する必要があります:

        use Win32::OLE qw(in valof with OVERLOAD);

例えばデバッグのために overload::StrVal() メソッドを使って、元の オブジェクトの文字列表現 (Win32::OLE=0xDEADBEEF) を取得することもできます:

        print overload::StrVal($object), "\n";

OVERLOAD はグローバルな設定であることに注意してください。 もしなんらかのモジュールが Win32::OLE オーバーロードを可能にすると、 それはいつでも有効です。

イベント¶

Win32::OLE モジュールは今は アルファ レベルのイベントサポートを 持っています。 このサポートは Perl がシングルスレッド分離レベルで実行しているときにだけ 利用できます。 これはとても簡単に EVENTS 疑似インポートを使うことによって、 保証することができます:

        use Win32::OLE qw(EVENTS);

これは暗黙のうちに以下のようなことをしています:

        use Win32::OLE;
        Win32::OLE->Initialize(Win32::OLE::COINIT_OLEINITIALIZE);

現在の OLE イベントへのインターフェースは実験的なものであると考えられ、 変更されやすいものです。 通常の OLE アプリケーションでは予定通りに機能しますが、OLE 制御イベントは まだうまく機能していないようです。

イベントは Win32::OLE->WithEvents() クラスメソッドを通して、 OLE オブジェクトのために明示的に可能にされなければなりません。 Win32::OLE モジュールはオブジェクトのデフォルトイベントソースを 判定するために IProvideClassInfo2 インターフェースを利用しています。 このインターフェースがサポートされていなければ、ユーザは WithEvents() メソッドで明示的にイベントソースの名前を 指定しなければなりません。 オブジェクトのクラス名を 3 番目のパラメータとして指定することも可能です。 この場合、Win32::OLE は、この COCLASS のための デフォルトソースインターフェースを見つけようとします。

Win32::OLE->WithEvents() への HANDLER 引数は CODE リファレンスまたは パッケージ名のどちらかにすることができます。 前者の場合、すべてのイベントはこの特定の関数を呼び出します。 この関数への最初の二つの引数は OBJECT そのものとイベントの名前になります。 残りの引数はイベントによります:

        sub Event {
            my ($Obj,$Event,@Args) = @_;
            print "Event triggered: '$Event'\n";
        }
        Win32::OLE->WithEvents($Obj, \&Event);

代わりに HANDLER 引数がパッケージ名を指定できます。 OBJECT がイベントを発火したとき、Win32::OLE は、このパッケージでイベントと 同じ名前の関数を見つけようとします。 この関数は OBJECT を最初の引数とし、イベント特有のパラメータが後ろについて 呼び出されます:

        package MyEvents;
        sub EventName1 {
            my ($Obj,@Args) = @_;
            print "EventName1 event triggered\n";
        }

        package main;
        Win32::OLE->WithEvents($Obj, 'MyEvents', 'IEventInterface');

Win32::OLE がイベント名の関数を見つけなければ、何も起こりません。

リファレンスによって 渡されたイベントパラメータは特別に扱われます。 これらは対応する Perl データ型に変換されず、 Win32::OLE::Variant オブジェクトとして渡されます。 これらのオブジェクトに Put() メソッドの助けを借りて新しい値を 代入できます。 この値はイベント関数が戻るとき、オブジェクトに戻されます:

        package MyEvents;
        sub BeforeClose {
            my ($self,$Cancel) = @_;
            $Cancel->Put(1) unless $MayClose;
        }

$Cancel への直接の代入は元の値に何も影響を与えません。 そしてこのためオブジェクトにアクションを閉じるのを中止させるように命令しません。

モジュールオプション¶

以下のモジュールオプションは Win32::OLE->Option クラスメソッドで アクセス、変更できます。 Win32::OLE モジュールの始めのころのバージョンでは、これらのオプションは クラス変数として直接操作されました。 この実装は今では廃止予定です:

CP

This variable is used to determine the codepage used by all translations between Perl strings and Unicode strings used by the OLE interface. The default value is CP_ACP, which is the default ANSI codepage. Other possible values are CP_OEMCP, CP_MACCP, CP_UTF7 and CP_UTF8. These constants are not exported by default.

この変数は Perl 文字列と OLE インターフェースによって使われる Unicode 文字列の 間のすべての変換によって使われるコードページです。 デフォルトの値は CP_ACP です。 これはデフォルトの ANSI コードページです。 他に可能な値は、CP_OEMCP, CP_MACCP, CP_UTF7, CP_UTF8 です。 これらの定数はデフォルトではエクスポートされません。

LCID

This variable controls the locale idnetifier used for all OLE calls. It is set to LOCALE_NEUTRAL by default. Please check the Win32::OLE::NLS module for other locale related information.

この変数は全ての OLE 呼び出しに使われるロケール識別子を制御します。 それはデフォルトでは LOCALE_NEUTRAL に設定されます。 他のロケール関連情報については Win32::OLE::NLS モジュールを チェックしてください。

Warn

This variable determines the behavior of the Win32::OLE module when an error happens. Valid values are:

この変数はエラーが発生したときの Win32::OLE モジュールの動きを決定します。 適切な値は以下の通りです:

        0       Ignore error, return undef
        1       Carp::carp if $^W is set (-w option)
        2       always Carp::carp
        3       Carp::croak

        0       エラーを無視して undef を返す
        1       $^W が設定されていれば(-w オプション)Carp::carp
        2       常に Carp::carp
        3       Carp::croak

The error number and message (without Carp line/module info) are available through the Win32::OLE-LastError> class method.

エラー番号とメッセージ(Carp 行/モジュール情報は無し)は Win32::OLE-LastError> クラスメソッドを通して利用できます。

Alternatively the Warn option can be set to a CODE reference. E.g.

代わりに CODE リファレンスに Warn オプションを設定できます。 例えば

    Win32::OLE->Option(Warn => 3);

is equivalent to

これは以下のものと同じです。

    Win32::OLE->Option(Warn => \&Carp::croak);

This can even be used to emulate the VisualBasic On Error Goto Label construct:

これは VisualBasic の On Error Goto Label 構造をエミュレートするために 使うことさえもできます:

    Win32::OLE->Option(Warn =>  sub {goto CheckError});
    # ... your normal OLE code here ...

  CheckError:
    # ... your error handling code here ...

_NewEnum

This option enables additional enumeration support for collection objects. When the _NewEnum option is set, all collections will receive one additional property: _NewEnum. The value of this property will be a reference to an array containing all the elements of the collection. This option can be useful when used in conjunction with an automatic tree traversal program, like Data::Dumper or an object tree browser. The value of this option should be either 1 (enabled) or 0 (disabled, default).

このオプションはコレクションオブジェクトのための追加の列挙子のサポートを 可能にします。 _NewEnum オプションが設定されたとき、すべてのコレクションは一つの 追加のプロパティ: _NewEnum を受け取ります。 このプロパティの値はコレクションのすべての要素が入った配列への リファレンスになります。 このオプションは Data::Dumper やオブジェクトツリーブラウザのような 自動的なツリー構造横断プログラムと一緒に使うときに便利でしょう。 このオプションの値は1(有効)または0(無効、デフォルト)でなければなりません。

    Win32::OLE->Option(_NewEnum => 1);
    # ...
    my @sheets = @{$Excel->Worksheets->{_NewEnum}};

In normal application code, this would be better written as:

通常のアプリケーションコードでは、これは以下のように書いた方がよいでしょう:

    use Win32::OLE qw(in);
    # ...
    my @sheets = in $Excel->Worksheets;

_Unique

The _Unique options guarantees that Win32::OLE will maintain a one-to-one mapping between Win32::OLE objects and the native COM/OLE objects. Without this option, you can query the same property twice and get two different Win32::OLE objects for the same underlying COM object.

_Unique オプションは Win32::OLE がネイティブの COM/OLE オブジェクトと 1 対 1 のマッピングを維持することを保証します。 このオプションがないと、元になっている同じ COM オブジェクトのために異なる Win32::OLE オブジェクトを取得し、同じプロパティを重複して 問い合わせることになりかねません。

Using a unique proxy makes life easier for tree traversal algorithms to recognize they already visited a particular node. This option comes at a price: Win32::OLE has to maintain a global hash of all outstanding objects and their corresponding proxies. Identity checks on COM objects can also be expensive if the objects reside out-of-process or even on a different computer. Therefore this option is off by default unless the program is being run in the debugger.

ユニークプロキシーを使うと、特定のノードを既に訪れたことを 理解するためのツリー構造横断アルゴリズムは簡単になります。 このオプションは大きな犠牲を払います: Win32::OLE がすべての存在する オブジェクトと対応するプロキシーのグローバルなハッシュと 維持しなければなりません。 オブジェクトがプロセスの外側に、あるいは異なるコンピュータにあったりしたら、 COM オブジェクトの識別子チェックも同様に高価になりかねません。 このためこのオプションはプログラムがデバッガで実行されるのでなければ、 デフォルトではオフです。

Unfortunately, this option doesn't always help. Some programs will return new COM objects for even the same property when asked for it multiple times (especially for collections). In this case, there is nothing Win32::OLE can do to detect that these objects are in fact identical (because they aren't at the COM level).

残念ながら、このオプションは常に助けにはなりません。 いくつかのプログラムは同じプロパティであってさえも、何度も聞くと新しい COM オブジェクトを返すことがあります(特にコレクションについては)。 この場合、これらのオブジェクトが事実上同じであると見分けるために Win32::OLE ができることは何もありません(というのもそれは COM レベルでは ないからです)。

The _Unique option can be set to either 1 (enabled) or 0 (disabled, default).

_Unique オプションは1(有効)または0(無効、デフォルト)のどちらかに 設定できます。

例¶

これは簡単な Microsoft Excel アプリケーションです。

        use Win32::OLE;

        # use existing instance if Excel is already running
        eval {$ex = Win32::OLE->GetActiveObject('Excel.Application')};
        die "Excel not installed" if $@;
        unless (defined $ex) {
            $ex = Win32::OLE->new('Excel.Application', sub {$_[0]->Quit;})
                    or die "Oops, cannot start Excel";
        }

        # get a new workbook
        $book = $ex->Workbooks->Add;

        # write to a particular cell
        $sheet = $book->Worksheets(1);
        $sheet->Cells(1,1)->{Value} = "foo";

        # write a 2 rows by 3 columns range
        $sheet->Range("A8:C9")->{Value} = [[ undef, 'Xyzzy', 'Plugh' ],
                                           [ 42,    'Perl',  3.1415  ]];

        # print "XyzzyPerl"
        $array = $sheet->Range("A8:C9")->{Value};
        for (@$array) {
            for (@$_) {
                print defined($_) ? "$_|" : "<undef>|";
            }
            print "\n";
        }

        # save and exit
        $book->SaveAs( 'test.xls' );
        undef $book;
        undef $ex;

Win32::OLE->new メソッドでデストラクタが指定されていることに 注意してください。 これは Perl プログラムが死んだときでさえも、Excel が適切に終了されることを 保証します。 そうでなければ Excel の OLE インスタンスが開いたあとで、アプリケーションが die とプロセスリークになりかねません。 OLE オブジェクトが確実に適切に片づけられるようにするのはモジュール利用者の 責任です!

以下は Variant データ型を使った例です。

        use Win32::OLE;
        use Win32::OLE::Variant;
        $ex = Win32::OLE->new('Excel.Application', \&OleQuit) or die "oops\n";
        $ex->{Visible} = 1;
        $ex->Workbooks->Add;
        # should generate a warning under -w
        $ovR8 = Variant(VT_R8, "3 is a good number");
        $ex->Range("A1")->{Value} = $ovR8;
        $ex->Range("A2")->{Value} = Variant(VT_DATE, 'Jan 1,1970');

        sub OleQuit {
            my $self = shift;
            $self->Quit;
        }

上記では文字列は "3 is a good number" ではなく、"3" をセル A1 に入れます。 セル A2 は日付を持ちます:

同様に、バイナリデータでメソッドを呼び出すためには、以下のようにできます:

        $obj->Method( Variant(VT_UI1, "foo\000b\001a\002r") );

以下のものは基本的に new() と DESTROY() を除いたすべてを委任する ラッパークラスです。 下記のラッパークラスは、アプリケーションが適切なクリーンアップなしに 死ぬことが免れないときに、接続を適切に終らせるもう一つの方法です。 あなた自身のラッパーは、独自に確証したいメソッドを オーバーライドするといったように、おそらくあなたの扱いたい特定の OLE オブジェクトにより特化したようなことをするでしょう。

        package Excel;
        use Win32::OLE;

        sub new {
            my $s = {};
            if ($s->{Ex} = Win32::OLE->new('Excel.Application')) {
                return bless $s, shift;
            }
            return undef;
        }

        sub DESTROY {
            my $s = shift;
            if (exists $s->{Ex}) {
                print "# closing connection\n";
                $s->{Ex}->Quit;
                return undef;
            }
        }

        sub AUTOLOAD {
            my $s = shift;
            $AUTOLOAD =~ s/^.*:://;
            $s->{Ex}->$AUTOLOAD(@_);
        }

        1;

上記のモジュールは、異常終了の際に接続を閉じるように気をつけてくれる点を 除いて、Win32::OLE とまったく同じように使えます。 この特定の例の効果は Win32::OLE::new のデストラクタ引数を使うことによって、 より簡単に実現できるということに注意してください:

        my $Excel = Win32::OLE->new('Excel.Application', sub {$_[0]->Quit;});

上記の例での委任は特化されたオブジェクトでのメソッド呼び出しのさらなる 継承への見方と同じではないことに注意してください。 詳細については perlobj, perltoot, perlbot をご覧ください。 本当のサブクラスか(@ISA を設定することによって利用できることになる)も、 以下のデモンストレーションのように可能です:

        #
        # Add error reporting to Win32::OLE
        #

        package Win32::OLE::Strict;
        use Carp;
        use Win32::OLE;

        use strict qw(vars);
        use vars qw($AUTOLOAD @ISA);
        @ISA = qw(Win32::OLE);

        sub AUTOLOAD {
            my $obj = shift;
            $AUTOLOAD =~ s/^.*:://;
            my $meth = $AUTOLOAD;
            $AUTOLOAD = "SUPER::" . $AUTOLOAD;
            my $retval = $obj->$AUTOLOAD(@_);
            unless (defined($retval) || $AUTOLOAD eq 'DESTROY') {
                my $err = Win32::OLE::LastError();
                croak(sprintf("$meth returned OLE error 0x%08x",$err))
                  if $err;
            }
            return $retval;
        }

        1;

このパッケージはコンストラクラ new() を Win32::OLE パッケージから 継承しています。 パッケージについての情報がオブジェクトによってキャッシュされるために Win32::OLE を再び bless することはできないことに注意しすることは 大切なことです。 常に正しいパッケージを通して、new() コンストラクタを呼び出してください!

以下に上記のクラスがどのように使われるかを示します:

        use Win32::OLE::Strict;
        my $Excel = Win32::OLE::Strict->new('Excel.Application', 'Quit');
        my $Books = $Excel->Workbooks;
        $Books->UnknownMethod(42);

上記のサンプルで UnknownMethod() を呼び出すと、それは以下のように 捕らえられます:

        UnknownMethod returned OLE error 0x80020009 at test.pl line 5

というのも Workbooks オブジェクトは $Excel オブジェクトから Win32::OLE::Strict クラスを継承しているからです。

注意¶

Microsoft Office オートメーションのためのヒント¶

Documentation

(ドキュメント)

The object model for the Office applications is defined in the Visual Basic reference guides for the various applications. These are typically not installed by default during the standard installation. They can be added later by rerunning the setup program with the custom install option.

Office アプリケーションのオブジェクトモデルは、多くのアプリケーションのための Visual Basic リファレンスガイドで定義されています。 これらは典型的には、標準インストールによってデフォルトで インストールされません。 これらはセットアッププログラムをカスタムインストールオプションで 実行することによって後から追加できます。

Class, Method and Property names

(クラス、メソッド、プロパティ名)

The names have been changed between different versions of Office. For example Application was a method in Office 95 and is a property in Office97. Therefore it will not show up in the list of property names keys %$object when querying an Office 95 object.

Office のバージョンによっては名前は変更されています。 例えば Office95 では Application はメソッドでしたが、Office97 では プロパティです。 このため Office95 オブジェクトに問い合わせたときには、keys %$object による プロパティ名のリストには現れません。

The class names are not always identical to the method/property names producing the object. E.g. the Workbook method returns an object of type Workbook in Office 95 and _Workbook in Office 97.

クラス名はそのオブジェクトを作るメソッド/プロパティ名と常に 同じではありません。 例えば Workbook メソッドは Office95 では Workbook オブジェクトを 返しますが、Office97 では _Workbook を返します。

Moniker (GetObject support)

(モニカ (GetObject サポート))

Office applications seem to implement file monikers only. For example it seems to be impossible to retrieve a specific worksheet object through GetObject("File.XLS!Sheet"). Furthermore, in Excel 95 the moniker starts a Worksheet object and in Excel 97 it returns a Workbook object. You can use either the Win32::OLE::QueryObjectType class method or the $object->{Version} property to write portable code.

Office アプリケーションはファイルモニカだけを実装しているようです。 例えば GetObject("File.XLS!Sheet") を通してあるワークシートオブジェクトを 取り出すことはできないようです。 さらに Excel95 ではモニカは Worksheet オブジェクトを開始し、Excel97 では Workbook オブジェクトを返します。 移植性のあるコードを書くためには、Win32::OLE::QueryObjectType クラスメソッドまたは $object->{Version} のどちらかかを使えます。

Enumeration of collection objects

(コレクションオブジェクトの列挙)

Enumerations seem to be incompletely implemented. Office 95 application don't seem to support neither the Reset() nor the Clone() methods. The Clone() method is still unimplemented in Office 97. A single walk through the collection similar to Visual Basics for each construct does work however.

列挙は不完全にしか実装されていないようです。 Office95 アプリケーションは Reset() も Clone() メソッドも サポートしていないようです。 Clone() メソッドは Office97 でも未実装です。 しかしながら、Visual Basic の for each 構造と同じようにコレクションを 一通りみるのは動作します。

Localization

(地域化)

Starting with Office 97 Microsoft has changed the localized class, method and property names back into English. Note that string, date and currency arguments are still subject to locale specific interpretation. Perl uses the system default locale for all OLE transaction whereas Visual Basic uses a type library specific locale. A Visual Basic script would use "R1C1" in string arguments to specify relative references. A Perl script running on a German language Windows would have to use "Z1S1". Set the LCID module option to an English locale to write portable scripts. This variable should not be changed after creating the OLE objects; some methods seem to randomly fail if the locale is changed on the fly.

Office97 から Microsoft はローカライズされたクラス、メソッド、プロパティ名を 変更し、英語に戻しました。 日付と通貨引数はまだ地域特有の解釈の対象となっていることに注意してください。 Visual Basic がタイプライブラリ特有のロケールを使うのに対し、Perl は すべての OLE トランザクションのためにシステムデフォルトロケールを 利用します。 VisualBasic スクリプトは相対的な参照を指定するために文字列引数として "R1C1" を使うでしょう。 ドイツ語 Windows で実行される Perl スクリプトは "Z1S1" を 使わなければなりません。 移植性のあるスクリプトを書くためには、LCID モジュールオプションを English ロケールに設定してください。 この変数は OLE オブジェクトを作成した後に変更するべきではありません; 途中でロケールが変更されると、メソッドによっては出たらめに失敗するようです。

SaveAs method in Word 97 doesn't work

(Word97 での SaveAs メソッドは機能しません)

This is an known bug in Word 97. Search the MS knowledge base for Word / Foxpro incompatibility. That problem applies to the Perl OLE interface as well. A workaround is to use the WordBasic compatibility object. It doesn't support all the options of the native method though.

これは Word97 でのバグであることがわかっています。 Word / Foxpro の非非互換性については MS knowledge base を検索してください。 その問題は Perl OLE インターフェースにも同じように当てはまります。 回避する方法は WordBasic 互換のオブジェクトを使うことです。 しかしそれはネイティブなメソッドのすべてのオプションを サポートしているわけではありません。

    $Word->WordBasic->FileSaveAs($file);

The problem seems to be fixed by applying the Office 97 Service Release 1.

この問題は Office97 サービスリリース 1 を適用することにより 修正されるようです。

Randomly failing method calls

(メソッド呼出しがでたらめに失敗する)

It seems like modifying objects that are not selected/activated is sometimes fragile. Most of these problems go away if the chart/sheet/document is selected or activated before being manipulated (just like an interactive user would automatically do it).

選択/アクティブにされていないオブジェクトを変更することは時折、 壊れやすいようです。 これらのほとんどの問題は、操作される前にグラフ/シート/ドキュメントを 選択あるいは、アクティブにしておくことによりなくなるようです(まるで対話的な ユーザーが自動的にしているかのように)。

非互換性¶

Activeware によって(build 306 として)配布されたバージョンとはいくつかの点で 互換性がありません。

1. The package name has changed from "OLE" to "Win32::OLE".

   パッケージの名前が "OLE" から "Win32::OLE" に変更されました。

2. All functions of the form "Win32::OLEFoo" are now "Win32::OLE::Foo", though the old names are temporarily accomodated. Win32::OLECreateObject() was changed to Win32::OLE::CreateObject(), and is now called Win32::OLE::new() bowing to established convention for naming constructors. The old names should be considered deprecated, and will be removed in the next version.

   古い名前が一時的に使えても、"Win32::OLEFoo" という形式の関数は、いまは すべて "Win32::OLE::Foo" です。 Win32::OLECreateObject() は Win32::OLE::CreateObject() に変更され、 確立された名前付きのコンストラクタの書き方に向けて Win32::OLE::new() と 呼ばれます。 古い名前は廃止予定と考えるべきです; そして次のバージョンでは 削除されるでしょう。

3. Package "OLE::Variant" is now "Win32::OLE::Variant".

   パッケージ "OLE::Varinat" は今では "Win32::OLE::Variant" です。

4. The Variant function is new, and is exported by default. So are all the VT_XXX type constants.

   Variant 関数は新しく、デフォルトでエクスポートされます。 すべての VT_XXX タイプ定数も同様です。

5. The support for collection objects has been moved into the package Win32::OLE::Enum. The keys %$object method is now used to enumerate the properties of the object.

   コレクションオブジェクトのサポートは Win32::OLE::Enum パッケージに 移りました。 keys %$object メソッドは今はオブジェクトのプロパティを列挙するために 使われます。

バグと制約¶

• To invoke a native OLE method with the same name as one of the Win32::OLE methods (Dispatch, Invoke, SetProperty, DESTROY, etc.), you have to use the Invoke method:

  Win32::OLE メソッドと同じ名前(Dispatch, Invoke, SetProperty, DESTROY など)のネイティブな OLE メソッドを呼び出すためには、Invoke を 使う必要があります:

          $Object->Invoke('Dispatch', @AdditionalArgs);

  The same is true for names exported by the Exporter or the Dynaloader modules, e.g.: export, export_to_level, import, _push_tags, export_tags, export_ok_tags, export_fail, require_version, dl_load_flags, croak, bootstrap, dl_findfile, dl_expandspec, dl_find_symbol_anywhere, dl_load_file, dl_find_symbol, dl_undef_symbols, dl_install_xsub and dl_error.

  同じことが Exporter または Dynaloader モジュールによってエクスポートされる 名前についてもあてはまります。 例えば: export, export_to_level, import, _push_tags, export_tags, export_ok_tags, export_fail, require_version, dl_load_flags, croak, bootstrap, dl_findfile, dl_expandspec, dl_find_symbol_anywhere, dl_load_file, dl_find_symbol, dl_undef_symbols, dl_install_xsub, dl_error

SEE ALSO¶

Win32::OLE::Const, Win32::OLE::Enum, Win32::OLE::NLS, Win32::OLE::Variant のドキュメントには Win32 上の Perl のための 追加の OLE サポートについての情報が入っています。

作者¶

Originally put together by the kind people at Hip and Activeware.

Gurusamy Sarathy <gsar@activestate.com> subsequently fixed several major bugs, memory leaks, and reliability problems, along with some redesign of the code.

Jan Dubois <jand@activestate.com> pitched in with yet more massive redesign, added support for named parameters, and other significant enhancements. He's been hacking on it ever since.

Please send questions about problems with this module to the Perl-Win32-Users mailinglist at ActiveState.com. The mailinglist charter requests that you put an [OLE] tag somewhere on the subject line (for OLE related questions only, of course).

コピーライト¶

    (c) 1995 Microsoft Corporation. All rights reserved.
    Developed by ActiveWare Internet Corp., now known as
    ActiveState Tool Corp., http://www.ActiveState.com

    Other modifications Copyright (c) 1997-2000 by Gurusamy Sarathy
    <gsar@activestate.com> and Jan Dubois <jand@activestate.com>

    You may distribute under the terms of either the GNU General Public
    License or the Artistic License, as specified in the README file.

VERSION¶

Version 0.1502 7 September 2001