PyITransferSource.md

PyITransferSource

PyITransferSource Object

Implemented by shell folders that can act as the source of shell item operations

Methods

• Advise

  Connects an advise sink to receive notifications 

• Unadvise

  Disconnects an event sink 

• SetProperties

  Specifies changes to be applied to items' properties 

• OpenItem

  Initiates the copying of an item 

• MoveItem

  Moves a shell item into another folder 

• RecycleItem

  Moves an item to the recycle bin 

• RemoveItem

  Deletes an item without recycling 

• RenameItem

  Renames a shell item 

• LinkItem

  Not implemented, according to MSDN 

• ApplyPropertiesToItem

  Changes an item's properties as specified by PyITransferSource::SetProperties 

• GetDefaultDestinationName

  Determines the name of an item as it would appear in a given folder 

• EnterFolder

  Informs the copy engine that a folder will be the target of a file operation 

• LeaveFolder

  Informs the copy engine that the operation on a destination folder is finished 

PyITransferSource.Advise

int = Advise(Sink) Connects an advise sink to receive notifications

Parameters

• Sink : PyITransferAdviseSink

  Event sink to respond to notifications

PyITransferSource.ApplyPropertiesToItem

PyIShellItem = ApplyPropertiesToItem(Source) Changes an item's properties as specified by PyITransferSource::SetProperties

Parameters

• Source : PyIShellItem

  Item whose properties are to be changed

PyITransferSource.EnterFolder

int = EnterFolder(ChildFolderDest) Informs the copy engine that a folder will be the target of a file operation

Parameters

• ChildFolderDest : PyIShellItem

  The destination folder for the operation

PyITransferSource.GetDefaultDestinationName

str = GetDefaultDestinationName(Source, ParentDest

) Determines the name of an item as it would appear in a given folder

Parameters

• Source : PyIShellItem

  The item whose name is wanted

• ParentDest : PyIShellItem

  The destination folder

PyITransferSource.LeaveFolder

int = LeaveFolder(ChildFolderDest) Informs the copy engine that the operation on a destination folder is finished

Parameters

• ChildFolderDest : PyIShellItem

  Destination folder

PyITransferSource.LinkItem

(int, PyIShellItem = LinkItem(Source, ParentDest

, NewName

, flags

) Not implemented, according to MSDN

Parameters

• Source : PyIShellItem

  Description for psiSource

• ParentDest : PyIShellItem

  Description for psiParentDest

• NewName : str

  Description for NewName

• flags : int

  Combination of shellcon.TSF_* flags

PyITransferSource.MoveItem

(int, PyIShellItem = MoveItem(Item, ParentDst

, NameDst

, flags

) Moves a shell item into another folder

Parameters

• Item : PyIShellItem

  Item to be moved

• ParentDst : PyIShellItem

  The folder into which it will be moved

• NameDst : unicode

  New name for item after move, None to keep same name

• flags : int

  Combination of shellcon.TSF_* flags

Return Value

Returns the HRESULT from the operation and the new shell item, which may be None

when the code in one of the informational COPYENGINE_S_* values. See MSDN for descriptions

of expected actions for specific error codes.

PyITransferSource.OpenItem

(int, PyIShellItemResources) = OpenItem(Item, flags

, riid

) Initiates the copying of an item

Parameters

• Item : PyIShellItem

  The item to be copied.

• flags : int

  Combination of shellcon.TSF_* flags

• riid=IID_IShellItemResources : PyIID

  The interface to return

PyITransferSource.RecycleItem

(int, PyIShellItem = RecycleItem(Source, ParentDest

, flags

) Moves an item to the recycle bin

Parameters

• Source : PyIShellItem

  The item to be recycled

• ParentDest : PyIShellItem

  Shell item representing the recycle bin

• flags : int

  Combination of shellcon.TSF_* flags

PyITransferSource.RemoveItem

int = RemoveItem(Source, flags

) Deletes an item without recycling

Parameters

• Source : PyIShellItem

  The item to be deleted

• flags : int

  Combination of shellcon.TSF_* flags

Return Value

Returns the HRESULT of the operation

PyITransferSource.RenameItem

(int, PyIShellItem) = RenameItem(Source, NewName

, flags

) Renames a shell item

Parameters

• Source : PyIShellItem

  Item to be renamed

• NewName : str

  The name to be given to the item

• flags : int

  Combination of shellcon.TSF_* flags

PyITransferSource.SetProperties

SetProperties(proparray) Specifies changes to be applied to items' properties

Parameters

• proparray : PyIPropertyChangeArray

  Property changes to be applied by PyITransferSource::ApplyPropertiesToItem

PyITransferSource.Unadvise

Unadvise(Cookie) Disconnects an event sink

Parameters

• Cookie : int

  Connection id as returned by PyITransferSource::Advise