IPXC_Articles::Remove Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Articles::Remove Method}}
 
{{#customTitle:IPXC_Articles::Remove Method}}
{{#parentPage:PXV:IPXC_Articles|method}}
+
{{#parentPage:PXV:IPXC_Articles#Methods|Remove|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
Removes [[PXV:IPXC_Article|article]] from the [[PXV:IPXC_Document|core document's]] [[PXV:IPXC_Articles|article array]] by index.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Remove([in] ULONG nPos);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Remove([in] ULONG nPos);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nPos''
+
;nPos
:[in]  Value of ULONG.
+
:[in]  Index of the article that will be removed.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Articles|IPXC_Articles]].
+
[[PXV:IPXC_Articles|IPXC_Articles]]

Latest revision as of 03:20, 15 June 2015

Removes article from the core document's article array by index.

Syntax

HRESULT Remove([in]  ULONG  nPos);

Parameters

nPos
[in] Index of the article that will be removed.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IPXC_Articles