VXPLib Documentation: COM

IVXPQuickHTML::GetControlAttrIdx

Returns an attribute value specified in a tag <CONTROL>.
HRESULT GetControlAttrIdx(long Index, BSTR attrName, VXPTagAttribute attrType = taText, VARIANT * Value);
Parameters
Index [in] - Index of the requested tag <CONTROL>
attrName [in] - Name of the attribute. This function is not case-sensitive to the attribute name, and it ignores spaces
attrType [in, defaultvalue(taText)] - Type to which the return value must be converted (see remarks)
Value [out, retval] - Pointer to a VARIANT variable to return value of the attribute
Remarks
The function searches for a tag with the specified index, and then an attribute with name attrName defined within the tag. If the tag and attribute are found the function returns value of the attribute converted to a type requested by parameter attrType.
For description of all supported types of conversion see function GetBodyAttr

The function returns values of both standard and custom attributes. When the attribute is not found or not specified in the tag the function returns an empty value.
If the index is less than 0 or more than the value returned by GetControlsInfo(...) - 1 the function will throw exception ER_INDEXOUTOFRANGE.
See Also
IVXPQuickHTML Overview | GetBodyAttr | GetControlAttr | GetControlPos | GetControlsInfo | OnControlGetSize | <CONTROL>
This document was last updated on 19/05/2003
Copyright © 2003 Tooltips.NET