System.HelpIntfs.ICustomHelpViewer.UnderstandsKeyword

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function  UnderstandsKeyword(const HelpString: string): Integer;

C++

virtual int __fastcall UnderstandsKeyword(const System::UnicodeString HelpString) = 0 ;

Properties

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

Description

Responds to a keyword-based Help request.

The Help System calls UnderstandsKeyword to determine whether the Help Viewer can provide Help topics for a keyword-based Help request based on HelpString. UnderstandsKeyword should return the number of Help topics that match the request. If the Help viewer does not support help on this keyword, UnderstandsKeyword should return zero.

See Also