item method

[This documentation is preliminary and is subject to change.]

Retrieves a form object or an object from an elements collection.

Syntax

IDispatch retVal = object.item(name, index);

Standards information

There are no standards that apply here.

Parameters

• name [in]
  Type: VARIANT

  VARIANT of type VT_I4 or VT_BSTR that specifies the object or collection to retrieve. If this parameter is an integer, it is the zero-based index of the object. If this parameter is a string, all objects with matching IHTMLDOMAttribute2::name or IHTMLElement::id properties are retrieved, and a collection is returned if more than one match is made.

• index [in, optional]
  Type: VARIANT

  VARIANT of type VT_I4 that specifies the zero-based index of the object to retrieve when a collection is returned.

Remarks

Note  This method indexes collections by the IHTMLDOMAttribute2::name or IHTMLElement::id property of the object; this is a known standards-compliance issue. For interoperability with other browsers, do not reference an object by IHTMLDOMAttribute2::name using this method.

Windows Internet Explorer 8 and later. In IE8 Standards mode, the index parameter is not used. For more information, see Defining Document Compatibility.

Call QueryInterface on the IDispatch interface pointer retrieved to pdisp to obtain the correct interface for the object or collection.

This function returns S_OK even if the element is not found. You should check the value of the pdisp (IDispatch) pointer returned by this call. If the value of the pointer is NULL, the element was not found and the call was not successful.

The IHTMLElementCollection::item method cannot retrieve input type=image elements from a form. To access all elements contained in a form, call QueryInterface on IHTMLFormElement and request an IHTMLElement interface. Use the children property of the IHTMLElement interface to retrieve a collection of all elements in the form.

Examples

The following general example shows how to use the IHTMLElementCollection::length property and item method to iterate through the option objects within a select object.

HRESULT GetOptions(IHTMLSelectElement *ppvSelect, BSTR *pszOptText, long *plItems)
{
    IDispatch *ppvdispOption;
    IHTMLOptionElement *ppvOption;
    HRESULT hResult;
    // Obtain the number of option objects in the select object.
    ppvSelect->get_length(plItems);
 
    for (long i=0;i<*plItems;i++){
        // Get an IDispatch interface for the next option.
        _variant_t index = i;
        hResult = ppvSelect->item( index, index, &ppvdispOption );
        if FAILED(hResult) return(hResult);
        // Query for the IHTMLOptionElement interface.
        hResult = ppvdispOption->QueryInterface( IID_IHTMLOptionElement, 
                                                 (void **) &ppvOption);
        ppvdispOption->Release();
        if FAILED(hResult) return(hResult);
        // Add the option text to a list box.
        hResult = ppvOption->get_text(&(pszOptText[i]));
        ppvOption->Release();
        if FAILED(hResult) return(hResult);
    }
    return S_OK;
}

Build date: 6/12/2012