home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _e35295c77971e145ba17acee34149670 < prev    next >
Text File  |  2000-03-15  |  31KB  |  864 lines

  1. # The documentation is at the __END__
  2.  
  3. package Win32::OLE;
  4.  
  5. use strict;
  6. use vars qw($VERSION @ISA @EXPORT @EXPORT_OK @EXPORT_FAIL $AUTOLOAD
  7.         $CP $LCID $Warn $LastError);
  8.  
  9. $VERSION = '0.1101';
  10.  
  11. use Carp;
  12. use Exporter;
  13. use DynaLoader;
  14. @ISA = qw(Exporter DynaLoader);
  15.  
  16. @EXPORT = qw();
  17. @EXPORT_OK = qw(in valof with HRESULT EVENTS OVERLOAD
  18.                 CP_ACP CP_OEMCP CP_MACCP CP_UTF7 CP_UTF8
  19.         DISPATCH_METHOD DISPATCH_PROPERTYGET
  20.         DISPATCH_PROPERTYPUT DISPATCH_PROPERTYPUTREF);
  21. @EXPORT_FAIL = qw(EVENTS OVERLOAD);
  22.  
  23. sub export_fail {
  24.     shift;
  25.     my @unknown;
  26.     while (@_) {
  27.     my $symbol = shift;
  28.     if ($symbol eq 'OVERLOAD') {
  29.         eval <<'OVERLOAD';
  30.             use overload '""'     => \&valof,
  31.                          '0+'     => \&valof,
  32.                          fallback => 1;
  33. OVERLOAD
  34.     }
  35.     elsif ($symbol eq 'EVENTS') {
  36.         Win32::OLE->Initialize(Win32::OLE::COINIT_OLEINITIALIZE());
  37.     }
  38.     else {
  39.         push @unknown, $symbol;
  40.     }
  41.     }
  42.     return @unknown;
  43. }
  44.  
  45. unless (defined &Dispatch) {
  46.     # Use regular DynaLoader if XS part is not yet initialized
  47.     bootstrap Win32::OLE;
  48.     require Win32::OLE::Lite;
  49. }
  50.  
  51. 1;
  52.  
  53. ########################################################################
  54.  
  55. __END__
  56.  
  57. =head1 NAME
  58.  
  59. Win32::OLE - OLE Automation extensions
  60.  
  61. =head1 SYNOPSIS
  62.  
  63.     $ex = Win32::OLE->new('Excel.Application') or die "oops\n";
  64.     $ex->Amethod("arg")->Bmethod->{'Property'} = "foo";
  65.     $ex->Cmethod(undef,undef,$Arg3);
  66.     $ex->Dmethod($RequiredArg1, {NamedArg1 => $Value1, NamedArg2 => $Value2});
  67.  
  68.     $wd = Win32::OLE->GetObject("D:\\Data\\Message.doc");
  69.     $xl = Win32::OLE->GetActiveObject("Excel.Application");
  70.  
  71. =head1 DESCRIPTION
  72.  
  73. This module provides an interface to OLE Automation from Perl.
  74. OLE Automation brings VisualBasic like scripting capabilities and
  75. offers powerful extensibility and the ability to control many Win32
  76. applications from Perl scripts.
  77.  
  78. The Win32::OLE module uses the IDispatch interface exclusively.  It is
  79. not possible to access a custom OLE interface.  OLE events and OCX's are
  80. currently not supported.
  81.  
  82. Actually, that's no longer strictly true.  This module now contains
  83. B<ALPHA> level support for OLE events.  This is largely untested and the
  84. specific interface might still change in the future.
  85.  
  86. =head2 Methods
  87.  
  88. =over 8
  89.  
  90. =item Win32::OLE->new(PROGID[, DESTRUCTOR])
  91.  
  92. The new() class method starts a new instance of an OLE Automation object.
  93. It returns a reference to this object or C<undef> if the creation failed.
  94.  
  95. The PROGID argument must be either the OLE I<program id> or the I<class id>
  96. of the required application.  The optional DESTRUCTOR specifies a DESTROY-like
  97. method.  This can be either a CODE reference or a string containing an OLE
  98. method name.  It can be used to cleanly terminate OLE applications in case the
  99. Perl program dies.
  100.  
  101. To create an object via DCOM on a remote server you can use an array
  102. reference in place of PROGID.  The referenced array must contain the
  103. machine name and the I<program id> or I<class id>.  For example:
  104.  
  105.     my $obj = Win32::OLE->new(['my.machine.com', 'Program.Id']);
  106.  
  107. If the PROGID is a I<program id> then Win32::OLE will try to resolve the
  108. corresponding I<class id> locally.  If the I<program id> is not registered
  109. locally then the remote registry is queried.  This will only succeed if
  110. the local process has read access to the remote registry.  The safest
  111. (and fastest) method is to specify the C<class id> directly.
  112.  
  113. =item Win32::OLE->EnumAllObjects([CALLBACK])
  114.  
  115. This class method returns the number Win32::OLE objects currently in
  116. existance.  It will call the optional CALLBACK function for each of
  117. these objects:
  118.  
  119.     $Count = Win32::OLE->EnumAllObjects(sub {
  120.         my $Object = shift;
  121.         my $Class = Win32::OLE->QueryObjectType($Object);
  122.         printf "# Object=%s Class=%s\n", $Object, $Class;
  123.     });
  124.  
  125. The EnumAllObjects() method is primarily a debugging tool.  It can be
  126. used e.g. in an END block to check if all external connections have
  127. been properly destroyed.
  128.  
  129. =item Win32::OLE->GetActiveObject(CLASS[, DESTRUCTOR])
  130.  
  131. The GetActiveObject() class method returns an OLE reference to a
  132. running instance of the specified OLE automation server.  It returns
  133. C<undef> if the server is not currently active.  It will croak if
  134. the class is not even registered.  The optional DESTRUCTOR method takes
  135. either a method name or a code reference.  It is executed when the last
  136. reference to this object goes away.  It is generally considered C<impolite>
  137. to stop applications that you did not start yourself.
  138.  
  139. =item Win32::OLE->GetObject(MONIKER[, DESTRUCTOR])
  140.  
  141. The GetObject() class method returns an OLE reference to the specified
  142. object.  The object is specified by a pathname optionally followed by
  143. additional item subcomponent separated by exclamation marks '!'.  The
  144. optional DESTRUCTOR argument has the same semantics as the DESTRUCTOR in
  145. new() or GetActiveObject().
  146.  
  147. =item Win32::OLE->Initialize([COINIT])
  148.  
  149. The Initialize() class method can be used to specify an alternative
  150. apartment model for the Perl thread.  It must be called B<before> the
  151. first OLE object is created.  If the C<Win32::OLE::Const> module is
  152. used then the call to the Initialize() method must be made from a BEGIN
  153. block before the first C<use> statement for the C<Win32::OLE::Const>
  154. module.
  155.  
  156. Valid values for COINIT are:
  157.  
  158.   Win32::OLE::COINIT_APARTMENTTHREADED  - single threaded
  159.   Win32::OLE::COINIT_MULTITHREADED      - the default
  160.   Win32::OLE::COINIT_OLEINITIALIZE      - single threaded, additional OLE stuff
  161.  
  162. COINIT_OLEINITIALIZE is sometimes needed when an OLE object uses
  163. additional OLE compound document technologies not available from the
  164. normal COM subsystem (for example MAPI.Session seems to require it).
  165. Both COINIT_OLEINITIALIZE and COINIT_APARTMENTTHREADED create a hidden
  166. top level window and a message queue for the Perl process.  This may
  167. create problems with other application, because Perl normally doesn't
  168. process its message queue.  This means programs using synchronous
  169. communication between applications (such as DDE initiation), may hang
  170. until Perl makes another OLE method call/property access or terminates.
  171. This applies to InstallShield setups and many things started to shell
  172. associations.  Please try to utilize the C<Win32::OLE-E<gt>SpinMessageLoop>
  173. and C<Win32::OLE-E<gt>Uninitialize> methods if you can not use the default
  174. COINIT_MULTITHREADED model.
  175.  
  176. =item OBJECT->Invoke(METHOD[, ARGS])
  177.  
  178. The Invoke() object method is an alternate way to invoke OLE
  179. methods.  It is normally equivalent to C<$OBJECT->METHOD(@ARGS)>.  This
  180. function must be used if the METHOD name contains characters not valid
  181. in a Perl variable name (like foreign language characters).  It can
  182. also be used to invoke the default method of an object even if the
  183. default method has not been given a name in the type library.  In this
  184. case use <undef> or C<''> as the method name.  To invoke an OLE objects
  185. native Invoke() method (if such a thing exists), please use:
  186.  
  187.     $Object->Invoke('Invoke', @Args);
  188.  
  189. =item Win32::OLE->LastError()
  190.  
  191. The LastError() class method returns the last recorded OLE
  192. error.  This is a dual value like the C<$!> variable: in a numeric
  193. context it returns the error number and in a string context it returns
  194. the error message.  The error number is a signed HRESULT value.  Please
  195. use the L<HRESULT(ERROR)> function to convert an unsigned hexadecimal
  196. constant to a signed HRESULT.
  197.  
  198. The last OLE error is automatically reset by a successful OLE
  199. call.  The numeric value can also explicitly be set by a call (which will
  200. discard the string value):
  201.  
  202.     Win32::OLE->LastError(0);
  203.  
  204. =item OBJECT->LetProperty(NAME,ARGS,VALUE)
  205.  
  206. In Win32::OLE property assignment using the hash syntax is equivalent
  207. to the Visual Basic C<Set> syntax (I<by reference> assignment):
  208.  
  209.     $Object->{Property} = $OtherObject;
  210.  
  211. corresponds to this Visual Basic statement:
  212.  
  213.     Set Object.Property = OtherObject
  214.  
  215. To get the I<by value> treatment of the Visual Basic C<Let> statement
  216.  
  217.     Object.Property = OtherObject
  218.  
  219. you have to use the LetProperty() object method in Perl:
  220.  
  221.     $Object->LetProperty($Property, $OtherObject);
  222.  
  223. LetProperty() also supports optional arguments for the property assignment.
  224. See L<OBJECT->SetProperty(NAME,ARGS,VALUE)> for details.
  225.  
  226. =item Win32::OLE->Option(OPTION)
  227.  
  228. The Option() class method can be used to inspect and modify
  229. L<Module Options>.  The single argument form retrieves the value of
  230. an option:
  231.  
  232.     my $CP = Win32::OLE->Option('CP');
  233.  
  234. A single call can be used to set multiple options simultaneously:
  235.  
  236.     Win32::OLE->Option(CP => CP_ACP, Warn => 3);
  237.  
  238. =item Win32::OLE->QueryObjectType(OBJECT)
  239.  
  240. The QueryObjectType() class method returns a list of the type library
  241. name and the objects class name.  In a scalar context it returns the
  242. class name only.  It returns C<undef> when the type information is not
  243. available.
  244.  
  245. =item OBJECT->SetProperty(NAME,ARGS,VALUE)
  246.  
  247. The SetProperty() method allows to modify properties with arguments,
  248. which is not supported by the hash syntax.  The hash form
  249.  
  250.     $Object->{Property} = $Value;
  251.  
  252. is equivalent to
  253.  
  254.     $Object->SetProperty('Property', $Value);
  255.  
  256. Arguments must be specified between the property name and the new value:
  257.  
  258.     $Object->SetProperty('Property', @Args, $Value);
  259.  
  260. It is not possible to use "named argument" syntax with this function
  261. because the new value must be the last argument to SetProperty().
  262.  
  263. This method hides any native OLE object method called SetProperty().
  264. The native method will still be available through the Invoke() method:
  265.  
  266.     $Object->Invoke('SetProperty', @Args);
  267.  
  268. =item Win32::OLE->SpinMessageLoop
  269.  
  270. This class method retrieves all pending messages from the message queue
  271. and dispatches them to their respective window procedures.  Calling this
  272. method is only necessary when not using the COINIT_MULTITHREADED model.
  273. All OLE method calls and property accesses automatically process the
  274. message queue.
  275.  
  276. =item Win32::OLE->Uninitialize
  277.  
  278. The Uninitialize() class method uninitializes the OLE subsystem.  It
  279. also destroys the hidden top level window created by OLE for single
  280. threaded apartments.  All OLE objects will become invalid after this call!
  281. It is possible to call the Initialize() class method again with a different
  282. apartment model after shutting down OLE with Uninitialize().
  283.  
  284. =item Win32::OLE->WithEvents(OBJECT[, HANDLER[, INTERFACE]])
  285.  
  286. This class method enables and disables the firing of events by the
  287. specified OBJECT.  If no HANDLER is specified, then events are
  288. disconnected.  For some objects Win32::OLE is not able to
  289. automatically determine the correct event interface.  In this case the
  290. INTERFACE argument must contain either the COCLASS name of the OBJECT
  291. or the name of the event DISPATCH interface.  Please read the L<Events>
  292. section below for detailed explanation of the Win32::OLE event
  293. support.
  294.  
  295. =back
  296.  
  297. Whenever Perl does not find a method name in the Win32::OLE package it
  298. is automatically used as the name of an OLE method and this method call
  299. is dispatched to the OLE server.
  300.  
  301. There is one special hack built into the module: If a method or property
  302. name could not be resolved with the OLE object, then the default method
  303. of the object is called with the method name as its first parameter.  So
  304.  
  305.     my $Sheet = $Worksheets->Table1;
  306. or
  307.     my $Sheet = $Worksheets->{Table1};
  308.  
  309. is resolved as
  310.  
  311.     my $Sheet = $Worksheet->Item('Table1');
  312.  
  313. provided that the $Worksheets object doesnot have a C<Table1> method
  314. or property.  This hack has been introduced to call the default method
  315. of collections which did not name the method in their type library.  The
  316. recommended way to call the "unnamed" default method is:
  317.  
  318.     my $Sheet = $Worksheets->Invoke('', 'Table1');
  319.  
  320. This special hack is disabled under C<use strict 'subs';>.
  321.  
  322. =head2 Object methods and properties
  323.  
  324. The object returned by the new() method can be used to invoke
  325. methods or retrieve properties in the same fashion as described
  326. in the documentation for the particular OLE class (eg. Microsoft
  327. Excel documentation describes the object hierarchy along with the
  328. properties and methods exposed for OLE access).
  329.  
  330. Optional parameters on method calls can be omitted by using C<undef>
  331. as a placeholder.  A better way is to use named arguments, as the
  332. order of optional parameters may change in later versions of the OLE
  333. server application.  Named parameters can be specified in a reference
  334. to a hash as the last parameter to a method call.
  335.  
  336. Properties can be retrieved or set using hash syntax, while methods
  337. can be invoked with the usual perl method call syntax.  The C<keys>
  338. and C<each> functions can be used to enumerate an object's properties.
  339. Beware that a property is not always writable or even readable (sometimes
  340. raising exceptions when read while being undefined).
  341.  
  342. If a method or property returns an embedded OLE object, method
  343. and property access can be chained as shown in the examples below.
  344.  
  345. =head2 Functions
  346.  
  347. The following functions are not exported by default.
  348.  
  349. =over 8
  350.  
  351. =item HRESULT(ERROR)
  352.  
  353. The HRESULT() function converts an unsigned number into a signed HRESULT
  354. error value as used by OLE internally.  This is necessary because Perl
  355. treats all hexadecimal constants as unsigned.  To check if the last OLE
  356. function returned "Member not found" (0x80020003) you can write:
  357.  
  358.     if (Win32::OLE->LastError == HRESULT(0x80020003)) {
  359.         # your error recovery here
  360.     }
  361.  
  362. =item in(COLLECTION)
  363.  
  364. If COLLECTION is an OLE collection object then C<in $COLLECTION>
  365. returns a list of all members of the collection.  This is a shortcut
  366. for C<Win32::OLE::Enum->All($COLLECTION)>.  It is most commonly used in
  367. a C<foreach> loop:
  368.  
  369.     foreach my $value (in $collection) {
  370.         # do something with $value here
  371.     }
  372.  
  373. =item valof(OBJECT)
  374.  
  375. Normal assignment of Perl OLE objects creates just another reference
  376. to the OLE object.  The valof() function explictly dereferences the
  377. object (through the default method) and returns the value of the object.
  378.  
  379.     my $RefOf = $Object;
  380.     my $ValOf = valof $Object;
  381.         $Object->{Value} = $NewValue;
  382.  
  383. Now $ValOf still contains the old value wheras $RefOf would
  384. resolve to the $NewValue because it is still a reference to
  385. $Object.
  386.  
  387. The valof() function can also be used to convert Win32::OLE::Variant
  388. objects to Perl values.
  389.  
  390. =item with(OBJECT, PROPERTYNAME => VALUE, ...)
  391.  
  392. This function provides a concise way to set the values of multiple
  393. properties of an object.  It iterates over its arguments doing
  394. C<$OBJECT->{PROPERTYNAME} = $VALUE> on each trailing pair.
  395.  
  396. =back
  397.  
  398. =head2 Overloading
  399.  
  400. The Win32::OLE objects can be overloaded to automatically convert to
  401. their values whenever they are used in a bool, numeric or string
  402. context.  This is not enabled by default.  You have to request it
  403. through the OVERLOAD pseudoexport:
  404.  
  405.     use Win32::OLE qw(in valof with OVERLOAD);
  406.  
  407. You can still get the original string representation of an object
  408. (C<Win32::OLE=0xDEADBEEF>), e.g. for debugging, by using the
  409. C<overload::StrVal()> method:
  410.  
  411.     print overload::StrVal($object), "\n";
  412.  
  413. Please note that C<OVERLOAD> is a global setting.  If any module enables
  414. Win32::OLE overloading then it's active everywhere.
  415.  
  416. =head2 Events
  417.  
  418. The Win32::OLE module now contains B<ALPHA> level event support.  This
  419. support is only available when Perl is running in a single threaded
  420. apartment.  This can most easily be assured by using the C<EVENTS>
  421. pseudo-import:
  422.  
  423.     use Win32::OLE qw(EVENTS);
  424.  
  425. which implicitly does something like:
  426.  
  427.     use Win32::OLE;
  428.     Win32::OLE->Initialize(Win32::OLE::COINIT_OLEINITIALIZE);
  429.  
  430. The current interface to OLE events should be considered experimental
  431. and is subject to change.  It works as expected for normal OLE
  432. applications, but OLE control events often don't seem to work yet.
  433.  
  434. Events must be enabled explicitly for an OLE object through the
  435. Win32::OLE->WithEvents() class method.  The Win32::OLE module uses the
  436. IProvideClassInfo2 interface to determine the default event source of
  437. the object.  If this interface is not supported, then the user must
  438. specify the name of the event source explicitly in the WithEvents()
  439. method call.  It is also possible to specify the class name of the
  440. object as the third parameter.  In this case Win32::OLE will try to
  441. look up the default source interface for this COCLASS.
  442.  
  443. The HANDLER argument to Win32::OLE->WithEvents() can either be a CODE
  444. reference or a package name.  In the first case, all events will invoke
  445. this particular function.  The first two arguments to this function will
  446. be the OBJECT itself and the name of the event.  The remaining arguments
  447. will be event specific.
  448.  
  449.     sub Event {
  450.         my ($Obj,$Event,@Args) = @_;
  451.         print "Event triggered: '$Event'\n";
  452.     }
  453.     Win32::OLE->WithEvents($Obj, \&Event);
  454.  
  455. Alternatively the HANDLER argument can specify a package name.  When the
  456. OBJECT fires an event, Win32::OLE will try to find a function of the same
  457. name as the event in this package.  This function will be called with the
  458. OBJECT as the first argument followed again by the event specific parameters:
  459.  
  460.     package MyEvents;
  461.     sub EventName1 {
  462.         my ($Obj,@Args) = @_;
  463.         print "EventName1 event triggered\n";
  464.     }
  465.  
  466.     package main;
  467.     Win32::OLE->WithEvents($Obj, 'MyEvents', 'IEventInterface');
  468.  
  469. If Win32::OLE doesn't find a function with the name of the event then nothing
  470. happens.
  471.  
  472. Event parameters passed I<by reference> are handled specially.  They are not
  473. converted to the corresponding Perl datatype but passed as Win32::OLE::Variant
  474. objects.  You can assign a new value to these objects with the help of the
  475. Put() method.  This value will be passed back to the object when the event
  476. function returns:
  477.  
  478.     package MyEvents;
  479.     sub BeforeClose {
  480.         my ($self,$Cancel) = @_;
  481.         $Cancel->Put(1) unless $MayClose;
  482.     }
  483.  
  484. Direct assignment to $Cancel would have no effect on the original value and
  485. would therefore not command the object to abort the closing action.
  486.  
  487. =head2 Module Options
  488.  
  489. The following module options can be accessed and modified with the
  490. C<Win32::OLE->Option> class method.  In earlier versions of the Win32::OLE
  491. module these options were manipulated directly as class variables.  This
  492. practice is now deprecated.
  493.  
  494. =over 8
  495.  
  496. =item CP
  497.  
  498. This variable is used to determine the codepage used by all
  499. translations between Perl strings and Unicode strings used by the OLE
  500. interface.  The default value is CP_ACP, which is the default ANSI
  501. codepage.  Other possible values are CP_OEMCP, CP_MACCP, CP_UTF7 and
  502. CP_UTF8.  These constants are not exported by default.
  503.  
  504. =item LCID
  505.  
  506. This variable controls the locale idnetifier used for all OLE calls.
  507. It is set to LOCALE_NEUTRAL by default.  Please check the
  508. L<Win32::OLE::NLS> module for other locale related information.
  509.  
  510. =item Warn
  511.  
  512. This variable determines the behavior of the Win32::OLE module when
  513. an error happens.  Valid values are:
  514.  
  515.     0    Ignore error, return undef
  516.     1    Carp::carp if $^W is set (-w option)
  517.     2    always Carp::carp
  518.     3    Carp::croak
  519.  
  520. The error number and message (without Carp line/module info) are
  521. available through the C<Win32::OLE->LastError> class method.
  522.  
  523. =back
  524.  
  525. =head1 EXAMPLES
  526.  
  527. Here is a simple Microsoft Excel application.
  528.  
  529.     use Win32::OLE;
  530.  
  531.     # use existing instance if Excel is already running
  532.     eval {$ex = Win32::OLE->GetActiveObject('Excel.Application')};
  533.     die "Excel not installed" if $@;
  534.     unless (defined $ex) {
  535.         $ex = Win32::OLE->new('Excel.Application', sub {$_[0]->Quit;})
  536.             or die "Oops, cannot start Excel";
  537.     }
  538.  
  539.         # get a new workbook
  540.         $book = $ex->Workbooks->Add;
  541.  
  542.     # write to a particular cell
  543.     $sheet = $book->Worksheets(1);
  544.     $sheet->Cells(1,1)->{Value} = "foo";
  545.  
  546.         # write a 2 rows by 3 columns range
  547.         $sheet->Range("A8:C9")->{Value} = [[ undef, 'Xyzzy', 'Plugh' ],
  548.                                            [ 42,    'Perl',  3.1415  ]];
  549.  
  550.         # print "XyzzyPerl"
  551.         $array = $sheet->Range("A8:C9")->{Value};
  552.     for (@$array) {
  553.         for (@$_) {
  554.         print defined($_) ? "$_|" : "<undef>|";
  555.         }
  556.         print "\n";
  557.     }
  558.  
  559.     # save and exit
  560.         $book->SaveAs( 'test.xls' );
  561.     undef $book;
  562.     undef $ex;
  563.  
  564. Please note the destructor specified on the Win32::OLE->new method.  It ensures
  565. that Excel will shutdown properly even if the Perl program dies.  Otherwise
  566. there could be a process leak if your application dies after having opened
  567. an OLE instance of Excel.  It is the responsibility of the module user to
  568. make sure that all OLE objects are cleaned up properly!
  569.  
  570. Here is an example of using Variant data types.
  571.  
  572.     use Win32::OLE;
  573.     use Win32::OLE::Variant;
  574.     $ex = Win32::OLE->new('Excel.Application', \&OleQuit) or die "oops\n";
  575.     $ex->{Visible} = 1;
  576.     $ex->Workbooks->Add;
  577.     # should generate a warning under -w
  578.     $ovR8 = Variant(VT_R8, "3 is a good number");
  579.     $ex->Range("A1")->{Value} = $ovR8;
  580.     $ex->Range("A2")->{Value} = Variant(VT_DATE, 'Jan 1,1970');
  581.  
  582.     sub OleQuit {
  583.         my $self = shift;
  584.         $self->Quit;
  585.     }
  586.  
  587. The above will put value "3" in cell A1 rather than the string
  588. "3 is a good number".  Cell A2 will contain the date.
  589.  
  590. Similarly, to invoke a method with some binary data, you can
  591. do the following:
  592.  
  593.     $obj->Method( Variant(VT_UI1, "foo\000b\001a\002r") );
  594.  
  595. Here is a wrapper class that basically delegates everything but
  596. new() and DESTROY().  The wrapper class shown here is another way to
  597. properly shut down connections if your application is liable to die
  598. without proper cleanup.  Your own wrappers will probably do something
  599. more specific to the particular OLE object you may be dealing with,
  600. like overriding the methods that you may wish to enhance with your
  601. own.
  602.  
  603.     package Excel;
  604.     use Win32::OLE;
  605.  
  606.     sub new {
  607.         my $s = {};
  608.         if ($s->{Ex} = Win32::OLE->new('Excel.Application')) {
  609.         return bless $s, shift;
  610.         }
  611.         return undef;
  612.     }
  613.  
  614.     sub DESTROY {
  615.         my $s = shift;
  616.         if (exists $s->{Ex}) {
  617.         print "# closing connection\n";
  618.         $s->{Ex}->Quit;
  619.         return undef;
  620.         }
  621.     }
  622.  
  623.     sub AUTOLOAD {
  624.         my $s = shift;
  625.         $AUTOLOAD =~ s/^.*:://;
  626.         $s->{Ex}->$AUTOLOAD(@_);
  627.     }
  628.  
  629.     1;
  630.  
  631. The above module can be used just like Win32::OLE, except that
  632. it takes care of closing connections in case of abnormal exits.
  633. Note that the effect of this specific example can be easier accomplished
  634. using the optional destructor argument of Win32::OLE::new:
  635.  
  636.     my $Excel = Win32::OLE->new('Excel.Application', sub {$_[0]->Quit;});
  637.  
  638. Note that the delegation shown in the earlier example is not the same as
  639. true subclassing with respect to further inheritance of method calls in your
  640. specialized object.  See L<perlobj>, L<perltoot> and L<perlbot> for details.
  641. True subclassing (available by setting C<@ISA>) is also feasible,
  642. as the following example demonstrates:
  643.  
  644.     #
  645.     # Add error reporting to Win32::OLE
  646.     #
  647.  
  648.     package Win32::OLE::Strict;
  649.     use Carp;
  650.     use Win32::OLE;
  651.  
  652.     use strict qw(vars);
  653.     use vars qw($AUTOLOAD @ISA);
  654.     @ISA = qw(Win32::OLE);
  655.  
  656.     sub AUTOLOAD {
  657.         my $obj = shift;
  658.         $AUTOLOAD =~ s/^.*:://;
  659.         my $meth = $AUTOLOAD;
  660.         $AUTOLOAD = "SUPER::" . $AUTOLOAD;
  661.         my $retval = $obj->$AUTOLOAD(@_);
  662.         unless (defined($retval) || $AUTOLOAD eq 'DESTROY') {
  663.         my $err = Win32::OLE::LastError();
  664.         croak(sprintf("$meth returned OLE error 0x%08x",$err))
  665.           if $err;
  666.         }
  667.         return $retval;
  668.     }
  669.  
  670.     1;
  671.  
  672. This package inherits the constructor new() from the Win32::OLE
  673. package.  It is important to note that you cannot later rebless a
  674. Win32::OLE object as some information about the package is cached by
  675. the object.  Always invoke the new() constructor through the right
  676. package!
  677.  
  678. Here's how the above class will be used:
  679.  
  680.     use Win32::OLE::Strict;
  681.     my $Excel = Win32::OLE::Strict->new('Excel.Application', 'Quit');
  682.     my $Books = $Excel->Workbooks;
  683.     $Books->UnknownMethod(42);
  684.  
  685. In the sample above the call to UnknownMethod() will be caught with
  686.  
  687.     UnknownMethod returned OLE error 0x80020009 at test.pl line 5
  688.  
  689. because the Workbooks object inherits the class C<Win32::OLE::Strict> from the
  690. C<$Excel> object.
  691.  
  692. =head1 NOTES
  693.  
  694. =head2 Hints for Microsoft Office automation
  695.  
  696. =over 8
  697.  
  698. =item Documentation
  699.  
  700. The object model for the Office applications is defined in the Visual Basic
  701. reference guides for the various applications.  These are typically not
  702. installed by default during the standard installation.  They can be added
  703. later by rerunning the setup program with the custom install option.
  704.  
  705. =item Class, Method and Property names
  706.  
  707. The names have been changed between different versions of Office.  For
  708. example C<Application> was a method in Office 95 and is a property in
  709. Office97.  Therefore it will not show up in the list of property names
  710. C<keys %$object> when querying an Office 95 object.
  711.  
  712. The class names are not always identical to the method/property names
  713. producing the object.  E.g. the C<Workbook> method returns an object of
  714. type C<Workbook> in Office 95 and C<_Workbook> in Office 97.
  715.  
  716. =item Moniker (GetObject support)
  717.  
  718. Office applications seem to implement file monikers only.  For example
  719. it seems to be impossible to retrieve a specific worksheet object through
  720. C<GetObject("File.XLS!Sheet")>.  Furthermore, in Excel 95 the moniker starts
  721. a Worksheet object and in Excel 97 it returns a Workbook object.  You can use
  722. either the Win32::OLE::QueryObjectType class method or the $object->{Version}
  723. property to write portable code.
  724.  
  725. =item Enumeration of collection objects
  726.  
  727. Enumerations seem to be incompletely implemented.  Office 95 application don't
  728. seem to support neither the Reset() nor the Clone() methods.  The Clone()
  729. method is still unimplemented in Office 97.  A single walk through the
  730. collection similar to Visual Basics C<for each> construct does work however.
  731.  
  732. =item Localization
  733.  
  734. Starting with Office 97 Microsoft has changed the localized class, method and
  735. property names back into English.  Note that string, date and currency
  736. arguments are still subject to locale specific interpretation.  Perl uses the
  737. system default locale for all OLE transaction whereas Visual Basic uses a
  738. type library specific locale.  A Visual Basic script would use "R1C1" in string
  739. arguments to specify relative references.  A Perl script running on a German
  740. language Windows would have to use "Z1S1".  Set the LCID module option
  741. to an English locale to write portable scripts.  This variable should
  742. not be changed after creating the OLE objects; some methods seem to randomly
  743. fail if the locale is changed on the fly.
  744.  
  745. =item SaveAs method in Word 97 doesn't work
  746.  
  747. This is an known bug in Word 97.  Search the MS knowledge base for Word /
  748. Foxpro incompatibility.  That problem applies to the Perl OLE interface as
  749. well.  A workaround is to use the WordBasic compatibility object.  It doesn't
  750. support all the options of the native method though.
  751.  
  752.     $Word->WordBasic->FileSaveAs($file);
  753.  
  754. The problem seems to be fixed by applying the Office 97 Service Release 1.
  755.  
  756. =item Randomly failing method calls
  757.  
  758. It seems like modifying objects that are not selected/activated is sometimes
  759. fragile.  Most of these problems go away if the chart/sheet/document is
  760. selected or activated before being manipulated (just like an interactive
  761. user would automatically do it).
  762.  
  763. =back
  764.  
  765. =head2 Incompatibilities
  766.  
  767. There are some incompatibilities with the version distributed by Activeware
  768. (as of build 306).
  769.  
  770. =over 8
  771.  
  772. =item 1
  773.  
  774. The package name has changed from "OLE" to "Win32::OLE".
  775.  
  776. =item 2
  777.  
  778. All functions of the form "Win32::OLEFoo" are now "Win32::OLE::Foo",
  779. though the old names are temporarily accomodated.  Win32::OLECreateObject()
  780. was changed to Win32::OLE::CreateObject(), and is now called
  781. Win32::OLE::new() bowing to established convention for naming constructors.
  782. The old names should be considered deprecated, and will be removed in the
  783. next version.
  784.  
  785. =item 3
  786.  
  787. Package "OLE::Variant" is now "Win32::OLE::Variant".
  788.  
  789. =item 4
  790.  
  791. The Variant function is new, and is exported by default.  So are
  792. all the VT_XXX type constants.
  793.  
  794. =item 5
  795.  
  796. The support for collection objects has been moved into the package
  797. Win32::OLE::Enum.  The C<keys %$object> method is now used to enumerate
  798. the properties of the object.
  799.  
  800. =back
  801.  
  802. =head2 Bugs and Limitations
  803.  
  804. =over 8
  805.  
  806. =item *
  807.  
  808. To invoke a native OLE method with the same name as one of the
  809. Win32::OLE methods (C<Dispatch>, C<Invoke>, C<SetProperty>, C<DESTROY>,
  810. etc.), you have to use the C<Invoke> method:
  811.  
  812.     $Object->Invoke('Dispatch', @AdditionalArgs);
  813.  
  814. The same is true for names exported by the Exporter or the Dynaloader
  815. modules, e.g.: C<export>, C<export_to_level>, C<import>,
  816. C<_push_tags>, C<export_tags>, C<export_ok_tags>, C<export_fail>,
  817. C<require_version>, C<dl_load_flags>,
  818. C<croak>, C<bootstrap>, C<dl_findfile>, C<dl_expandspec>,
  819. C<dl_find_symbol_anywhere>, C<dl_load_file>, C<dl_find_symbol>,
  820. C<dl_undef_symbols>, C<dl_install_xsub> and C<dl_error>.
  821.  
  822. =back
  823.  
  824. =head1 SEE ALSO
  825.  
  826. The documentation for L<Win32::OLE::Const>, L<Win32::OLE::Enum>,
  827. L<Win32::OLE::NLS> and L<Win32::OLE::Variant> contains additional
  828. information about OLE support for Perl on Win32.
  829.  
  830. =head1 AUTHORS
  831.  
  832. Originally put together by the kind people at Hip and Activeware.
  833.  
  834. Gurusamy Sarathy <gsar@activestate.com> subsequently fixed several
  835. major bugs, memory leaks, and reliability problems, along with some
  836. redesign of the code.
  837.  
  838. Jan Dubois <jand@activestate.com> pitched in with yet more massive redesign,
  839. added support for named parameters, and other significant enhancements.
  840. He's been hacking on it ever since.
  841.  
  842. Please send questions about problems with this module to the
  843. Perl-Win32-Users mailinglist at ActiveState.com.  The mailinglist charter
  844. requests that you put an [OLE] tag somewhere on the subject line (for OLE
  845. related questions only, of course).
  846.  
  847. =head1 COPYRIGHT
  848.  
  849.     (c) 1995 Microsoft Corporation. All rights reserved.
  850.     Developed by ActiveWare Internet Corp., now known as
  851.     ActiveState Tool Corp., http://www.ActiveState.com
  852.  
  853.     Other modifications Copyright (c) 1997-1999 by Gurusamy Sarathy
  854.     <gsar@activestate.com> and Jan Dubois <jand@activestate.com>
  855.  
  856.     You may distribute under the terms of either the GNU General Public
  857.     License or the Artistic License, as specified in the README file.
  858.  
  859. =head1 VERSION
  860.  
  861. Version 0.1101      24 September 1999
  862.  
  863. =cut
  864.