Expand Minimize

IUIAutomationElement::CurrentHelpText property

Retrieves the help text for the element.

This property is read-only.

Syntax


HRESULT get_CurrentHelpText(
  [out, retval]  BSTR *retVal
);

Property value

Type: BSTR*

The help text.

Remarks

This information is typically obtained from tooltips.

Caution  Do not retrieve the CachedHelpText property from a control that is based on the SysListview32 class. Doing so could cause the system to become unstable and data to be lost. A client application can discover whether a control is based on SysListview32 by retrieving the CachedClassName or CurrentClassName property from the control.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista, Windows XP with SP3 and Platform Update for Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008, Windows Server 2003 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

See also

Reference
Automation Element Property IDs
IUIAutomationElement
CachedHelpText

 

 

Community Additions

ADD
Show:
© 2014 Microsoft