IPXV_AnnotsList::InsertFrom Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_AnnotsList::InsertFrom Method}}
 
{{#customTitle:IPXV_AnnotsList::InsertFrom Method}}
−
{{#parentPage:PXV:IPXV_AnnotsList|method}}
+
{{#parentPage:PXV:IPXV_AnnotsList#Methods|InsertFrom|method}}
−
{{ToWrite}}
+
−
{{ToReview}}
+
  
−
The method of interface of PDF-XChange Editor SDK.
+
Inserts items from the given annotations list.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in] IPXV_AnnotsList* pSrc, [in, defaultvalue(0)] ULONG nStartSrcIndex, [in, defaultvalue(-1)] ULONG nSrcItemsCount, [in, defaultvalue(-1)] ULONG nDstIndex);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in]                   IPXV_AnnotsList* pSrc,
 +
                  [in, defaultvalue(0)]   ULONG             nStartSrcIndex,
 +
                  [in, defaultvalue(-1)] ULONG             nSrcItemsCount,
 +
                  [in, defaultvalue(-1)] ULONG             nDstIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''pSrc''
+
;pSrc
−
:[in]  Pointer to [[PXV:IPXV_AnnotsList|IPXV_AnnotsList]].
+
:[in]  Pointer to [[PXV:IPXV_AnnotsList|IPXV_AnnotsList]] containing the source annotations list.
−
;''nStartSrcIndex''
+
;nStartSrcIndex
−
:[in, defaultvalue(0)]  Value of ULONG.
+
:[in, defaultvalue(0)]  Start index in the source array of the items to copy.
−
;''nSrcItemsCount''
+
;nSrcItemsCount
−
:[in, defaultvalue(-1)]  Value of ULONG.
+
:[in, defaultvalue(-1)]  Number of the items to copy from the source array starting from the start index.
−
;''nDstIndex''
+
;nDstIndex
−
:[in, defaultvalue(-1)]  Value of ULONG.
+
:[in, defaultvalue(-1)]  Index in the annotations list where the items from the source 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 03:46, 15 June 2015

PDF Editor Layer > Interfaces > IPXV_AnnotsList > IPXV_AnnotsList::InsertFrom Method

Inserts items from the given annotations list.

Syntax

HRESULT InsertFrom([in]                    IPXV_AnnotsList*  pSrc,
                   [in, defaultvalue(0)]   ULONG             nStartSrcIndex,
                   [in, defaultvalue(-1)]  ULONG             nSrcItemsCount,
                   [in, defaultvalue(-1)]  ULONG             nDstIndex);

Parameters

pSrc
[in] Pointer to IPXV_AnnotsList containing the source annotations list.
nStartSrcIndex
[in, defaultvalue(0)] Start index in the source array of the items to copy.
nSrcItemsCount
[in, defaultvalue(-1)] Number of the items to copy from the source array starting from the start index.
nDstIndex
[in, defaultvalue(-1)] Index in the annotations list where the items from the source 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

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