Sign in Join
FPDoc Onlineexperiment

THelpManager.DoHelpNotFound function

Member of THelpManagerpublicIn unit HelpIntfs

Performs actions when help is not available in the help manager.

Declaration

pascal
class function DoHelpNotFound(var ErrMsg: string): TShowHelpResult

Arguments

ErrMsg

Error message displayed when help is not available in the help manager.

Description

DoHelpNotFound is a TShowHelpResult class function used to perform actions when help cannot be displayed using the help manager instance. It sets the help result and error message when the help file, query, or context is not available (or implemented) in the help manager. The default implementation sets the return value to shrHelpNotFound, and sets ErrMsg to 'Help not found'.

DoHelpNotFound is called from help manager methods which display a given help type.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.