Skip to content

Latest commit

 

History

History
216 lines (109 loc) · 5.25 KB

PyIPropertyStorage.md

File metadata and controls

216 lines (109 loc) · 5.25 KB

PyIPropertyStorage

PyIPropertyStorage Object

Structured storage object that contains a set of properties.

Supports iteration to list properties.

Methods

  • ReadMultiple

    Reads specified properties from the current property set. 

  • WriteMultiple

    Creates or modifies properties in the property set 

  • DeleteMultiple

    Deletes properties from the property set 

  • ReadPropertyNames

    Retrieves any existing string names for the specified property identifiers. 

  • WritePropertyNames

    Assigns string names to a specified array of property IDs in the current property set. 

  • DeletePropertyNames

    Removes property names from specified properties. 

  • Commit

    Persists the property set to its base storage 

  • Revert

    Discards any changes that have been made 

  • Enum

    Creates an enumerator for properties in the property set 

  • SetTimes

    Sets the creation, last access, and modification time 

  • SetClass

    Sets the GUID for the property set 

  • Stat

    Returns various infomation about the property set 

PyIPropertyStorage.Commit

Commit(CommitFlags) Persists the property set to its base storage

Parameters

  • CommitFlags : int

    Combination of storagecon.STGC_* flags

PyIPropertyStorage.DeleteMultiple

DeleteMultiple(props) Deletes properties from the property set

Parameters

  • props : (PROPSPEC, ...)

    Sequence containing names or IDs of properties to be deleted

PyIPropertyStorage.DeletePropertyNames

DeletePropertyNames(props) Removes property names from specified properties.

Parameters

  • props : (int, ...)

    Sequence of ints containing property IDs.

PyIPropertyStorage.Enum

PyIEnumSTATPROPSTG = Enum() Creates an enumerator for properties in the property set

PyIPropertyStorage.ReadMultiple

(object, ...) = ReadMultiple(props) Reads specified properties from the current property set.

Parameters

  • props : (PROPSPEC, ...)

    Sequence of property IDs or names.

Return Value

Returned values are automatically converted to an appropriate python type

PyIPropertyStorage.ReadPropertyNames

(str,...) = ReadPropertyNames(props) Retrieves any existing string names for the specified property identifiers.

Parameters

  • props : (int, ...)

    Sequence of ints containing property IDs.

PyIPropertyStorage.Revert

Revert() Discards any changes that have been made

PyIPropertyStorage.SetClass

SetClass(clsid) Sets the GUID for the property set

Parameters

  • clsid : PyIID

    Description for clsid

PyIPropertyStorage.SetTimes

SetTimes(ctime, atime, mtime) Sets the creation, last access, and modification time

Parameters

  • ctime : PyTime

    Creation time, or None for no change

  • atime : PyTime

    Last access time, or None for no change

  • mtime : PyTime

    Modification time, or None for no change

Comments

Some property sets do not support these times.

PyIPropertyStorage.Stat

tuple = Stat() Returns various infomation about the property set

Return Value

Returns a tuple representing a STATPROPSETSTG struct.

PyIPropertyStorage.WriteMultiple

WriteMultiple(props, values, propidNameFirst) Creates or modifies properties in the property set

Parameters

  • props : (PROPSPEC, ...)

    Sequence containing names or integer ids of properties to write

  • values : (PROPVARIANT

, ...)

The values for the properties\.

  • propidNameFirst=2 : int

    Minimum property id to be assigned to new properties specified by name

PyIPropertyStorage.WritePropertyNames

WritePropertyNames(props, names) Assigns string names to a specified array of property IDs in the current property set.

Parameters

  • props : (int, ...)

    Sequence containing the property IDs.

  • names : (string, ...)

    Equal length sequence of property names.