Share via

IHTMLElement::id Property

  • Article

Sets or retrieves the string identifying the object.

Syntax

HRESULT IHTMLElement::get_id(BSTR *p);
HRESULT IHTMLElement::put_id(BSTR v);

Parameters

  • p
    Pointer to a variable of type BSTR that receives any alphanumeric string that begins with a letter. The underscore (_) can also be used.
  • v
    BSTR that specifies any alphanumeric string that begins with a letter. The underscore (_) can also be used.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

The IHTMLElement::id is an SGML identifier used as the target for hypertext links or for naming particular objects in associated style sheets.

The IHTMLElement::id should be unique throughout the scope of the current document. If a document contains more than one object with the same identifier, the objects are exposed as a collection that can be referenced only in ordinal position.

In versions earlier than Microsoft Internet Explorer 5, this property is read-only.