DXmHelpSystemOpen(3X)DXmHelpSystemOpen(3X)NAMEDXmHelpSystemOpen - Completes initialization operations required by
LinkWorks and prepares to display a topic from the specified help file
name.
SYNOPSIS
void DXmHelpSystemOpen(help_context, main_window, help_file, routine,
tag)
Opaque *help_context;
Widget main_window;
char *help_file;
void ((*routine )()),
Opaque tag);
PARAMETERS
Used by the DECwindows Motif Help System to pass required LinkWorks and
help information from one routine to another. Note that help_context
must be defined globally; the DXmHelpSystemDisplay and DXmHelpSystem‐
Close routines subsequently use the address initially set for this
parameter. The identifier (ID) for the main window of the application.
The file name of the help file. The default specifications are as fol‐
lows:
────────────────────────────────────────
Default Description
────────────────────────────────────────
/usr/lib/X11/help/ Directory location
.decw_book File extension
────────────────────────────────────────
You can also provide your own location or extension along with
the help file name.
Note that help_file is required for this routine but is optional
for DXmHelpSystemDisplay. Used for error processing. If an
error occurs within the DECwindows Motif Help System and it can‐
not be processed by either LinkWorks or Bookreader, the DECwin‐
dows Motif Help System calls the error processing routine you
have included in your application and passes in an integer, or
status, to indicate the status of the error processing opera‐
tion, as follows:
───────────────────────────────────
Value Description
───────────────────────────────────
1 The DECwindows Motif Help
System could not find the
LinkWorks shareable image.
2 The DECwindows Motif Help
System could not translate
a specified value into a
valid file specification.
───────────────────────────────────
Note the following: The status parameter is a system-supplied
parameter that supplements the routine and tag parameters you
have already specified in the application. If an error cannot
be processed by either LinkWorks or Bookreader and you have not
specified a supplementary error handling routine, your system
will generate an access violation error message. The parameter
you supply to the previously described routine parameter. Asso‐
ciating a tag with the routine enables you to more easily deter‐
mine where errors occur.
DESCRIPTION
NOTE
This routine is not supported on all operating systems.
Within the DECwindows Motif Help System, the DXmHelpSystemOpen routine
completes all of the initialization operations required by LinkWorks,
such as creating a DECwindows user interface object and a surrogate
object, and then prepares to display a topic from the help file name
passed in. You should make the call to this routine just before the
main loop of your application.
RELATED INFORMATIONDXmHelpSystemClose(3X), DXmHelpSystemDisplay(3X)DXmHelpSystemOpen(3X)
