IPXV_SearchCallback::OnStartPtr Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_SearchCallback::OnStartPtr Method}}
 
{{#customTitle:IPXV_SearchCallback::OnStartPtr Method}}
{{#parentPage:PXV:IPXV_SearchCallback|method}}
+
{{#parentPage:PXV:IPXV_SearchCallback#Methods|OnStartPtr|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method is called when we enter a new block of search (document, page, bookmarks etc). The operation is monitoring the callback result and if the HRESULT IS an error and NOT E_NOTIMPL then this situation is perceived as a USER_CANCEL.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT OnStartPtr([in] IPXV_SearchPtr* pPtr);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT OnStartPtr([in] IPXV_SearchPtr* pPtr);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pPtr''
+
;pPtr
:[in]  Pointer to [[PXV:IPXV_SearchPtr|IPXV_SearchPtr]].
+
:[in]  Pointer to [[PXV:IPXV_SearchPtr|IPXV_SearchPtr]] containing the information about the search whereabouts.
  
 
== Return Value ==
 
== Return Value ==
Line 18: Line 18:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_SearchCallback|IPXV_SearchCallback]].
+
[[PXV:IPXV_SearchCallback|IPXV_SearchCallback]]

Latest revision as of 07:47, 19 January 2017


The method is called when we enter a new block of search (document, page, bookmarks etc). The operation is monitoring the callback result and if the HRESULT IS an error and NOT E_NOTIMPL then this situation is perceived as a USER_CANCEL.

Syntax

HRESULT OnStartPtr([in]  IPXV_SearchPtr*  pPtr);

Parameters

pPtr
[in] Pointer to IPXV_SearchPtr containing the information about the search whereabouts.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_SearchCallback