PyIShellFolder2.md

PyIShellFolder2

PyIShellFolder2 Object

Represents an explorer folder, giving access to details of items in the folder.

Inherits all methods of PyIShellFolder.

Methods

• GetDefaultSearchGUID

  Retrieves the default search for the folder 

• EnumSearches

  Returns an interface that lists searches defined for the folder 

• GetDefaultColumn

  Returns the columns used for sorting and display 

• GetDefaultColumnState

  Returns flags indicating the default behaviour of the column 

• GetDetailsEx

  Returns the details of an item by Column ID 

• GetDetailsOf

  Returns the value or title of a column in the folder's Details view. 

• MapColumnToSCID

  Returns the unique identifier (FMTID, pid) of a column 

• __iter__

  Enumerates all objects in this folder. 

PyIShellFolder2.EnumSearches

PyIEnumExtraSearch

= EnumSearches() Returns an interface that lists searches defined for the folder

Comments

IEnumExtraSearch is not yet wrapped by Pywin32

PyIShellFolder2.GetDefaultColumn

(int, int) = GetDefaultColumn() Returns the columns used for sorting and display

PyIShellFolder2.GetDefaultColumnState

int = GetDefaultColumnState(iColumn) Returns flags indicating the default behaviour of the column

Parameters

• iColumn : int

  Zero-based index of the column

Return Value

Returns a combination of shellcon.SHCOLSTATE_* flags

PyIShellFolder2.GetDefaultSearchGUID

PyIID = GetDefaultSearchGUID(pguid) Retrieves the default search for the folder

Parameters

• pguid : PyIID

  Description for pguid

PyIShellFolder2.GetDetailsEx

object = GetDetailsEx(pidl, pscid

) Returns the details of an item by Column ID

Parameters

• pidl : PyIDL

  Relative id list of an item in the folder

• pscid : SHCOLUMNID

  The Column id/property key of a column in the folder's Details view

Return Value

The type of returned object is determined by the variant type of the requested column

PyIShellFolder2.GetDetailsOf

(int, int, str) = GetDetailsOf(pidl, iColumn

) Returns the value or title of a column in the folder's Details view.

Parameters

• pidl : PyIDL

  The relative idl of an item in the folder. Use None to retrieve column title.

• iColumn : int

  Zero based index of column

Return Value

Returns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in characters,

and string representation of the requested value

PyIShellFolder2.MapColumnToSCID

SHCOLUMNID

= MapColumnToSCID(Column) Returns the unique identifier (FMTID, pid) of a column

Parameters

• Column : int

  The zero-based index of the column as presented by the folder's Details view

Return Value

On XP and earlier, this is the Column Id as provided by PyIColumnProvider.

For Vista and later, this is the Property Key used with the property system interfaces.