This function is used to call the appropriate help page from within your module.

 

int  Fct_Help(

          char *page,

          char *bookmark=NULL

) ;

 

If you have prepared HTML help pages for your module, this function can be used to call it from sliceOmatic. The name of your HTML page is used in the argument "page".

 

The Fct_Help function will first look for your page using the name you provide.  So, if the file "name" exist, it will be used directly.

 

If not, it will look in the $INTERFACE_HELP_LOCAL directory with the name:

$INTERFACE_HELP_LOCAL\page

 

If it can not find your page there, then it will use the name:

$INTERFACE_HELP_INDEX\topic\page

 

So you can place your help pages in a "local" directory, or you can provide them to TomoVision so that they can be placed on the web site at the appropriate location.

 

For example, the following code:

 

 

// --- Get a pointer to the LOCAL help path ---

char **Interface_Help_Local = (char *) Fct_Variable_Get( "$INTERFACE_HELP_LOCAL" ) ;

 

// --- Momentarily hijack the path ---

char *keep_path = *Interface_Help_Local ;

*Interface_Help_Local = NULL ;

STRDUP( *Interface_Help_Local, "c:\temp\local_help" ) ;

 

Fct_Help( "My_Help_Page.htm" ) ;

 

// --- reset the path ---

FREE( *Interface_Help_Local ) ;

*Interface_Help_Local = keep_path;

 

 

Will cause sliceOmatic to look for the HTML page located at:

 

"My_Help_Page.htm" in the local directory.

 

If the page does not exist, it will look for:

"c:\temp\local_help\My_Help_Page.htm"

 

if the page does not exit, then it will look at:

"http://www.tomovision.com/sliceO_Help/topic/My_Help_Page.htm"

 

You can also specify a bookmark in the page with the "bookmark" argument.

 

For example, replacing the previous function by:

Fct_Help( "My_Help_Page.htm", "my_bookmark" )

 

will cause to program to open the page

My_Help_Page.htm#my_bookmark