progeCAD Manual ⤴

sds_help

sds_help

int sds_help (wchar_t *helpfile, wchar_t *id, int flag);

Display the Help window.

This function displays a help file. The three arguments are passed to the Windows Help engine.

The argument helpfile specifies name of the HLP file.

The id argument specifies the topic ID string, which brings up a specific topic, such as a command name. When missing, progeCAD displays the first topic of the Help file.

The flag argument displays one of the following:

Flag Meaning
help_contents Display the initial topic in the HLP file.
help_helponhelp Display help on using help.
help_partialkey Display the Search dialog box using topic as the search text.

This function returns RTNORM or RTERROR when the Help file cannot be found.

NOTE This function should be attached to the dialog box's Help button in your DCL file. For more information on creating a dialog box with a Help button, see these topics in the DCL Programming Reference: ok_cancel_help, ok_cancel_help_errtile, ok_cancel_help_info.

Tell me about...

Programming Overview of SDS (Solutions Development System)