ISimpleList::get_Item, put_Item Property
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
The Item property is a read/write Variant that contains an item 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.
HRESULT ISimpleList::get_Item(
long Index,
VARIANT* Item
);
HRESULT ISimpleList::put_Item(
long Index,
VARIANT Item
);
HRESULT ISimpleList::putref_Item(
long Index,
VARIANT Item
);
Property Item(
Index As Long
) As Variant
Parameters
Index
[C++][in] A long that contains the index of the item.
[Visual Basic]
A Long that contains the index of the item.
Item
[C++][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
[C++]
These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.
[Visual Basic]
None.
Error Values
[C++]
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.
[Visual Basic]
This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM 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. |
[C++]
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.
[Visual Basic]
Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
Remarks
[C++]
The Item parameter contains valid data only if the method completes successfully.
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.