Export (0) Print
Expand All
Expand Minimize

CWnd::get_accHelpTopic

Called by the framework to retrieve the full path of the WinHelp file associated with the specified object and the identifier of the appropriate topic within that file.

virtual HRESULT get_accHelpTopic(
   BSTR *pszHelpFile,
   VARIANT varChild,
   long *pidTopic
);

Parameters

pszHelpFile
Address of a BSTR that receives the full path of the WinHelp file associated with the specified object, if any.
varChild
Specifies whether the Help topic 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 a Help topic for the object) or a child ID (to obtain a Help topic for one of the object's child elements).
pidTopic
Identifies the Help file topic associated with the specified object. See pidTopic in IAccessible::get_accHelpTopic in the Platform SDK.

Return Value

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

Remarks

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

Override this function in your CWnd-derived class to provide help information about your object.

For more information, see IAccessible::get_accHelpTopic in the Platform SDK.

See Also

CWnd Overview | Class Members | Hierarchy Chart | CWnd::get_accDescription | CWnd::get_accHelp

Show:
© 2014 Microsoft