PyIPropertySystem.md

PyIPropertySystem

PyIPropertySystem Object

Wraps the IPropertySystem interface

Methods

• GetPropertyDescription

  Returns an interface used to describe a property 

• GetPropertyDescriptionByName

  Returns an interface used to describe a property 

• GetPropertyDescriptionListFromString

  Retrieves property descriptions from a string of property names 

• EnumeratePropertyDescriptions

  Returns an interface used to list defined properties 

• FormatForDisplay

  Formats a property into a string 

• RegisterPropertySchema

  Registers a set of properties defined in a .propdesc file 

• UnregisterPropertySchema

  Removes a set of registered properties 

• RefreshPropertySchema

  Not currently implemented by the OS 

PyIPropertySystem.EnumeratePropertyDescriptions

PyIPropertyDescriptionList = EnumeratePropertyDescriptions(Filter, riid

) Returns an interface used to list defined properties

Parameters

• Filter=PDEF_ALL : int

  Value from PROPDESC_ENUMFILTER (pscon.PDEF_*) that limits what types of properties are listed

• riid=IID_IPropertyDescriptionList : PyIID

  The interface to return

PyIPropertySystem.FormatForDisplay

str = FormatForDisplay(Key, Value

, Flags

) Formats a property into a string

Parameters

• Key : PyPROPERTYKEY

  Fmtid and property id that identifies the property

• Value : PyPROPVARIANT

  The value to format

• Flags=PDFF_DEFAULT : int

  Combination of PROPDESC_FORMAT_FLAGS (pscon.PDFF_*) indicating formatting options

PyIPropertySystem.GetPropertyDescription

PyIPropertyDescription = GetPropertyDescription(Key, riid

) Returns an interface used to describe a property

Parameters

• Key : PyPROPERTYKEY

  Fmtid and propertyid that uniquely identifies a property

• riid=IID_IPropertyDescription : PyIID

  The interface to return

PyIPropertySystem.GetPropertyDescriptionByName

PyIPropertyDescription = GetPropertyDescriptionByName(CanonicalName, riid

) Returns an interface used to describe a property

Parameters

• CanonicalName : str

  Registered name of the property

• riid=IID_IPropertyDescription : PyIID

  The interface to return

PyIPropertySystem.GetPropertyDescriptionListFromString

PyIPropertyDescriptionList = GetPropertyDescriptionListFromString(PropList, riid

) Retrieves property descriptions from a string of property names

Parameters

• PropList : str

  String containing a list of properties and flags

• riid=IPropertyDescriptionList : PyIID

  The interface to return

PyIPropertySystem.RefreshPropertySchema

RefreshPropertySchema() Not currently implemented by the OS

Comments

Not currently implemented, according to MSDN

PyIPropertySystem.RegisterPropertySchema

RegisterPropertySchema(Path) Registers a set of properties defined in a .propdesc file

Parameters

• Path : str

  Path to a property schema XML file (.propdesc)

PyIPropertySystem.UnregisterPropertySchema

UnregisterPropertySchema(Path) Removes a set of registered properties

Parameters

• Path : str

  Path to a property schema XML file (.propdesc)