Content-type: text/html Man page of DXmHelpSystemClose

DXmHelpSystemClose

Section: Miscellaneous Library Functions (3X)
Index Return to Main Contents
 

NAME

DXmHelpSystemClose - Closes all of the remaining topic and navigation windows in Bookreader.  

SYNOPSIS

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

PARAMETERS

Used by the DECwindows Motif Help System to pass required LinkWorks and help information from one routine to another. Used 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:


ValueDescription

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 for the previously described routine parameter. Associating a tag with the routine enables you to more easily determine where errors occur.
 

DESCRIPTION

Note

This routine is not supported on all operating systems.

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.
 

SEE ALSO

DXmHelpSystemDisplay(3X), DXmHelpSystemOpen(3X)


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:41:16 GMT, October 02, 2010