IPXV_AnnotsList::Remove Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_AnnotsList::Remove Method}}
 
{{#customTitle:IPXV_AnnotsList::Remove Method}}
 
{{#parentPage:PXV:IPXV_AnnotsList#Methods|Remove|method}}
 
{{#parentPage:PXV:IPXV_AnnotsList#Methods|Remove|method}}
 
  
 
Removes items from the annotations list by index.
 
Removes items from the annotations 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 annotations list.
 
:[in]  Starting index of the items to be removed from the annotations list.
;nCount
+
;Count
 
:[in, defaultvalue(1)]  Number of the items to be removed from the annotations list starting from the given index.
 
:[in, defaultvalue(1)]  Number of the items to be removed from the annotations list starting from the given index.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if the operation was successful, or will return an error code if it fails.  
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IPXV_AnnotsList|IPXV_AnnotsList]]
 
[[PXV:IPXV_AnnotsList|IPXV_AnnotsList]]

Revision as of 07:22, 12 June 2015

Removes items from the annotations 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 annotations list.
Count
[in, defaultvalue(1)] Number of the items to be removed from the annotations 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.

See Also

IPXV_AnnotsList