Share via


CWnd::get_accHelp

Called by the framework to retrieve an object's Help property string.

virtual HRESULT get_accHelp( 
   VARIANT varChild, 
   BSTR *pszHelp 
);

Parameters

  • varChild
    Specifies whether the help information to be retrieved is that of the object or one of the object's child elements. This parameter can be either CHILDID_SELF (to obtain information about the object) or a child ID (to obtain information about the object's child element).

  • pszHelp
    Address of a BSTR that receives the localized string containing the help information for the specified object, or NULL if no help information is available.

Return Value

Returns S_OK on success, a COM error code on failure. See Return Values in IAccessible::get_accHelp in the Windows SDK.

Remarks

This function is part of MFC's Active Accessibility support.

Override this function in your CWnd-derived class to provide help text for your object.

For more information, see IAccessible::get_accHelp in the Windows SDK.

Requirements

Header: afxwin.h

See Also

Reference

CWnd Class

Hierarchy Chart

CWnd::get_accDescription

CWnd::get_accHelpTopic