Navigation

Operators and Keywords

Function List:

C++ API

Function File: h = helpdlg (msg)
Function File: h = helpdlg (msg, title)

Display msg in a help dialog box.

The message may have multiple lines separated by newline characters ("\n"), or it may be a cellstr array with one element for each line.

The optional input title (character string) can be used to set the dialog caption. The default title is "Help Dialog".

The return value is always 1.

See also: errordlg, inputdlg, listdlg, msgbox, questdlg, warndlg.

Demonstration 1

The following code

 disp ('- test helpdlg with a help message only.');
 helpdlg ("Below, you should see 3 lines:\nline #1\nline #2, and\nline #3.");

Produces the following output

- test helpdlg with a help message only.

Demonstration 2

The following code

 disp ('- test helpdlg with help message and caption.');
 helpdlg ('You should see a single line.','A help dialog');

Produces the following output

- test helpdlg with help message and caption.

Package: octave