Sign in Join
FPDoc Onlineexperiment

TShowHelpResult enumeration

In unit HelpIntfs

Represents result codes returned by THelpManager.

Declaration

pascal
TShowHelpResult = (shrNone,shrSuccess,shrCancel,shrDatabaseNotFound,
 shrContextNotFound,shrViewerNotFound,shrHelpNotFound,
 shrViewerError,shrSelectorError)

Description

TShowHelpResult is an enumerated type with values that represent result codes for help requests using THelpManager. It is also the type returned from convenience methods like ShowTableOfContents, ShowHelpForKeyword, ShowHelpForPascalContexts, et. al.

See also

Values

shrNoneNo help result available (help error).
shrSuccessHelp request successfully completed.
shrCancelHelp request was canceled.
shrDatabaseNotFoundHelp database was not found.
shrContextNotFoundHelp database found, but the context was not found.
shrViewerNotFoundNo Help viewer registered for this format.
shrHelpNotFoundNo Help found for the keyword or directive.
shrViewerErrorHelp viewer could not display a help node.
shrSelectorErrorNo help node(s) found for the help selector.

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