IPXS_PDFVariant::Arr_InsertName Method

From Tracker Software PDF SDK
Revision as of 04:13, 20 August 2015 by Lzcat (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


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.

See Also

IPXS_PDFVariant