Skip to content

Latest commit

 

History

History
67 lines (35 loc) · 1.96 KB

PyIShellIconOverlayIdentifier.md

File metadata and controls

67 lines (35 loc) · 1.96 KB

PyIShellIconOverlayIdentifier

PyIShellIconOverlayIdentifier Object

Interface that supplies icon overlay information to the shell

Methods

  • IsMemberOf

    Determines if a shell object should have an icon overlay 

  • GetOverlayInfo

    Retrieves the path to the overlay icon 

  • GetPriority

    Retrieves the relative priority of the overlay 

PyIShellIconOverlayIdentifier.GetOverlayInfo

(PyUnicode, int, int) = GetOverlayInfo() Retrieves the path to the overlay icon

Return Value

Returns the path to the icon file, the index of icon within the file, and Flags containing

combination of shellcon.ISIOI_ICON* flags

PyIShellIconOverlayIdentifier.GetPriority

int = GetPriority() Retrieves the relative priority of the overlay

Return Value

Implementation of this function should return a number in the range 0-100 (0 is highest priority)

PyIShellIconOverlayIdentifier.IsMemberOf

int = IsMemberOf(path, attrib

) Determines if a shell object should have an icon overlay

Parameters

  • path : PyUnicode

    Fully qualified path of the shell object

  • attrib : int

    Shell attributes, combination of shellcon.SFGAO_* flags

Return Value

The gateway implementation of this function should return winerror.S_OK to

display the overlay, S_FALSE if not, or throw a COM exception with E_FAIL on error.

The client implementation of this function returns the same values - ie,

Python's True and False should not be used, as S_OK==0==False.