IPXS_PDFVariant::Arr_Insert Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXS_PDFVariant::Arr_Insert Method}} | {{#customTitle:IPXS_PDFVariant::Arr_Insert Method}} | ||
| − | {{#parentPage:PXV:IPXS_PDFVariant|Arr_Insert | + | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_Insert|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Insert variant or its copy into array container. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 14: | ||
== Parameters == | == Parameters == | ||
;pItem | ;pItem | ||
| − | :[in] Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]. | + | :[in] Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]], that should be inserted. |
;nBefore | ;nBefore | ||
| − | :[in, defaultvalue(-1)] | + | :[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. |
;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 24: | Line 24: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | |
Latest revision as of 02:42, 15 June 2015
Insert variant or its copy into array container.
Syntax
HRESULT Arr_Insert([in] IPXS_PDFVariant* pItem,
[in, defaultvalue(-1)] ULONG nBefore,
[in, defaultvalue(0)] VARIANT_BOOL bClone);
Parameters
- pItem
- [in] Pointer to IPXS_PDFVariant, that should be inserted.
- nBefore
- [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.
- 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.
