IPXV_BookmList::Remove Method
From PDF XChange PDF SDK
| Line 15: | Line 15: | ||
:[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 | ;nCount | ||
| − | :[in, defaultvalue(1)] Number of | + | :[in, defaultvalue(1)] Number of items to be removed from the bookmarks list starting from the given '''nIndex'''. If the default value (-1) is specified or '''nCount''' exceeds the maximum number of items, then ALL items beginning with '''nIndex''' will be removed. |
== Return Value == | == Return Value == | ||
Revision as of 09:45, 10 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 the default value (-1) is specified or 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.
