Sign in Join
FPDoc Onlineexperiment

THelpDatabases.ShowError procedure

Member of THelpDatabasespublicIn unit LazHelpIntf

Displays an error dialog for status result codes other than shrSuccess and shrCancel.

Declaration

pascal
procedure ShowError(ShowResult: TShowHelpResult; const ErrMsg: string)
 ; override

Arguments

ShowResult

Status result code examined in the method.

ErrMsg

Message displayed for the error condition.

Description

ShowError calls the MessageDlg routine to display an error dialog for status result codes other than shrSuccess and shrCancel. ShowError uses the value in ShowResult to determine the caption displayed on the message dialog, including:

Status codeCaption for the Dialog
shrNone rsHelpError
shrDatabaseNotFound rsHelpDatabaseNotFound
shrContextNotFound rsHelpContextNotFound
shrViewerNotFound rsHelpViewerNotFound
shrHelpNotFound rsHelpNotFound
shrViewerError rsHelpViewerError
shrSelectorError rsHelpSelectorError
Default for status codes other than shrSuccess and shrCancel rsUnknownErrorPleaseReportThisBug

A message dialog is not displayed when ShowResult contains the value shrSuccess or shrCancel.

ShowError is used in the implementation of the THelpDatabase.ShowError method.

See also

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