IPXS_PDFVariant::Arr_SetName Method

PDF Structures Layer > Interfaces > IPXS_PDFVariant > IPXS_PDFVariant::Arr_SetName Method

Replace specified element of array with new variant with type PVT_Name and specified value.

Syntax

HRESULT Arr_SetName([in]  ULONG   nPos,
                    [in]  LPWSTR  sVal);

Parameters

nPos

[in] Specifies index of element to replace. If it is greater or equal to array size function will return E_INVALIDARG.

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_SetNameA because Unicode >> Raw data >> name conversion, so it is strongly not recommended to use it when set 'common' pdf names

Return Value

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

See Also

IPXS_PDFVariant