IPXC_Rects::Remove Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Rects::Remove Method}}
 
{{#customTitle:IPXC_Rects::Remove Method}}
 +
{{#parentPage:PXV:IPXC_Rects#Methods|Remove|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Removes the given number of items from the rectangle array.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Remove([in] ULONG nIndex, [in, optional] ULONG nCount);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Remove([in]                   ULONG nIndex,
 +
              [in, defaultvalue(1)] ULONG nCount);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nIndex''
+
;nIndex
:[in]  Value of ULONG.
+
:[in]  Starting index of the items to remove.
;''nCount''
+
;nCount
:[in, optionalValue of ULONG.
+
:[in, defaultvalue(1)Number of the items to remove.
  
 
== 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

Removes the given number of items from the rectangle array.

Syntax

HRESULT Remove([in]                   ULONG  nIndex,
               [in, defaultvalue(1)]  ULONG  nCount);

Parameters

nIndex
[in] Starting index of the items to remove.
nCount
[in, defaultvalue(1)] Number of the items to remove.

Return Value

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

See Also

IPXC_Rects