home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _285d2a06f34915fe1f890433f73e664f < prev    next >
Text File  |  2000-03-15  |  18KB  |  538 lines
  1. # The documentation is at the __END__
  2.  
  3. package Win32::OLE::Variant;
  4. require Win32::OLE;  # Make sure the XS bootstrap has been called
  5.  
  6. use strict;
  7. use vars qw(@ISA @EXPORT @EXPORT_OK);
  8.  
  9. use Exporter;
  10. @ISA = qw(Exporter);
  11.  
  12. @EXPORT = qw(
  13.          Variant
  14.          VT_EMPTY VT_NULL VT_I2 VT_I4 VT_R4 VT_R8 VT_CY VT_DATE VT_BSTR
  15.          VT_DISPATCH VT_ERROR VT_BOOL VT_VARIANT VT_UNKNOWN VT_DECIMAL VT_UI1
  16.          VT_ARRAY VT_BYREF
  17.         );
  18.  
  19. @EXPORT_OK = qw(CP_ACP CP_OEMCP);
  20.  
  21. # Automation data types.
  22. sub VT_EMPTY {0;}
  23. sub VT_NULL {1;}
  24. sub VT_I2 {2;}
  25. sub VT_I4 {3;}
  26. sub VT_R4 {4;}
  27. sub VT_R8 {5;}
  28. sub VT_CY {6;}
  29. sub VT_DATE {7;}
  30. sub VT_BSTR {8;}
  31. sub VT_DISPATCH {9;}
  32. sub VT_ERROR {10;}
  33. sub VT_BOOL {11;}
  34. sub VT_VARIANT {12;}
  35. sub VT_UNKNOWN {13;}
  36. sub VT_DECIMAL {14;}    # Officially not allowed in VARIANTARGs
  37. sub VT_UI1 {17;}
  38.  
  39. sub VT_ARRAY {0x2000;}
  40. sub VT_BYREF {0x4000;}
  41.  
  42.  
  43. # For backward compatibility
  44. sub CP_ACP   {0;}     # ANSI codepage
  45. sub CP_OEMCP {1;}     # OEM codepage
  46.  
  47. use overload
  48.     # '+' => 'Add', '-' => 'Sub', '*' => 'Mul', '/' => 'Div',
  49.     '""'     => sub {$_[0]->As(VT_BSTR)},
  50.     '0+'     => sub {$_[0]->As(VT_R8)},
  51.     fallback => 1;
  52.  
  53. sub Variant {
  54.     return Win32::OLE::Variant->new(@_);
  55. }
  56.  
  57. 1;
  58.  
  59. __END__
  60.  
  61. =head1 NAME
  62.  
  63. Win32::OLE::Variant - Create and modify OLE VARIANT variables
  64.  
  65. =head1 SYNOPSIS
  66.  
  67.     use Win32::OLE::Variant;
  68.     my $var = Variant(VT_DATE, 'Jan 1,1970');
  69.     $OleObject->{value} = $var;
  70.     $OleObject->Method($var);
  71.  
  72.  
  73. =head1 DESCRIPTION
  74.  
  75. The IDispatch interface used by the Perl OLE module uses a universal
  76. argument type called VARIANT.  This is basically an object containing
  77. a data type and the actual data value.  The data type is specified by
  78. the VT_xxx constants.
  79.  
  80. =head2 Functions
  81.  
  82. =over 8
  83.  
  84. =item Variant(TYPE, DATA)
  85.  
  86. This is just a function alias of the C<Win32::OLE::Variant->new()>
  87. method (see below).  This function is exported by default.
  88.  
  89. =back
  90.  
  91. =head2 Methods
  92.  
  93. =over 8
  94.  
  95. =item new(TYPE, DATA)
  96.  
  97. This method returns a Win32::OLE::Variant object of the specified
  98. TYPE that contains the given DATA.  The Win32::OLE::Variant object
  99. can be used to specify data types other than IV, NV or PV (which are
  100. supported transparently).  See L<Variants> below for details.
  101.  
  102. For VT_EMPTY and VT_NULL variants, the DATA argument may be omitted.
  103. For all non-VT_ARRAY variants DATA specifies the initial value.
  104.  
  105. To create a SAFEARRAY variant, you have to specify the VT_ARRAY flag in
  106. addition to the variant base type of the array elemnts.  In this cases
  107. DATA must be a list specifying the dimensions of the array.  Each element
  108. can be either an element count (indices 0 to count-1) or an array
  109. reference pointing to the lower and upper array bounds of this dimension:
  110.  
  111.     my $Array = Win32::OLE::Variant->new(VT_ARRAY|VT_R8, [1,2], 2);
  112.  
  113. This creates a 2-dimensional SAFEARRAY of doubles with 4 elements:
  114. (1,0), (1,1), (2,0) and (2,1).
  115.  
  116. A special case is the the creation of one-dimensional VT_UI1 arrays with
  117. a string DATA argument:
  118.  
  119.     my $String = Variant(VT_ARRAY|VT_UI1, "String");
  120.  
  121. This creates a 6 element character array initialized to "String".  For
  122. backward compatibility VT_UI1 with a string initializer automatically
  123. implies VT_ARRAY.  The next line is equivalent to the previous example:
  124.  
  125.     my $String = Variant(VT_UI1, "String");
  126.  
  127. If you really need a single character VT_UI1 variant, you have to create
  128. it using a numeric intializer:
  129.  
  130.     my $Char = Variant(VT_UI1, ord('A'));
  131.  
  132. =item As(TYPE)
  133.  
  134. C<As> converts the VARIANT to the new type before converting to a
  135. Perl value.  This take the current LCID setting into account.  For
  136. example a string might contain a ',' as the decimal point character.
  137. Using C<$variant->As(VT_R8)> will correctly return the floating
  138. point value.
  139.  
  140. The underlying variant object is NOT changed by this method.
  141.  
  142. =item ChangeType(TYPE)
  143.  
  144. This method changes the type of the contained VARIANT in place.  It
  145. returns the object itself, not the converted value.
  146.  
  147. =item Copy([DIM])
  148.  
  149. This method creates a copy of the object.  If the original variant had
  150. the VT_BYREF bit set then the new object will contain a copy of the
  151. referenced data and not a reference to the same old data.  The new
  152. object will not have the VT_BYREF bit set.
  153.  
  154.     my $Var = Variant(VT_I4|VT_ARRAY|VT_BYREF, [1,5], 3);
  155.     my $Copy = $Var->Copy;
  156.  
  157. The type of C<$Copy> is now VT_I4|VT_ARRAY and the value is a copy of
  158. the other SAFEARRAY.  Changes to elements of C<$Var> will not be reflected
  159. in C<$Copy> and vice versa.
  160.  
  161. The C<Copy> method can also be used to extract a single element of a
  162. VT_ARRAY | VT_VARIANT object.  In this case the array indices must be
  163. specified as a list DIM:
  164.  
  165.     my $Int = $Var->Copy(1, 2);
  166.  
  167. C<$Int> is now a VT_I4 Variant object containing the value of element (1,2).
  168.  
  169. =item Currency([FORMAT[, LCID]])
  170.  
  171. This method converts the VARIANT value into a formatted curency string.  The
  172. FORMAT can be either an integer constant or a hash reference.  Valid constants
  173. are 0 and LOCALE_NOUSEROVERRIDE.  You get the value of LOCALE_NOUSEROVERRIDE
  174. from the Win32::OLE::NLS module:
  175.  
  176.     use Win32::OLE::NLS qw(:LOCALE);
  177.  
  178. LOCALE_NOUSEROVERRIDE tells the method to use the system default currency
  179. format for the specified locale, disregarding any changes that might have
  180. been made through the control panel application.
  181.  
  182. The hash reference could contain the following keys:
  183.  
  184.     NumDigits    number of fractional digits
  185.     LeadingZero    whether to use leading zeroes in decimal fields
  186.     Grouping    size of each group of digits to the left of the decimal
  187.     DecimalSep    decimal separator string
  188.     ThousandSep    thousand separator string
  189.     NegativeOrder    see L<Win32::OLE::NLS/LOCALE_ICURRENCY>
  190.     PositiveOrder    see L<Win32::OLE::NLS/LOCALE_INEGCURR>
  191.     CurrencySymbol    currency symbol string
  192.  
  193. For example:
  194.  
  195.     use Win32::OLE::Variant;
  196.     use Win32::OLE::NLS qw(:DEFAULT :LANG :SUBLANG :DATE :TIME);
  197.     my $lcidGerman = MAKELCID(MAKELANGID(LANG_GERMAN, SUBLANG_NEUTRAL));
  198.     my $v = Variant(VT_CY, "-922337203685477.5808");
  199.     print $v->Currency({CurrencySymbol => "Tuits"}, $lcidGerman), "\n";
  200.  
  201. will print:
  202.  
  203.     -922.337.203.685.477,58 Tuits
  204.  
  205. =item Date([FORMAT[, LCID]])
  206.  
  207. Converts the VARIANT into a formatted date string.  FORMAT can be either
  208. one of the following integer constants or a format string:
  209.  
  210.     LOCALE_NOUSEROVERRIDE    system default date format for this locale
  211.     DATE_SHORTDATE        use the short date format (default)
  212.     DATE_LONGDATE        use the long date format
  213.     DATE_YEARMONTH        use the year/month format
  214.     DATE_USE_ALT_CALENDAR    use the alternate calendar, if one exists
  215.     DATE_LTRREADING        left-to-right reading order layout
  216.     DATE_RTLREADING        right-to left reading order layout
  217.  
  218. The constants are available from the Win32::OLE::NLS module:
  219.  
  220.     use Win32::OLE::NLS qw(:LOCALE :DATE);
  221.  
  222. The following elements can be used to construct a date format string.
  223. Characters must be specified exactly as given below (e.g. "dd" B<not> "DD").
  224. Spaces can be inserted anywhere between formating codes, other verbatim
  225. text should be included in single quotes.
  226.  
  227.     d    day of month
  228.     dd    day of month with leading zero for single-digit days
  229.     ddd    day of week: three-letter abbreviation (LOCALE_SABBREVDAYNAME)
  230.     dddd    day of week: full name (LOCALE_SDAYNAME)
  231.     M    month
  232.     MM    month with leading zero for single-digit months
  233.     MMM    month: three-letter abbreviation (LOCALE_SABBREVMONTHNAME)
  234.     MMMM    month: full name (LOCALE_SMONTHNAME)
  235.     y    year as last two digits
  236.     yy    year as last two digits with leading zero for years less than 10
  237.     yyyy    year represented by full four digits
  238.     gg    period/era string
  239.  
  240. For example:
  241.  
  242.     my $v = Variant(VT_DATE, "April 1 99");
  243.     print $v->Date(DATE_LONGDATE), "\n";
  244.     print $v->Date("ddd',' MMM dd yy"), "\n";
  245.  
  246. will print:
  247.  
  248.     Thursday, April 01, 1999
  249.     Thu, Apr 01 99
  250.  
  251. =item Dim()
  252.  
  253. Returns a list of array bounds for a VT_ARRAY variant.  The list contains
  254. an array reference for each dimension of the variant's SAFEARRAY.  This
  255. reference points to an array containing the lower and upper bounds for
  256. this dimension.  For example:
  257.  
  258.     my @Dim = $Var->Dim;
  259.  
  260. Now C<@Dim> contains the following list: C<([1,5], [0,2])>.
  261.  
  262. =item Get(DIM)
  263.  
  264. For normal variants C<Get> returns the value of the variant, just like the
  265. C<Value> method.  For VT_ARRAY variants C<Get> retrieves the value of a single
  266. array element.  In this case C<DIM> must be a list of array indices.  E.g.
  267.  
  268.     my $Val = $Var->Get(2,0);
  269.  
  270. As a special case for one dimensional VT_UI1|VT_ARRAY variants the C<Get>
  271. method without arguments returns the character array as a Perl string.
  272.  
  273.     print $String->Get, "\n";
  274.  
  275. =item LastError()
  276.  
  277. The use of the C<Win32::OLE::Variant->LastError()> method is deprecated.
  278. Please use the C<Win32::OLE->LastError()> class method instead.
  279.  
  280. =item Number([FORMAT[, LCID]])
  281.  
  282. This method converts the VARIANT value into a formatted number string.  The
  283. FORMAT can be either an integer constant or a hash reference.  Valid constants
  284. are 0 and LOCALE_NOUSEROVERRIDE.  You get the value of LOCALE_NOUSEROVERRIDE
  285. from the Win32::OLE::NLS module:
  286.  
  287.     use Win32::OLE::NLS qw(:LOCALE);
  288.  
  289. LOCALE_NOUSEROVERRIDE tells the method to use the system default number
  290. format for the specified locale, disregarding any changes that might have
  291. been made through the control panel application.
  292.  
  293. The hash reference could contain the following keys:
  294.  
  295.     NumDigits    number of fractional digits
  296.     LeadingZero    whether to use leading zeroes in decimal fields
  297.     Grouping    size of each group of digits to the left of the decimal
  298.     DecimalSep    decimal separator string
  299.     ThousandSep    thousand separator string
  300.     NegativeOrder    see L<Win32::OLE::NLS/LOCALE_INEGNUMBER>
  301.  
  302. =item Put(DIM, VALUE)
  303.  
  304. The C<Put> method is used to assign a new value to a variant.  The value will
  305. be coerced into the current type of the variant.  E.g.:
  306.  
  307.     my $Var = Variant(VT_I4, 42);
  308.     $Var->Put(3.1415);
  309.  
  310. This changes the value of the variant to C<3> because the type is VT_I4.
  311.  
  312. For VT_ARRAY type variants the indices for each dimension of the contained
  313. SAFEARRAY must be specified in front of the new value:
  314.  
  315.     $Array->Put(1, 1, 2.7);
  316.  
  317. It is also possible to assign values to *every* element of the SAFEARRAY at
  318. once using a single Put() method call:
  319.  
  320.     $Array->Put([[1,2], [3,4]]);
  321.  
  322. In this case the argument to Put() must be an array reference and the
  323. dimensions of the Perl list-of-lists must match the dimensions of the
  324. SAFEARRAY exactly.
  325.  
  326. The are a few special cases for one-dimensional VT_UI1 arrays: The VALUE
  327. can be specified as a string instead of a number.  This will set the selected
  328. character to the first character of the string or to '\0' if the string was
  329. empty:
  330.  
  331.     my $String = Variant(VT_UI1|VT_ARRAY, "ABCDE");
  332.     $String->Put(1, "123");
  333.     $String->Put(3, ord('Z'));
  334.     $String->Put(4, '');
  335.  
  336. This will set the value of C<$String> to C<"A1CZ\0">.  If the index is omitted
  337. then the string is copied to the value completely.  The string is truncated
  338. if it is longer than the size of the VT_UI1 array.  The result will be padded
  339. with '\0's if the string is shorter:
  340.  
  341.     $String->Put("String");
  342.  
  343. Now C<$String> contains the value "Strin".
  344.  
  345. C<Put> returns the Variant object itself so that multiple C<Put> calls can be
  346. chained together:
  347.  
  348.     $Array->Put(0,0,$First_value)->Put(0,1,$Another_value);
  349.  
  350. =item Time([FORMAT[, LCID]])
  351.  
  352. Converts the VARIANT into a formatted time string.  FORMAT can be either
  353. one of the following integer constants or a format string:
  354.  
  355.     LOCALE_NOUSEROVERRIDE    system default time format for this locale
  356.     TIME_NOMINUTESORSECONDS    don't use minutes or seconds
  357.     TIME_NOSECONDS        don't use seconds
  358.     TIME_NOTIMEMARKER    don't use a time marker
  359.     TIME_FORCE24HOURFORMAT    always use a 24-hour time format
  360.  
  361. The constants are available from the Win32::OLE::NLS module:
  362.  
  363.     use Win32::OLE::NLS qw(:LOCALE :TIME);
  364.  
  365. The following elements can be used to construct a time format string.
  366. Characters must be specified exactly as given below (e.g. "dd" B<not> "DD").
  367. Spaces can be inserted anywhere between formating codes, other verbatim
  368. text should be included in single quotes.
  369.  
  370.     h    hours; 12-hour clock
  371.     hh    hours with leading zero for single-digit hours; 12-hour clock
  372.     H    hours; 24-hour clock
  373.     HH    hours with leading zero for single-digit hours; 24-hour clock
  374.     m    minutes
  375.     mm    minutes with leading zero for single-digit minutes
  376.     s    seconds
  377.     ss    seconds with leading zero for single-digit seconds
  378.     t    one character time marker string, such as A or P
  379.     tt    multicharacter time marker string, such as AM or PM
  380.  
  381. For example:
  382.  
  383.     my $v = Variant(VT_DATE, "April 1 99 2:23 pm");
  384.     print $v->Time, "\n";
  385.     print $v->Time(TIME_FORCE24HOURFORMAT|TIME_NOTIMEMARKER), "\n";
  386.     print $v->Time("hh.mm.ss tt"), "\n";
  387.  
  388. will print:
  389.  
  390.     2:23:00 PM
  391.     14:23:00
  392.     02.23.00 PM
  393.  
  394. =item Type()
  395.  
  396. The C<Type> method returns the variant type of the contained VARIANT.
  397.  
  398. =item Unicode()
  399.  
  400. The C<Unicode> method returns a C<Unicode::String> object.  This contains
  401. the BSTR value of the variant in network byte order.  If the variant is
  402. not currently in VT_BSTR format then a VT_BSTR copy will be produced first.
  403.  
  404. =item Value()
  405.  
  406. The C<Value> method returns the value of the VARIANT as a Perl value.  The
  407. conversion is performed in the same manner as all return values of
  408. Win32::OLE method calls are converted.
  409.  
  410. =back
  411.  
  412. =head2 Overloading
  413.  
  414. The Win32::OLE::Variant package has overloaded the conversion to
  415. string and number formats.  Therefore variant objects can be used in
  416. arithmetic and string operations without applying the C<Value>
  417. method first.
  418.  
  419. =head2 Class Variables
  420.  
  421. The Win32::OLE::Variant class used to have its own set of class variables
  422. like C<$CP>, C<$LCID> and C<$Warn>.  In version 0.1003 and later of the
  423. Win32::OLE module these variables have been eleminated.  Now the settings
  424. of Win32::OLE are used by the Win32::OLE::Variant module too.  Please read
  425. the documentation of the C<Win32::OLE->Option> class method.
  426.  
  427.  
  428. =head2 Constants
  429.  
  430. These constants are exported by default:
  431.  
  432.     VT_EMPTY
  433.     VT_NULL
  434.     VT_I2
  435.     VT_I4
  436.     VT_R4
  437.     VT_R8
  438.     VT_CY
  439.     VT_DATE
  440.     VT_BSTR
  441.     VT_DISPATCH
  442.     VT_ERROR
  443.     VT_BOOL
  444.     VT_VARIANT
  445.     VT_UNKNOWN
  446.     VT_DECIMAL
  447.     VT_UI1
  448.  
  449.     VT_ARRAY
  450.     VT_BYREF
  451.  
  452. VT_DECIMAL is not on the official list of allowable OLE Automation
  453. datatypes.  But even Microsoft ADO seems to sometimes return values
  454. of Recordset fields in VT_DECIMAL format.
  455.  
  456. =head2 Variants
  457.  
  458. A Variant is a data type that is used to pass data between OLE
  459. connections.
  460.  
  461. The default behavior is to convert each perl scalar variable into
  462. an OLE Variant according to the internal perl representation.
  463. The following type correspondence holds:
  464.  
  465.         C type          Perl type       OLE type
  466.         ------          ---------       --------
  467.           int              IV            VT_I4
  468.         double             NV            VT_R8
  469.         char *             PV            VT_BSTR
  470.         void *           ref to AV       VT_ARRAY
  471.            ?              undef          VT_ERROR
  472.            ?        Win32::OLE object    VT_DISPATCH
  473.  
  474. Note that VT_BSTR is a wide character or Unicode string.  This presents a
  475. problem if you want to pass in binary data as a parameter as 0x00 is
  476. inserted between all the bytes in your data.  The C<Variant()> method
  477. provides a solution to this.  With Variants the script writer can specify
  478. the OLE variant type that the parameter should be converted to.  Currently
  479. supported types are:
  480.  
  481.         VT_UI1     unsigned char
  482.         VT_I2      signed int (2 bytes)
  483.         VT_I4      signed int (4 bytes)
  484.         VT_R4      float      (4 bytes)
  485.         VT_R8      float      (8 bytes)
  486.         VT_DATE    OLE Date
  487.         VT_BSTR    OLE String
  488.         VT_CY      OLE Currency
  489.         VT_BOOL    OLE Boolean
  490.  
  491. When VT_DATE and VT_CY objects are created, the input parameter is treated
  492. as a Perl string type, which is then converted to VT_BSTR, and finally to
  493. VT_DATE of VT_CY using the C<VariantChangeType()> OLE API function.
  494. See L<Win32::OLE/EXAMPLES> for how these types can be used.
  495.  
  496. =head2 Variant arrays
  497.  
  498. A variant can not only contain a single value but also a multi-dimensional
  499. array of values (called a SAFEARRAY).  In this case the VT_ARRAY flag must
  500. be added to the base variant type, e.g. C<VT_I4 | VT_ARRAY> for an array of
  501. integers.  The VT_EMPTY and VT_NULL types are invalid for SAFEARRAYs.  It
  502. is possible to create an array of variants: C<VT_VARIANT | VT_ARRAY>.  In this
  503. case each element of the array can have a different type (including VT_EMPTY
  504. and VT_NULL).  The elements of a VT_VARIANT SAFEARRAY cannot have either of the
  505. VT_ARRAY or VT_BYREF flags set.
  506.  
  507. The lower and upper bounds for each dimension can be specified separately.
  508. They do not have to have all the same lower bound (unlike Perl's arrays).
  509.  
  510. =head2 Variants by reference
  511.  
  512. Some OLE servers expect parameters passed by reference so that they
  513. can be changed in the method call.  This allows methods to easily
  514. return multiple values.  There is preliminary support for this in
  515. the Win32::OLE::Variant module:
  516.  
  517.     my $x = Variant(VT_I4|VT_BYREF, 0);
  518.     my $y = Variant(VT_I4|VT_BYREF, 0);
  519.     $Corel->GetSize($x, $y);
  520.     print "Size is $x by $y\n";
  521.  
  522. After the C<GetSize> method call C<$x> and C<$y> will be set to
  523. the respective sizes.  They will still be variants.  In the print
  524. statement the overloading converts them to string representation
  525. automatically.
  526.  
  527. VT_BYREF is now supported for all variant types (including SAFEARRAYs).
  528. It can also be used to pass an OLE object by reference:
  529.  
  530.     my $Results = $App->CreateResultsObject;
  531.     $Object->Method(Variant(VT_DISPATCH|VT_BYREF, $Results));
  532.  
  533. =head1 AUTHORS/COPYRIGHT
  534.  
  535. This module is part of the Win32::OLE distribution.
  536.  
  537. =cut
  538.