IWords::Remove Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IWords::Remove Method}}
 
{{#customTitle:IWords::Remove Method}}
 +
{{#parentPage:PXV:IWords#Methods|Remove|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Removes items from the words list by index.
  
 
== 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 be removed from the words list.
;''nCount''
+
;nCount
:[in, optionalValue of ULONG.
+
:[in, defaultvalue(1)Number of the items to be removed from the words list starting from the given index.
  
 
== 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:IWords|IWords]].
+
[[PXV:IWords|IWords]]

Latest revision as of 16:13, 16 June 2015


Removes items from the words list by index.

Syntax

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

Parameters

nIndex
[in] Starting index of the items to be removed from the words list.
nCount
[in, defaultvalue(1)] Number of the items to be removed from the words list starting from the given index.

Return Value

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

See Also

IWords