IPXV_AnnotsList::Insert 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 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_AnnotsList::Insert Method}}
 
{{#customTitle:IPXV_AnnotsList::Insert Method}}
{{#parentPage:PXV:IPXV_AnnotsList|Insert Method|method}}
+
{{#parentPage:PXV:IPXV_AnnotsList#Methods|Insert|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts item into annotations list.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 12:
 
== Parameters ==
 
== 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 ==
 
== 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 ==
See also [[PXV:IPXV_AnnotsList|IPXV_AnnotsList]].
+
[[PXV:IPXV_AnnotsList|IPXV_AnnotsList]]

Latest revision as of 02:46, 15 June 2015

Inserts item into annotations list.

Syntax

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

Parameters

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.

Return Value

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

See Also

IPXV_AnnotsList