IPXV_SearchPtr Interface
| Line 6: | Line 6: | ||
This object holds the path to the object that is being searched for. This is an array of [[PXV:PXV_SearchPtrChunk|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. | This object holds the path to the object that is being searched for. This is an array of [[PXV:PXV_SearchPtrChunk|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. | ||
| + | |||
| + | <span style="color:red;"> | ||
| + | '''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. | ||
| + | </span> | ||
| + | |||
| + | '''Example 1:'''<br /> | ||
| + | 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>} ... | ||
| + | |||
| + | |||
== Methods == | == Methods == | ||
Revision as of 03:21, 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>} ...
Methods
| IsEqual |
Properties
| AttachPtr | Doc | Item | Str |
| Count |
See Also
IPXV_SearchCallback::OnStartPtr, IPXV_SearchCallback::OnStopPtr, IPXV_SearchEntryItem::Ptr
