IPXS_PDFVariant::Arr_InsertNameA Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_InsertNameA Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_InsertNameA Method}}
 +
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_InsertNameA|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Insert new variant with type <code>PVT_Name</code> and specified value into array container.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Arr_InsertNameA([in] ULONG nAtom, [in, defaultvalue(-1)] ULONG nBefore);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_InsertNameA([in]                   ULONG nAtom,
 +
                        [in, defaultvalue(-1)] ULONG nBefore);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nAtom''
+
;nAtom
:[in]  Value of ULONG.
+
:[in]  Specifies name atom (see [[PXV:PXS_Atoms]] description  for details).
;''nBefore''
+
;nBefore
:[in, defaultvalue(-1)] Value of ULONG.
+
:[in, defaultvalue(-1)] Specifies index of element before which we will insert new one. If index is greater or equal array size new element will be inserted at the end of array.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Latest revision as of 07:18, 20 August 2015


Insert new variant with type PVT_Name and specified value into array container.

Syntax

HRESULT Arr_InsertNameA([in]                    ULONG  nAtom,
                        [in, defaultvalue(-1)]  ULONG  nBefore);

Parameters

nAtom
[in] Specifies name atom (see Atoms description for details).
nBefore
[in, defaultvalue(-1)] Specifies index of element before which we will insert new one. If index is greater or equal array size new element will be inserted at the end of array.

Return Value

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

See Also

IPXS_PDFVariant