IPXC_Page::InsertNewAnnotFromDict 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 InsertNewAnnotFromDict([in]                              IPXS_PDFVariant*  pAnnotDict,
+
<pre class="brush:cpp;gutter:false">HRESULT InsertNewAnnotFromDict([in]                              IPXS_PDFVariant*  AnnotDict,
−
                               [in, defaultvalue(NULL)]          PXC_Rect*          stLocation,
+
                               [in, defaultvalue(NULL)]          PXC_Rect*          Location,
−
                               [in, defaultvalue(-1)]            ULONG              nPos,
+
                               [in, defaultvalue(-1)]            ULONG              Pos,
−
                               [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  pAnnot);</pre>
+
                               [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  Annot);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;pAnnotDict
+
;AnnotDict
 
:[in]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the source variant dictionary for the annotation insertion.
 
:[in]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the source variant dictionary for the annotation insertion.
−
;stLocation
+
;Location
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the coordinates of the inserted annotation.
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the coordinates of the inserted annotation.
−
;nPos
+
;Pos
 
:[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.
−
;pAnnot
+
;Annot
 
:[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 07:08, 12 June 2015

PDF Core Layer > Interfaces > IPXC_Page > IPXC_Page::InsertNewAnnotFromDict Method


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

Syntax

HRESULT InsertNewAnnotFromDict([in]                               IPXS_PDFVariant*   AnnotDict,
                               [in, defaultvalue(NULL)]           PXC_Rect*          Location,
                               [in, defaultvalue(-1)]             ULONG              Pos,
                               [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  Annot);

Parameters

AnnotDict
[in] Pointer to IPXS_PDFVariant containing the source variant dictionary for the annotation insertion.
Location
[in, defaultvalue(NULL)] Pointer to PXC_Rect containing the coordinates of the inserted annotation.
Pos
[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
[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

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXC_Page_InsertNewAnnotFromDict&oldid=42676"