IPXV_BookmList::Remove Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
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.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Remove([in]                  ULONG  nIndex,
+
<pre class="brush:cpp;gutter:false">HRESULT Remove([in]                  ULONG  Index,
               [in, defaultvalue(1)]  ULONG  nCount);</pre>
+
               [in, defaultvalue(1)]  ULONG  Count);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nIndex
+
;Index
 
:[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
+
;Count
:[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.
+
:[in, defaultvalue(1)]  Number of items to be removed from the bookmarks list starting from the given '''Index'''. If the default value (-1) is specified or '''Count''' exceeds the maximum number of items, then ALL items beginning with '''Index''' will be removed.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 06:24, 12 June 2015

Removes items from the bookmarks list by index.

Syntax

HRESULT Remove([in]                   ULONG  Index,
               [in, defaultvalue(1)]  ULONG  Count);

Parameters

Index
[in] Starting index of the items to be removed from the bookmarks list.
Count
[in, defaultvalue(1)] Number of items to be removed from the bookmarks list starting from the given Index. If the default value (-1) is specified or Count exceeds the maximum number of items, then ALL items beginning with Index will be removed.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_BookmList