Vcl.WinHelpViewer.IWinHelpTester

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

IWinHelpTester = interface(IInterface)

C++

__interface  INTERFACE_UUID("{B0FC9354-5F0E-11D3-A3B9-00C04F79AD3A}") IWinHelpTester  : public System::IInterface

Properties

Type Visibility Source Unit Parent
interface
class
public
Vcl.WinHelpViewer.pas
Vcl.WinHelpViewer.hpp
Vcl.WinHelpViewer Vcl.WinHelpViewer


Description

Methods of this interface help to maintain and analyze help files and lists of keywords, ALinks, context IDs, and help topics, which can be used in requests to the Windows WinHelp help API function.
The VCL does not provide the implementation of this interface. If you need to support its functionality, you must implement IWinHelpTester in your application.

Because the Microsoft WinHelp function does not support direct querying without displaying results, the Help Viewer itself must maintain and analyze lists of keywords, ALinks, context IDs, and help topics, which can be used in requests to WinHelp. Applications wanting to support this functionality must implement IWinHelpTester themselves. If the implementation of IWinHelpTester is absent, the WinHelp viewer will always assume that the query should succeed and WinHelp can be asked to provide help.

The WinHelpViewer unit is deprecated. Use Vcl.HtmlHelpViewer instead.

The WinHelpViewer unit implements the wrapper for the Windows WinHelp function API. Microsoft has deprecated WinHelp.

See Also