ISimpleList::get_Item, put_Item
.gif "Ee783877.c++_off(en-US,CS.10).gif")
.gif "Ee783877.vb_on(en-US,CS.10).gif")
The Item property is a read/write Variant that contains an element of the SimpleList object. An initialized Variant is stored at a specified array index. If an item is already stored at the specified index, that item is overwritten by the put procedure.
Definition
Get method:
HRESULT ISimpleList::get_Item(longIndex,VARIANT*Item);
Put method:
HRESULT ISimpleList::put_Item(longIndex,VARIANTItem);
Putref method:
HRESULT ISimpleList::putref_Item(longIndex,VARIANTItem);
Parameters
Index
[in] A long that contains the index of the item.
Item
[in] When putting the property, a Variant that contains the new item.
[out, retval] When getting the property, a Variant used to return the item.
Return Values
These methods return an HRESULT indicating whether or not they completed successfully. See the Error Values section for more details.
Error Values
These methods return S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.
The following table shows the custom COM errors that this method can return.
| Constant | Description |
| DISP_E_BADINDEX | The Index parameter references an out-of-range value. This means that Index contains a value either larger than the SimpleList or less than zero. |
Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.
Remarks
The Item parameter contains valid data only if the method completes successfully.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
When putting a value, use the putref_Item method if you are setting an object reference; use the put_Item method if you are setting a scalar value.