IPXS_PDFVariant::Arr_Set Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Arr_Set([in] ULONG | + | <pre class="brush:cpp;gutter:false">HRESULT Arr_Set([in] ULONG Pos, |
| − | [in] IPXS_PDFVariant* | + | [in] IPXS_PDFVariant* Item, |
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL Clone);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;Pos |
:[in] Specifies index of element to replace. If it is greater or equal to array size function will return <code>E_INVALIDARG</code>. | :[in] Specifies index of element to replace. If it is greater or equal to array size function will return <code>E_INVALIDARG</code>. | ||
| − | ; | + | ;Item |
:[in] Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]], that should be inserted. | :[in] Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]], that should be inserted. | ||
| − | ; | + | ;Clone |
:[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). | :[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). | ||
Revision as of 07:18, 12 June 2015
Replace specified element of array with supplied variant or its clone. To insert variant into array please use IPXS_PDFVariant::Arr_Insert function.
Syntax
HRESULT Arr_Set([in] ULONG Pos,
[in] IPXS_PDFVariant* Item,
[in, defaultvalue(0)] VARIANT_BOOL Clone);
Parameters
- Pos
- [in] Specifies index of element to replace. If it is greater or equal to array size function will return
E_INVALIDARG. - Item
- [in] Pointer to IPXS_PDFVariant, that should be inserted.
- Clone
- [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.
