home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 June / PCWorld_2005-06_cd.bin / software / vyzkuste / firewally / firewally.exe / framework-2.3.exe / Enum.pm < prev    next >
Text File  |  2002-07-08  |  3KB  |  96 lines
  1. # The documentation is at the __END__
  2.  
  3. package Win32::OLE::Enum;
  4. 1;
  5.  
  6. # everything is pure XS in Win32::OLE::Enum
  7. # - new
  8. # - DESTROY
  9. #
  10. # - All
  11. # - Clone
  12. # - Next
  13. # - Reset
  14. # - Skip
  15.  
  16. __END__
  17.  
  18. =head1 NAME
  19.  
  20. Win32::OLE::Enum - OLE Automation Collection Objects
  21.  
  22. =head1 SYNOPSIS
  23.  
  24.     my $Sheets = $Excel->Workbooks(1)->Worksheets;
  25.     my $Enum = Win32::OLE::Enum->new($Sheets);
  26.     my @Sheets = $Enum->All;
  27.  
  28.     while (defined(my $Sheet = $Enum->Next)) { ... }
  29.  
  30. =head1 DESCRIPTION
  31.  
  32. This module provides an interface to OLE collection objects from
  33. Perl.  It defines an enumerator object closely mirroring the
  34. functionality of the IEnumVARIANT interface.
  35.  
  36. Please note that the Reset() method is not available in all implementations
  37. of OLE collections (like Excel 7).  In that case the Enum object is good
  38. only for a single walk through of the collection.
  39.  
  40. =head2 Functions/Methods
  41.  
  42. =over 8
  43.  
  44. =item Win32::OLE::Enum->new($object)
  45.  
  46. Creates an enumerator for $object, which must be a valid OLE collection
  47. object.  Note that correctly implemented collection objects must support
  48. the C<Count> and C<Item> methods, so creating an enumerator is not always
  49. necessary.
  50.  
  51. =item $Enum->All()
  52.  
  53. Returns a list of all objects in the collection.  You have to call
  54. $Enum->Reset() before the enumerator can be used again.  The previous
  55. position in the collection is lost.
  56.  
  57. This method can also be called as a class method:
  58.  
  59.     my @list = Win32::OLE::Enum->All($Collection);
  60.  
  61. =item $Enum->Clone()
  62.  
  63. Returns a clone of the enumerator maintaining the current position within
  64. the collection (if possible).  Note that the C<Clone> method is often not
  65. implemented.  Use $Enum->Clone() in an eval block to avoid dying if you
  66. are not sure that Clone is supported.
  67.  
  68. =item $Enum->Next( [$count] )
  69.  
  70. Returns the next element of the collection.  In a list context the optional
  71. $count argument specifies the number of objects to be returned.  In a scalar
  72. context only the last of at most $count retrieved objects is returned.  The
  73. default for $count is 1.
  74.  
  75. =item $Enum->Reset()
  76.  
  77. Resets the enumeration sequence to the beginning.  There is no guarantee that
  78. the exact same set of objects will be enumerated again (e.g. when enumerating
  79. files in a directory).  The methods return value indicates the success of the
  80. operation.  (Note that the Reset() method seems to be unimplemented in some
  81. applications like Excel 7.  Use it in an eval block to avoid dying.)
  82.  
  83. =item $Enum->Skip( [$count] )
  84.  
  85. Skip the next $count elements of the enumeration.  The default for $count is 1.
  86. The functions returns TRUE if at least $count elements could be skipped.  It
  87. returns FALSE if not enough elements were left.
  88.  
  89. =back
  90.  
  91. =head1 AUTHORS/COPYRIGHT
  92.  
  93. This module is part of the Win32::OLE distribution.
  94.  
  95. =cut
  96.