DXmHelpSystemClose(3X) — Subroutines

Digital

NAME

DXmHelpSystemClose − Closes all of the remaining topic and navigation windows in Bookreader. This routine is not supported on all operating systems.

SYNOPSIS

void DXmHelpSystemClose(help_context, routine, tag)
   Opaque help_context;
   void ((∗routine )()),
   Opaque tag );

DESCRIPTION

Within the DECwindows Motif Help System, the DXmHelpSystemClose routine closes all of the remaining topic and navigation windows in the Bookreader. You should call this routine when your application is closing all of its other windows.

Arguments

help_context
Used by the DECwindows Motif Help System to pass required LinkWorks and help information from one routine to another.

routineUsed for error processing. If an error occurs within the DECwindows Motif Help System and it cannot be processed by either LinkWorks or Bookreader, the DECwindows 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 operation, 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:

•status, is a system-supplied argument that supplements the routine and tag arguments 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.

tagThe argument you supply for the previously described routine argument. Associating a tag with the routine enables you to more easily determine where errors occur.

RELATED INFORMATION