IPXS_PDFVariant::Arr_Insert Method

From PDF XChange PDF SDK
Jump to: navigation, search

Insert variant or its copy into array container.


HRESULT Arr_Insert([in]                    IPXS_PDFVariant*  pItem,
                   [in, defaultvalue(-1)]  ULONG             nBefore,
                   [in, defaultvalue(0)]   VARIANT_BOOL      bClone);


[in] Pointer to IPXS_PDFVariant, that should be inserted.
[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.
[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