IPXV_SearchCallback::OnStopPtr Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_SearchCallback::OnStopPtr Method}}
 
{{#customTitle:IPXV_SearchCallback::OnStopPtr Method}}
{{#parentPage:PXV:IPXV_SearchCallback|method}}
+
{{#parentPage:PXV:IPXV_SearchCallback#Methods|OnStopPtr|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method is called when we leave a new block of search (document, page, bookmarks etc).
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT OnStopPtr([in] IPXV_SearchPtr* pPtr, VARIANT_BOOL bIncomplete);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT OnStopPtr([in] IPXV_SearchPtr* pPtr,
 +
                        VARIANT_BOOL     bIncomplete);</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.
;''bIncomplete''
+
;bIncomplete
: Value of VARIANT_BOOL.
+
: Value of VARIANT_BOOL representing whether the search was interrupted by user or error.
  
 
== Return Value ==
 
== Return Value ==
Line 20: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_SearchCallback|IPXV_SearchCallback]].
+
[[PXV:IPXV_SearchCallback|IPXV_SearchCallback]]

Latest revision as of 07:32, 20 December 2016


The method is called when we leave a new block of search (document, page, bookmarks etc).

Syntax

HRESULT OnStopPtr([in]  IPXV_SearchPtr*  pPtr,
                        VARIANT_BOOL     bIncomplete);

Parameters

pPtr
[in] Pointer to IPXV_SearchPtr containing the information about the search whereabouts.
bIncomplete
Value of VARIANT_BOOL representing whether the search was interrupted by user or error.

Return Value

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

See Also

IPXV_SearchCallback