IPXV_DocSelectionHandler::IsSelHandler Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_DocSelectionHandler::IsSelHandler Method}}
 
{{#customTitle:IPXV_DocSelectionHandler::IsSelHandler Method}}
{{#parentPage:PXV:IPXV_DocSelectionHandler|method}}
+
{{#parentPage:PXV:IPXV_DocSelectionHandler#Methods|IsSelHandler|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Checks if it's a selection handler for specified selection (firstly the implementer should check the [[PXV:IPXV_DocSelection_ID|ID]] property of the selection).
 
+
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT IsSelHandler([in] IPXV_Document* pDoc, [in] IPXV_DocSelection* pDocSel, [out, retval] VARIANT_BOOL* pIsHandler);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT IsSelHandler([in]           IPXV_Document*     pDoc,
 +
                    [in]           IPXV_DocSelection* pDocSel,
 +
                    [out, retval] VARIANT_BOOL*       bIsHandler);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pDoc''
+
;pDoc
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]].
+
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] containing the source document.
;''pDocSel''
+
;pDocSel
:[in]  Pointer to [[PXV:IPXV_DocSelection|IPXV_DocSelection]].
+
:[in]  Pointer to [[PXV:IPXV_DocSelection|IPXV_DocSelection]] containing the document selection that should be checked.
;''pIsHandler''
+
;bIsHandler
:[out, retval]  Pointer to VARIANT_BOOL.
+
:[out, retval]  Pointer to VARIANT_BOOL containing whether the selection handler is a handler for the specified selection.
  
 
== Return Value ==
 
== Return Value ==
Line 22: Line 23:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_DocSelectionHandler|IPXV_DocSelectionHandler]].
+
[[PXV:IPXV_DocSelectionHandler|IPXV_DocSelectionHandler]]

Latest revision as of 01:37, 17 March 2016


Checks if it's a selection handler for specified selection (firstly the implementer should check the ID property of the selection).

Syntax

HRESULT IsSelHandler([in]           IPXV_Document*      pDoc,
                     [in]           IPXV_DocSelection*  pDocSel,
                     [out, retval]  VARIANT_BOOL*       bIsHandler);

Parameters

pDoc
[in] Pointer to IPXV_Document containing the source document.
pDocSel
[in] Pointer to IPXV_DocSelection containing the document selection that should be checked.
bIsHandler
[out, retval] Pointer to VARIANT_BOOL containing whether the selection handler is a handler for the specified selection.

Return Value

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

See Also

IPXV_DocSelectionHandler