System.HelpIntfs.IHelpSystem.Hook

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function Hook(Handle: THandle; const HelpFile: string; Comand: Word; Data: NativeInt): Boolean;

C++

virtual bool __fastcall Hook(NativeUInt Handle, const System::UnicodeString HelpFile, System::Word Comand, NativeInt Data) = 0 ;

Properties

Type Visibility Source Unit Parent
function public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs IHelpSystem

Description

Do a WinHelp-style Help request.

Hook accepts Help requests that uses the same conventions as the Microsoft Windows WinHelp API. Hook should only be called for requests that cannot be translated into calls to ShowContextHelp, ShowHelp, ShowTableOfContents, or ShowTopicHelp.

Note: If the Help System is unable to decipher the Help request, it looks for a Viewer that implements ISpecialWinHelpViewer. If the application has registered such a viewer, the request succeeds if the Viewer is able to handle it. Otherwise the request fails.