IHTMLElementCollection::tags Method

Retrieves a collection of objects that have the specified HTML tag name.

Syntax

Copy

HRESULT tags(
    VARIANT tagName,
    IDispatch **pdisp
);

Parameters

tagName

[in] VARIANT of type BSTR that specifies an HTML tag. It can be any one of the objects exposed by the DHTML Object Model.

pdisp

Address to a pointer that returns a collection of element objects if successful, or null otherwise.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

Successful execution includes the case where no elements having the given name are found. In this case, a collection containing zero elements is returned.

The IHTMLElementCollection::length property of the collection contains the number of elements in the collection.

NULL may be returned in cases where the collection cannot be constructed, such as inability to allocate memory for even a zero-length collection.