IPXS_PDFVariant::Arr_SetNameR Method

Revision as of 06:32, 21 August 2015

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

HRESULT Arr_SetNameR([in]  ULONG   nPos,
                     [in]  UCHAR*  nVal,
                     [in]  ULONG   nValLen);

nPos: [in] Specifies index of element to replace. If it is greater or equal to array size function will return E_INVALIDARG.
nVal: [in] Pointer to array of UCHAR values, which represent name in raw format (same bytes as stored in pdf file, except preciding "/" character and with #?? sequences decoded, for example /A#41 will be represented as two bytes array with hex codes 41 41, or ASCII string AA).; Please note that this function has lower performance than Arr_InsertNameA because Raw data >> name conversion, so it is strongly not recommended to use it when adding 'common' pdf names.
nValLen: [in] Specifies number of bytes in raw name representation.

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

@@ Line 6: / Line 6: @@
 {{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 ==
@@ Line 15: / Line 15: @@
 == Parameters ==
 ;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>.
 ;nVal
-:[in]  Pointer to UCHAR.
+:[in]  Pointer to array of UCHAR values, which represent name in raw format (same bytes as stored in pdf file, except preciding "'''/'''" character and with #?? sequences decoded, for example <code>/A#41</code> will be represented as two bytes array with hex codes <code>41 41</code>, or ASCII string <code>AA</code>).
+:Please note that this function has lower performance than [[PXV:IPXS_PDFVariant_Arr_InsertNameA|Arr_InsertNameA]] because '''Raw data''' >> '''name''' conversion, so it is strongly not recommended to use it when adding 'common' pdf names.
 ;nValLen
-:[in]  Value of ULONG.
+:[in]  Specifies number of bytes in raw name representation.
 == Return Value ==