IPXC_Rects::Insert Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Rects::Insert Method}}
 
{{#customTitle:IPXC_Rects::Insert Method}}
 +
{{#parentPage:PXV:IPXC_Rects#Methods|Insert|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserting [[PXV:PXC_Rect|rectangle items]] into the given position in the array.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Insert([in] PXC_Rect* pItems, [in, optional] ULONG nCount, [in, optional] ULONG nIndex);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Insert([in]                   PXC_Rect* stItems,
 +
              [in, defaultvalue(1)]   ULONG     nCount,
 +
              [in, defaultvalue(-1)] ULONG     nIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pItems''
+
;stItems
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]].
+
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]] pointing to the start of the rectangle array that needs to be inserted.
;''nCount''
+
;nCount
:[in, optionalValue of ULONG.
+
:[in, defaultvalue(1)Size of the array that needs to be inserted.
;''nIndex''
+
;nIndex
:[in, optionalValue of ULONG.
+
:[in, defaultvalue(-1)Index where the items 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:IPXC_Rects|IPXC_Rects]].
+
[[PXV:IPXC_Rects|IPXC_Rects]]

Latest revision as of 03:35, 15 June 2015

Inserting rectangle items into the given position in the array.

Syntax

HRESULT Insert([in]                    PXC_Rect*  stItems,
               [in, defaultvalue(1)]   ULONG      nCount,
               [in, defaultvalue(-1)]  ULONG      nIndex);

Parameters

stItems
[in] Pointer to PXC_Rect pointing to the start of the rectangle array that needs to be inserted.
nCount
[in, defaultvalue(1)] Size of the array that needs to be inserted.
nIndex
[in, defaultvalue(-1)] Index where the items would be inserted.

Return Value

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

See Also

IPXC_Rects