IWords::Remove Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IWords::Remove Method}} | {{#customTitle:IWords::Remove Method}} | ||
{{#parentPage:PXV:IWords#Methods|Remove|method}} | {{#parentPage:PXV:IWords#Methods|Remove|method}} | ||
| − | + | ||
Removes items from the words list by index. | Removes items from the words list by index. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Remove([in] ULONG | + | <pre class="brush:cpp;gutter:false">HRESULT Remove([in] ULONG nIndex, |
| − | [in, defaultvalue(1)] ULONG | + | [in, defaultvalue(1)] ULONG nCount);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;nIndex |
:[in] Starting index of the items to be removed from the words list. | :[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. | :[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 | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== 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.
