RAD Studio |  |

Asking the Help Manager for Information
See Also
Collapse All

Help viewers communicate with the Help Manager through the IHelpManager interface, an instance of which is returned to them when they register with the Help Manager. IHelpManager allows the Help viewer to communicate four things:

- A request for the window handle of the currently active control.
- A request for the name of the Help file which the Help Manager believes should contain help for the currently active control.
- A request for the path to that Help file.
- A notification that the Help viewer is shutting itself down in response to something other than a request from the Help Manager that it do so.

IHelpManager.GetHandle : LongInt is called by the Help viewer if it needs to know the handle of the currently active control; the result is a window handle.

IHelpManager.GetHelpFile: String is called by the Help viewer if it needs to know the name of the Help file which the currently active control believes contains its Help.

IHelpManager.Release is called to notify the Help Manager when a Help viewer is disconnecting. It should never be called in response to a request through ICustomHelpViewer.ShutDown; it is only used to notify the Help Manager of unexpected disconnects.

See Also

Enabling Help in Applications

Help System Interfaces

Communicating with the Help Manager

Implementing ICustomHelpViewer

Displaying Tables of Contents

Implementing IExtendedHelpViewer

Implementing IHelpSelector

Registering Help System Objects

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!