IPXS_PDFVariant::Arr_SetNameR Method

From PDF XChange PDF SDK
Jump to: navigation, search
 
Line 3: Line 3:
 
{{#customTitle:IPXS_PDFVariant::Arr_SetNameR Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_SetNameR Method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetNameR|method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetNameR|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  

Latest revision as of 06:32, 21 August 2015


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

Syntax

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

Parameters

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.

Return Value

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

See Also

IPXS_PDFVariant