Navigation

Operators and Keywords

Function List:

• » Octave core
• » by package
• » alphabetical

C++ API

: h = helpdlg ()

: h = helpdlg (msg)

: h = helpdlg (msg, title)

Display a help dialog box with help message msg and caption title.

The default help message is "This is the default help string." and the default caption is "Help Dialog".

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

The return value h is always 1.

Examples:

helpdlg ("Some helpful text for the user.");
helpdlg ("Some helpful text\nwith two lines.");
helpdlg ({"Some helpful text", "with two lines."});
helpdlg ("Some helpful text for the user.", "Fancy caption");

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

Package: octave