CWnd::get_accDescription

  • Article

 

Called by framework to retrieve a string that describes the visual appearance of the specified object.

Syntax

      virtual HRESULT get_accDescription(
   VARIANT varChild,
   BSTR *pszDescription
);

Parameters

  • varChild
    Specifies whether the description 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).

  • pszDescription
    Address of a BSTR that receives a localized string describing the specified object, or NULL if no description is available for this object.

Return Value

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

Remarks

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

Override this function in your CWnd-derived class to describe your object. Call the base class version and add your description.

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

Requirements

Header: afxwin.h

See Also

CWnd Class
Hierarchy Chart
CWnd::get_accHelp
CWnd::get_accName
CWnd::get_accRole
CWnd::get_accState
CWnd::get_accValue