Programming Guide

Displays a help window

int sm_hlp_by_name(char *help_screen);

help_screen

The name of the help screen to display.

• 0 Success.

• 1 Success: data was copied from the help screen to the underlying field.

• -1 Screen was not found or another error occurred.

sm_hlp_by_name displays and processes the specified screen as a Panther help screen. If the help screen has a data entry field, the function copies its data back to the underlying field, as if the help screen were specified in the widget's help_screen property and the user pressed HELP.

Refer to Chapter 12, "Providing Help Facilities," in Using the Editors for information about Panther help screen creation and behavior.

---

---