propertyset(3)

NAME

OLE::PropertySet - Handles Property Sets

$Revision: 1.1.1.1 $ $Date: 1998/02/25 21:13:00 $

SYNOPSIS

use OLE::Storage();
use OLE::PropertySet();
$Var = OLE::Storage -> NewVar;
$Doc =  OLE::Storage  ->  open  ($Startup,  $Var,  "testfile.doc");
direct mode
   $PS = OLE::PropertySet->load ($Startup, $Var, $pps,
   $Doc)
   @list = string { $PS -> property (2, 5, 6) }
tie mode
   $PS = tie %PS, OLE::PropertySet, $Startup, $Var, $pps,
   $Doc
   @list = string { $PS{2}, $PS{5}, $PS{6} }

DESCRIPTION

OLE::PropertySet gives read access to property sets. These
are streams, that e.g. are residing inside of Structured
Storage documents. Because property set technology is not
limited to these documents borders, this package was
designed to connect easily to Structured Storage documents
and to arbitrary property set streams.

To understand the use of this package, I recommend highly
to study the tool "ldat".

dictionary

1||"O" == $PS -> dictionary (_%dict [,1])

Stores the dictionary of PropertySet $PS in hash
%dict. The dictionary is a hash array having the prop
erty identifier numbers as keys and the identifier
names as values. By default the default dictionaries
defined in OLE::PropertySet are also printed out. To
leave them out, specify the optional parameter 1.

Normally you will not need this method, but use
idset() instead.

idset

1||"O" == $PS -> idset (_%idset [,1]);

Stores the idset of PropertySet $PS in hash %idset. The idset is a hash array based on the really avail
able property identifiers. %idset has property iden
tifier numbers as keys and the identifier names
according to the PropertySets dictionary as values.
The optional parameter spares out the default dictio
nary (see dictionary).

Note: Some or all id names can be empty, if they can
not be figured out. Nevertheless the ids are valid.

idstr

$idstr||"undef" = $PS -> idstr ($id [,1])

Returns the property identifier string for property
$id according to the PropertySets dictionary. The
optional parameter spares out the default dictionary
(see dictionary).

load

$PS||0 ==
1. load ($Startup, $Var, $pps, $Doc [,"filter"])

2. load ($Startup, $Var, $name, _$buf [,"filter"])

· load() is the constructor of OLE::PropertySet. You can call it either with a Property Storage id $pps and a
Structured Storage document handle $Doc as parameters,
or with an PropertySetName $name and a reference to a
PropertySetBuffer _$buf.

NewVar
$Var == $PS -> NewVar ()

Creates a new Variable handling object and returns it.
(see also: open)

property
Property||scalar = $PS -> property ($id1 [,$id2 [...]])

Returns a $Property or a list of @Properties. (See OLE::Storage::Property to look what to do with it /
them). If you applied a filter when loading $PS, prop
erty returns a scalar or a list of scalars.

type
$type||0 = PropertySet -> type ($Doc, $pps)

$type||0 = PropertySet -> type ($name)

Returns the type of a PropertySet according to its
name. The type is a OLE::PropertySet internal. It can
be used to determine, if a property is a PropertySet
or not. Momentarily are existing:

type meaning
--------------------------------------------------0x01 property is a " 5" PropertySet
0x10 property is a " 1CompObj" fake PropertySet
0x00 property is no PropertySet at all

SEE ALSO

OLE::Storage::Property, demonstration program "ldat"

AUTHOR

Martin Schwartz <schwartz@cs.tu-berlin.de>.

perl v5.8.0 1998-02-25 PropertySet(3)