IPXS_PDFVariant::Arr_InsertName Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IPXS_PDFVariant::Arr_InsertName Method}} | {{#customTitle:IPXS_PDFVariant::Arr_InsertName Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_InsertName|method}} | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_InsertName|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_InsertName([in] LPWSTR | + | <pre class="brush:cpp;gutter:false">HRESULT Arr_InsertName([in] LPWSTR sVal, |
| − | [in, defaultvalue(-1)] ULONG | + | [in, defaultvalue(-1)] ULONG nBefore);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sVal |
| − | :[in] | + | :[in] Pointer to null-terminated Unicode string, which will be converted to name value. |
| − | ; | + | :Please note that this function has much lower performance than [[PXV:IPXS_PDFVariant_Arr_InsertNameA|Arr_InsertNameA]] because '''Unicode''' >> '''Raw data''' >> '''name''' conversion, so it is strongly not recommended to use it when adding 'common' pdf names. |
| − | :[in, defaultvalue(-1)] | + | ;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 == | == Return Value == | ||
Latest revision as of 04:13, 20 August 2015
Insert new variant with type PVT_Name and specified value into array container.
Syntax
HRESULT Arr_InsertName([in] LPWSTR sVal,
[in, defaultvalue(-1)] ULONG nBefore);
Parameters
- sVal
- [in] Pointer to null-terminated Unicode string, which will be converted to name value.
- Please note that this function has much lower performance than Arr_InsertNameA because Unicode >> Raw data >> name conversion, so it is strongly not recommended to use it when adding 'common' pdf names.
- 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.
