IPXS_PDFVariant::Arr_SetNameR Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
(6 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXS_PDFVariant::Arr_SetNameR Method}} | {{#customTitle:IPXS_PDFVariant::Arr_SetNameR Method}} | ||
− | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetNameR | + | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetNameR|method}} |
− | + | ||
{{ToReview}} | {{ToReview}} | ||
− | + | 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_SetNameR([in] ULONG nPos, | <pre class="brush:cpp;gutter:false">HRESULT Arr_SetNameR([in] ULONG nPos, | ||
− | [in] UCHAR* | + | [in] UCHAR* nVal, |
[in] ULONG nValLen);</pre> | [in] ULONG nValLen);</pre> | ||
== Parameters == | == Parameters == | ||
;nPos | ;nPos | ||
− | :[in] | + | :[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 | ;nValLen | ||
− | :[in] | + | :[in] Specifies number of bytes in raw name representation. |
== Return Value == | == Return Value == | ||
Line 25: | Line 25: | ||
== See Also == | == See Also == | ||
− | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | + | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] |
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 codes41 41
, or ASCII stringAA
). - 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.