IPXC_Page::InsertNewAnnot Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT InsertNewAnnot([in]                              ULONG              AnnotType,
+
<pre class="brush:cpp;gutter:false">HRESULT InsertNewAnnot([in]                              ULONG              nAnnotType,
                       [in]                              PXC_Rect*          Location,
+
                       [in]                              PXC_Rect*          stLocation,
                       [in, defaultvalue(-1)]            ULONG              Pos,
+
                       [in, defaultvalue(-1)]            ULONG              nPos,
                       [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  Annot);</pre>
+
                       [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  pAnnot);</pre>
  
 
== Parameters ==
 
== Parameters ==
;AnnotType
+
;nAnnotType
 
:[in]  Type of annotation that will be inserted.
 
:[in]  Type of annotation that will be inserted.
;Location
+
;stLocation
 
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the coordinates of the inserted annotation.
 
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the coordinates of the inserted annotation.
;Pos
+
;nPos
 
:[in, defaultvalue(-1)]  Position in annotation's Z-order on page. By default the inserted annotation will appear on top of the other annotations on the page.
 
:[in, defaultvalue(-1)]  Position in annotation's Z-order on page. By default the inserted annotation will appear on top of the other annotations on the page.
;Annot
+
;pAnnot
 
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the resulting annotation.
 
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the resulting annotation.
  

Revision as of 03:32, 15 June 2015


Inserts new annotation with given type into the given position with given Z-order.

Syntax

HRESULT InsertNewAnnot([in]                               ULONG              nAnnotType,
                       [in]                               PXC_Rect*          stLocation,
                       [in, defaultvalue(-1)]             ULONG              nPos,
                       [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  pAnnot);

Parameters

nAnnotType
[in] Type of annotation that will be inserted.
stLocation
[in] Pointer to PXC_Rect containing the coordinates of the inserted annotation.
nPos
[in, defaultvalue(-1)] Position in annotation's Z-order on page. By default the inserted annotation will appear on top of the other annotations on the page.
pAnnot
[out, retval, defaultvalue(NULL)] 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