IPXV_Inst::GetAnnotHandler Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::GetAnnotHandler Method}}
 
{{#customTitle:IPXV_Inst::GetAnnotHandler Method}}
{{#parentPage:PXV:IPXV_Inst|GetAnnotHandler Method|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|GetAnnotHandler|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Returns corresponding annotation-handler (in other terms - ''Tool'') object for specified PDF-annotation when it registered for such kind of annotations.
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT GetAnnotHandler([in]          IPXC_Annotation*    pAnnot,
 
<pre class="brush:cpp;gutter:false">HRESULT GetAnnotHandler([in]          IPXC_Annotation*    pAnnot,
                         [out, retval]  IPXV_AnnotHandler**  ppHandler);</pre>
+
                         [out, retval]  IPXV_AnnotHandler**  pHandler);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pAnnot
 
;pAnnot
 
:[in]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]].
 
:[in]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]].
;ppHandler
+
;pHandler
:[out, retval]  Pointer to [[PXV:IPXV_AnnotHandler|IPXV_AnnotHandler]].
+
:[out, retval]  Returns pointer to [[PXV:IPXV_AnnotHandler|IPXV_AnnotHandler]] object.
  
 
== Return Value ==
 
== Return Value ==
Line 22: Line 21:
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_RegisterTool|IPXV_Inst::RegisterTool]]

Latest revision as of 03:56, 15 June 2015


Returns corresponding annotation-handler (in other terms - Tool) object for specified PDF-annotation when it registered for such kind of annotations.

Syntax

HRESULT GetAnnotHandler([in]           IPXC_Annotation*     pAnnot,
                        [out, retval]  IPXV_AnnotHandler**  pHandler);

Parameters

pAnnot
[in] Pointer to IPXC_Annotation.
pHandler
[out, retval] Returns pointer to IPXV_AnnotHandler object.

Return Value

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

See Also

IPXV_Inst, IPXV_Inst::RegisterTool