SilverScreen Solid Modeler

pm_help_file

pm_help_file

Previous topic Next topic  

pm_help_file

Previous topic Next topic JavaScript is required for the print function  

SilverScreenAPI

 

void pm_help_file ( char *help_file )

 

char *help_file;    // help file name

 

 

 




Synopsis

#include "silver.h"

 

The pm_help_file function assocates a panel with a text file containing help information. This function must be executed after pm_initialize and before pm_execute . When the panel is displayed, a help button will appear in the panel. By pressing this button, the user can display the information contained in the text file.

 

There is no special format for the help file text.

 

 

Parameters

help_file is a null-terminated string containing the name of the help file.

 

 

Return Value

none.

 

 

Comments

Text files many be stored in executable libraries. If the text file file3.txt is stored in the library helplib, then the file could be accessed by:

C / C++ Code

 

 pm_help_file ( "helplib>file3.txt" );

 

 

 

See Also

pm_execute , pm_help_line