item method

  • Article

Retrieves an object from a TextRange collection.

Syntax

 retVal = object.item(pvarIndex);

Parameters

  • pvarIndex [in]
    Type: VARIANT

    Pointer to a 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.

Standards information

There are no standards that apply here.

Remarks

Always check the IDispatch pointer returned by this call, even if the method returns S_OK. If the value of the pointer is NULL, the element was not found and the call was not successful.

Upon successful return, the pvarResult parameter contains an IDispatch interface pointer or an array of IDispatch interface pointers that can be queried for a specific interface, depending on the collection type.

IHTMLTxtRangeCollection::item returns a VARIANT of type VT_DISPATCH that can be queried for IHTMLTxtRange.

Microsoft Internet Explorer 5 does not provide multiple selection. The default implementation of this method returns a collection consisting of a single TextRange object

Host applications can provide a multiple selection mechanism and can return a collection of TextRange objects that represents discontinuous selections.