IPXV_BookmList::Remove Method

From Tracker Software PDF SDK
Jump to: navigation, search
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
{{#customTitle:IPXV_BookmList::Remove Method}}
 
{{#customTitle:IPXV_BookmList::Remove Method}}
 
{{#parentPage:PXV:IPXV_BookmList#Methods|Remove|method}}
 
{{#parentPage:PXV:IPXV_BookmList#Methods|Remove|method}}
 
  
 
Removes items from the bookmarks list by index.
 
Removes items from the bookmarks list by index.
Line 15: Line 14:
 
:[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 the items to be removed from the bookmarks list starting from the given index. If the default value (-1) is specified or '''nCount''' exceeds the maximum number of items, then ALL items beginning with '''nIndex''' will be removed.
+
:[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.

See Also

IPXV_BookmList