IPXC_Rects::InsertFrom Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Rects::InsertFrom Method}}
 
{{#customTitle:IPXC_Rects::InsertFrom Method}}
 +
{{#parentPage:PXV:IPXC_Rects#Methods|InsertFrom|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts items from the source rectangle array into given position.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in] IPXC_Rects* pSrc, [in, optional] ULONG nStartSrcIndex, [in, optional] ULONG nSrcItemsCount, [in, optional] ULONG nDstIndex);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in]                   IPXC_Rects* 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:IPXC_Rects|IPXC_Rects]].
+
:[in]  Pointer to [[PXV:IPXC_Rects|IPXC_Rects]] containing the source rectangle array.
;''nStartSrcIndex''
+
;nStartSrcIndex
:[in, optionalValue of ULONG.
+
:[in, defaultvalue(0)Starting index in the source array.
;''nSrcItemsCount''
+
;nSrcItemsCount
:[in, optionalValue of ULONG.
+
:[in, defaultvalue(-1)Number of items to copy from the source array.
;''nDstIndex''
+
;nDstIndex
:[in, optionalValue of ULONG.
+
:[in, defaultvalue(-1)Destination index in the current rectangle array.
  
 
== 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:IPXC_Rects|IPXC_Rects]].
+
[[PXV:IPXC_Rects|IPXC_Rects]]

Latest revision as of 03:35, 15 June 2015

Inserts items from the source rectangle array into given position.

Syntax

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

Parameters

pSrc
[in] Pointer to IPXC_Rects containing the source rectangle array.
nStartSrcIndex
[in, defaultvalue(0)] Starting index in the source array.
nSrcItemsCount
[in, defaultvalue(-1)] Number of items to copy from the source array.
nDstIndex
[in, defaultvalue(-1)] Destination index in the current rectangle array.

Return Value

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

See Also

IPXC_Rects