Retrieves an element or a collection from the given collection.
Syntax
HRESULT item( VARIANT name, VARIANT index, IDispatch **pdisp );
Parameters
- name
- VARIANT number or string that specifies the element or collection to retrieve. If this parameter is a number, the method returns the element in the collection at the given position, where the first element has value 0, the second has 1, and so on. If this parameter contains a string, the method returns a collection of elements, where the value of the name or id properties for each element is equal to the string.
- index
- VARIANT number that specifies the position of an element to retrieve. This parameter is used when name is a string. The method uses the string to construct a collection of all elements that have a name or id properties equal to the string, then retrieves from this collection the element at the position specified by index. The index determines which action to take.
- pdisp
- Address of a pointer to an IDispatch interface that receives the element object.
Return Value
Returns S_OK if successful, or an error code otherwise.
Remarks
This function returns an S_OK even if the element is not found. The developer should check the value of the pdisp pointer returned by this call. If the value of the pointer is NULL, the element was not found and the call was not successful.
Windows CE
Windows CE Use version 2.12 and later Minimum availability Internet Explorer 4.0