IPXC_Page::RemoveAnnots Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Page::RemoveAnnots Method}}
 
{{#customTitle:IPXC_Page::RemoveAnnots Method}}
{{#parentPage:PXV:IPXC_Page|method}}
+
{{#parentPage:PXV:IPXC_Page#Methods|RemoveAnnots|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Removes annotations from the page.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT RemoveAnnots([in] ULONG nIndex, [in] ULONG nCount);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT RemoveAnnots([in] ULONG nIndex,
 +
                    [in] ULONG nCount);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nIndex''
+
;nIndex
:[in]  Value of ULONG.
+
:[in]  Starting index in the annotations Z-order starting from which the annotations will be removed.
;''nCount''
+
;nCount
:[in]  Value of ULONG.
+
:[in]  Number of annotations that will be removed by their Z-order.
  
 
== Return Value ==
 
== Return Value ==
Line 20: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Page|IPXC_Page]].
+
[[PXV:IPXC_Page|IPXC_Page]]

Latest revision as of 03:32, 15 June 2015


Removes annotations from the page.

Syntax

HRESULT RemoveAnnots([in]  ULONG  nIndex,
                     [in]  ULONG  nCount);

Parameters

nIndex
[in] Starting index in the annotations Z-order starting from which the annotations will be removed.
nCount
[in] Number of annotations that will be removed by their Z-order.

Return Value

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

See Also

IPXC_Page