IPXV_SearchPtr Interface
| Line 15: | Line 15: | ||
{PXV_SearchPtrChunk_Document, <docID>}, {PXV_SearchPtrChunk_Page, <pageIndex>} ... | {PXV_SearchPtrChunk_Document, <docID>}, {PXV_SearchPtrChunk_Page, <pageIndex>} ... | ||
| + | |||
| + | '''''<docID>''''' - number that identifies the document and is used in the [[PXV:IPXV_SearchPtr_Doc|Doc]] property. It is valid ONLY in the context of the Callbacks' methods and should not be used outside of them. | ||
| + | |||
Revision as of 03:32, 20 January 2017
This object holds the path to the object that is being searched for. This is an array of PXV_SearchPtrChunk structures, where each successive structure (from left to right) defines the "coordinate" of the deeper search level, relative to the preceding array element.
WARNING: You can NOT hold and use the IPXV_SearchPtr objects for further usage OUTSIDE of the Callback's code (IPXV_SearchCallback::OnStartPtr/IPXV_SearchCallback::OnStoptPtr/IPXV_SearchCallback::OnNewEntry), because these objects can be repeatedly used by the operations for other contexts.
Example 1:
If the search is being held on the document's pages then these structure arrays will be passed through the Callback's methods (IPXV_SearchCallback::OnStartPtr/IPXV_SearchCallback::OnStoptPtr, IPXV_SearchEntryItem::get_Ptr):
{PXV_SearchPtrChunk_Document, <docID>}, {PXV_SearchPtrChunk_Page, <pageIndex>} ...
<docID> - number that identifies the document and is used in the Doc property. It is valid ONLY in the context of the Callbacks' methods and should not be used outside of them.
Methods
| IsEqual |
Properties
| AttachPtr | Doc | Item | Str |
| Count |
See Also
IPXV_SearchCallback::OnStartPtr, IPXV_SearchCallback::OnStopPtr, IPXV_SearchEntryItem::Ptr
