IPXV_AnnotsList::Insert Method

Latest revision as of 02:46, 15 June 2015

Inserts item into annotations list.

HRESULT Insert([in]                    IPXC_Annotation*  pItem,
               [in, defaultvalue(-1)]  ULONG             nIndex);

pItem: [in] Pointer to IPXC_Annotation containing the annotation that would be inserted into the annotations list.
nIndex: [in, defaultvalue(-1)] The index in the annotations list where the annotation would be inserted.

Returns S_OK if the operation was successful, or will return an error code if it fails.

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IPXV_AnnotsList::Insert Method}}
+{{#parentPage:PXV:IPXV_AnnotsList#Methods|Insert|method}}
-The method of interface of PDF-XChange Editor SDK.
+Inserts item into annotations list.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT Insert([in] IPXC_Annotation* pItem, [in, defaultvalue(-1)] ULONG nIndex);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT Insert([in]                    IPXC_Annotation*  pItem,
+               [in, defaultvalue(-1)]  ULONG             nIndex);</pre>
 == Parameters ==
-;''pItem''
+;pItem
-:[in]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]].
+:[in]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the annotation that would be inserted into the annotations list.
-;''nIndex''
+;nIndex
-:[in, defaultvalue(-1)]  Value of ULONG.
+:[in, defaultvalue(-1)]  The index in the annotations list where the annotation would be inserted.
 == Return Value ==
-Returns S_OK if operation was successful or error code in other cases.
+Returns S_OK if the operation was successful, or will return an error code if it fails.
 == See Also ==
-See also [[PXV:IPXV_AnnotsList|IPXV_AnnotsList]].
+[[PXV:IPXV_AnnotsList|IPXV_AnnotsList]]