Vcl.WinHelpViewer.IWinHelpTester.CanShowTopic

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function CanShowTopic(const Topic, FileName: String): Boolean;

C++

virtual bool __fastcall CanShowTopic(const System::UnicodeString Topic, const System::UnicodeString FileName) = 0 ;

Properties

Type Visibility Source Unit Parent
function public
Vcl.WinHelpViewer.pas
Vcl.WinHelpViewer.hpp
Vcl.WinHelpViewer IWinHelpTester


Description

Queries whether the Help System can show the help topic, which is specified by the keyword and which is located in the specified help file.

CanShowTopic returns True if the Help System can show the help topic, which is specified by the Topic keyword and which is located in the specified FileName help file. Otherwise, CanShowTopic returns False.

VCL does not provide an implementation of the IWinHelpTester interface. Therefore, if you need to use this function, you must implement IWinHelpTester in your application.

The TWinHelpViewer class, implemented in the implementation section of the Vcl.WinHelpViewer unit, uses CanShowTopic in the TWinHelpViewer.UnderstandsTopic function. TWinHelpViewer.UnderstandsTopic implements the System.HelpIntfs.IExtendedHelpViewer.UnderstandsTopic function when you specify the Vcl.WinHelpViewer unit in the uses section of your program.

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