IPXV_BookmList::Remove Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 7: | Line 7: | ||
== 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 bookmarks list. | :[in] Starting index of the items to be removed from the bookmarks list. | ||
| − | ; | + | ;nCount |
| − | :[in, defaultvalue(1)] Number of items to be removed from the bookmarks list starting from the given ''' | + | :[in, defaultvalue(1)] Number of items to be removed from the bookmarks list starting from the given '''nIndex'''. If '''nCount''' exceeds the maximum number of items, then ALL items beginning with '''nIndex''' will be removed. |
== Return Value == | == Return Value == | ||
Latest revision as of 22:30, 22 June 2015
Removes items from the bookmarks 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 bookmarks list.
- nCount
- [in, defaultvalue(1)] Number of items to be removed from the bookmarks list starting from the given nIndex. If nCount exceeds the maximum number of items, then ALL items beginning with nIndex will be removed.
Return Value
Returns S_OK if operation was successful or error code in other cases.
