HelpIntfs.RegisterViewer

Delphi Information

From HelpIntfs.pas

	function RegisterViewer(const newViewer: ICustomHelpViewer; out Manager: IHelpManager): Integer;

Unit: HelpIntfs

Type: function

Visibility: public

C++ Information

From HelpIntfs.hpp

	int __fastcall RegisterViewer(System::DelphiInterface<Helpintfs::ICustomHelpViewer> newViewer, System::DelphiInterface<Helpintfs::IHelpManager> & Manager);

Unit: HelpIntfs

Type: function

Description

Register Help Viewer to receive requests.

Call RegisterViewer to register a Help Viewer with the Help System. An application can register any number of Viewers. The order in which Help Viewers are registered is significant, because each Help request causes the RTL Help System to poll the Viewers in the order they were registered, and give the Help request to the first viewer that claims to be able to handle it. An application can override this behavior for keyword-based Help requests and for requests to display a Table of Contents by providing a Help Selector object.

Pass the Viewer object in the newViewer parameter.

RegisterViewer returns a Help Manager object in the Manager parameter; the Viewer uses this object to interact with the Help System.

The return value of RegisterViewer is 1 is the Viewer was successfully registered, 0 otherwise.