Skip to content

Latest commit

 

History

History
261 lines (131 loc) · 6.17 KB

PyIShellItem2.md

File metadata and controls

261 lines (131 loc) · 6.17 KB

PyIShellItem2

PyIShellItem2 Object

Extends the IShellItem interface, giving access to an item's properties

Methods

  • GetPropertyStore

    Returns a collection of the item's properties 

  • GetPropertyStoreForKeys

    Creates a property store containing just the specified properties of the item 

  • GetPropertyStoreWithCreateObject

    Returns the property store for the item, with alternate handler instantiation 

  • GetPropertyDescriptionList

    Retrieves descriptions of properties in a particular group 

  • Update

    Refreshes properties that have been modified since interface was created 

  • GetProperty

    DRetrieves the value of a property, converted to an appropriate python type 

  • GetCLSID

    Retrieves the value of a property as a GUID 

  • GetFileTime

    Retrieves the value of a property as a file time. 

  • GetInt32

    Retrieves the value of a property as a 32 bit int. 

  • GetString

    Retrieves the value of a property as a string 

  • GetUInt32

    Returns the value of a property as a 32 bit unsigned int 

  • GetUInt64

    Returns the value of a property as an unsigned 64-bit int 

  • GetBool

    Returns the value of a property as a boolean 

boolean = GetBool(key) Returns the value of a property as a boolean

Parameters

PyIShellItem2.GetCLSID

PyIID = GetCLSID(key) Retrieves the value of a property as a CLSID (VT_CLSID)

Parameters

PyIShellItem2.GetFileTime

PyTime = GetFileTime(key) Retrieves the value of a property as a FILETIME

Parameters

PyIShellItem2.GetInt32

int = GetInt32(key) Retrieves the value of a property as a 32 bit int.

Parameters

PyIShellItem2.GetProperty

object = GetProperty(key) Retrieves the value of a property, converted to an appropriate python type

Parameters

Return Value

Type of returned object is determined by the variant type of the property

PyIShellItem2.GetPropertyDescriptionList

PyIPropertyDescriptionList = GetPropertyDescriptionList(Type, riid

) Retrieves descriptions of properties in a particular group

Parameters

  • Type : PyPROPERTYKEY

    Property list identifier (pscon.PKEY_PropList_*)

  • riid=IID_IPropertyDescriptionList : PyIID

    The interface to return

PyIShellItem2.GetPropertyStore

PyIPropertyStore = GetPropertyStore(Flags, riid

) Returns a collection of the item's properties

Parameters

  • Flags=GPS_DEFAULT : int

    Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*)

  • riid=IID_IPropertyStore : PyIID

    The interface to return

PyIShellItem2.GetPropertyStoreForKeys

PyIPropertyStore = GetPropertyStoreForKeys(Keys, Flags

, riid

) Creates a property store containing just the specified properties of the item

Parameters

  • Keys : (SHCOLUMNID

,...))

A sequence of property identifiers
  • Flags=GPS_DEFAULT : int

    Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*)

  • riid=IID_IPropertyStore : PyIID

    The interface to return

PyIShellItem2.GetPropertyStoreWithCreateObject

PyIPropertyStore = GetPropertyStoreWithCreateObject(Flags, CreateObject

, riid

) Returns the property store for the item, with alternate handler instantiation

Parameters

  • Flags : int

    Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*)

  • CreateObject : PyIUnknown

    An interface that implements ICreateObject, used to create the property handler

  • riid=IID_IPropertyStore : PyIID

    The interface to be created

Comments

Primarily used to create a handler in a separate process with reduced privileges

PyIShellItem2.GetString

str = GetString(key) Retrieves the value of a property as a string

Parameters

PyIShellItem2.GetUInt32

int = GetUInt32(key) Returns the value of a property as a 32 bit unsigned int

Parameters

PyIShellItem2.GetUInt64

int = GetUInt64(key) Returns the value of a property as an unsigned 64-bit int

Parameters

Update(BindCtx) Refreshes properties that have been modified since interface was created

Parameters

  • BindCtx=None : PyIBindCxt

    Bind context used when requesting the interface, or None