TCustomdxPSExplorer.FindCustomItemByUniqueID(TBytes) Method

Returns the folder or item by its unique ID.

Declaration

function FindCustomItemByUniqueID(const AnUniqueID: TBytes): TCustomdxPSExplorerItem; virtual;

Parameters

Name	Type
AnUniqueID	TBytes

Returns

Type
TCustomdxPSExplorerItem

Remarks

As implemented in the TCustomdxPSExplorer class the FindCustomItemByUniqueID method simply returns nil. Descendants override this method to implement their specific search functionality.

This method searches for the folder or item whose ID matches the AnUniqueID parameter. For file explorers, you must specify a pointer of the PShortString type as this parameter, the referred string must contain the full path to the file or folder you want to obtain. For database explorers, you need to specify the pointer of the PdxDBBasedExplorerItemUniqueID type as the parameter. The pointer refers to a TdxDBBasedExplorerItemUniqueID structure that identifies the item type (folder or not) and the item ID.

Note

An item’s unique ID can be obtained using the item’s GetUniqueID method.