IPXS_PDFVariant::Arr_Set Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXS_PDFVariant::Arr_Set Method}} | {{#customTitle:IPXS_PDFVariant::Arr_Set Method}} | ||
− | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_Set | + | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_Set|method}} |
− | + | ||
{{ToReview}} | {{ToReview}} | ||
− | + | Replace specified element of array with supplied variant or its clone. To insert variant into array please use [[PXV:IPXS_PDFVariant_Arr_Insert|IPXS_PDFVariant::Arr_Insert]] function. | |
== Syntax == | == Syntax == | ||
Line 15: | Line 14: | ||
== Parameters == | == Parameters == | ||
;nPos | ;nPos | ||
− | :[in] | + | :[in] Specifies index of element to replace. If it is greater or equal to array size function will return <code>E_INVALIDARG</code>. |
;pItem | ;pItem | ||
− | :[in] | + | :[in] Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]], that should be inserted. |
;bClone | ;bClone | ||
− | :[in, defaultvalue(0)] | + | :[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 == | == Return Value == | ||
Line 25: | Line 24: | ||
== See Also == | == See Also == | ||
− | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | + | [[PXV:IPXS_PDFVariant_Arr_Insert|IPXS_PDFVariant::Arr_Insert]], [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] |
Latest revision as of 03:42, 15 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 nPos, [in] IPXS_PDFVariant* pItem, [in, defaultvalue(0)] VARIANT_BOOL bClone);
Parameters
- nPos
- [in] Specifies index of element to replace. If it is greater or equal to array size function will return
E_INVALIDARG
. - pItem
- [in] Pointer to IPXS_PDFVariant, that should be inserted.
- bClone
- [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.