IPXC_Page::GetAnnot Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Page::GetAnnot Method}}
 
{{#customTitle:IPXC_Page::GetAnnot Method}}
 +
{{#parentPage:PXV:IPXC_Page#Methods|GetAnnot|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets annotation from the page by index.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetAnnot([in] ULONG nIndex, [out, retval] IPXC_Annotation** pAnnot);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetAnnot([in]           ULONG             nIndex,
 +
                [out, retval] IPXC_Annotation** pAnnot);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nIndex''
+
;nIndex
:[in]  Value of ULONG.
+
:[in]  Index of the annotation.
;''pAnnot''
+
;pAnnot
:[out, retval]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]].
+
:[out, retval]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the resulting annotation.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Page|IPXC_Page]].
+
[[PXV:IPXC_Page|IPXC_Page]]

Latest revision as of 03:32, 15 June 2015


Gets annotation from the page by index.

Syntax

HRESULT GetAnnot([in]           ULONG              nIndex,
                 [out, retval]  IPXC_Annotation**  pAnnot);

Parameters

nIndex
[in] Index of the annotation.
pAnnot
[out, retval] Pointer to IPXC_Annotation containing the resulting annotation.

Return Value

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

See Also

IPXC_Page