System.HelpIntfs.ISpecialWinHelpViewer.CallWinHelp

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function CallWinHelp(Handle: THandle; const HelpFile: string; Command: Word;
Data: NativeUInt): Boolean;

C++

virtual bool __fastcall CallWinHelp(NativeUInt Handle, const System::UnicodeString HelpFile, System::Word Command, NativeUInt Data) = 0 ;

Properties

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

Description

Pass Help request directly to engine.

The RTL Help System calls CallWinHelp when it receives a Windows-style Help request that cannot be generalized as a Topic-based or Context-based request. CallWinHelp should pass the request directly to the Windows winhelp() API or to a functional equivalent.

CallWinHelp should return true if it was able to handle the request.