IPXS_PDFVariant::Arr_SetNameA Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IPXS_PDFVariant::Arr_SetNameA Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_SetNameA Method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetNameA|method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetNameA|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Replace specified element of array with new variant with type <code>PVT_Name</code> and specified value.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;nPos
 
;nPos
:[in]  Value of ULONG.
+
:[in]  Specifies index of element to replace. If it is greater or equal to array size function will return <code>E_INVALIDARG</code>.
 
;nAtom
 
;nAtom
:[in]  Value of ULONG.
+
:[in]  Specifies name atom (see [[PXV:PXS_Atoms]] description  for details).
 +
 
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 06:23, 21 August 2015


Replace specified element of array with new variant with type PVT_Name and specified value.

Syntax

HRESULT Arr_SetNameA([in]  ULONG  nPos,
                     [in]  ULONG  nAtom);

Parameters

nPos
[in] Specifies index of element to replace. If it is greater or equal to array size function will return E_INVALIDARG.
nAtom
[in] Specifies name atom (see Atoms description for details).


Return Value

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

See Also

IPXS_PDFVariant