IPXS_PDFVariant::Arr_Set Method

From PDF XChange PDF SDK
Jump to: navigation, search

Replace specified element of array with supplied variant or its clone. To insert variant into array please use IPXS_PDFVariant::Arr_Insert function.


HRESULT Arr_Set([in]                   ULONG             nPos,
                [in]                   IPXS_PDFVariant*  pItem,
                [in, defaultvalue(0)]  VARIANT_BOOL      bClone);


[in] Specifies index of element to replace. If it is greater or equal to array size function will return E_INVALIDARG.
[in] Pointer to IPXS_PDFVariant, that should be inserted.
[in, defaultvalue(0)] Determine will we insert original variant or its clone. Please note that it is strongly not recommended to insert one direct variant into more that one container as it may result unpredictable behavior. If you need to insert exactly same value into more than one container you should make it indirect and insert clone of this indirect value (yes, will be inserted clone of indirect reference, but not value itself).

Return Value

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

See Also

IPXS_PDFVariant::Arr_Insert, IPXS_PDFVariant