hiModalDBoxHelp

hiModalDBoxHelp(
t_helpString 
[ t_dboxName ]
)
=> t / nil

Description

Displays a message in a modal dialog box. A modal dialog box is a blocking dialog box—it waits for an acknowledgement before allowing the application to continue.

hiModalDBoxHelp is a service routine for the online help system.

Arguments

t_helpString	The string to be formatted into the modal dialog box.
t_dboxName	The name of the modal dialog box. If you do not provide this argument, the dialog box is assigned the name modalDBoxHelp. Clicking the Help button on this dialog box generates a call to hiHelp with dbox as objType and the dialog box name as objName.

Values Returned

t	The dialog box is displayed.
nil	There was an error.

Examples

Displays the message "This is a help message." in a modal dialog box.

hiModalDBoxHelp( "This is a help message.") 

Related Topics

Online Help Functions

Return to top