IPXC_Articles::AddNew Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Articles::AddNew Method}}
 
{{#customTitle:IPXC_Articles::AddNew Method}}
 +
{{#parentPage:PXV:IPXC_Articles#Methods|AddNew|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Adds new [[PXV:IPXC_Article|article]] to the [[PXV:IPXC_Document|core document's]] [[PXV:IPXC_Articles|article array]] into given position.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT AddNew([in] ULONG nPos, [out, retval] IPXC_Article** pNewArticle);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT AddNew([in]           ULONG           nPos,
 +
              [out, retval] IPXC_Article** pNewArticle);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nPos''
+
;nPos
:[in]  Value of ULONG.
+
:[in]  Position where the article will be inserted into.
;''pNewArticle''
+
;pNewArticle
:[out, retval]  Pointer to [[PXV:IPXC_Article|IPXC_Article]].
+
:[out, retval]  Pointer to [[PXV:IPXC_Article|IPXC_Article]] containing the newly inserted article.
  
 
== 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

Adds new article to the core document's article array into given position.

Syntax

HRESULT AddNew([in]           ULONG           nPos,
               [out, retval]  IPXC_Article**  pNewArticle);

Parameters

nPos
[in] Position where the article will be inserted into.
pNewArticle
[out, retval] Pointer to IPXC_Article containing the newly inserted article.

Return Value

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

See Also

IPXC_Articles