Index Index for
Section 3X
Index Alphabetical
listing for D
Bottom of page Bottom of
page		 

DXmHelpSystemOpen(3X)


NAME

  DXmHelpSystemOpen - Completes initialization operations required by
  LinkWorks and prepares to display a topic from the specified help file
  name.


SYNOPSIS

  void DXmHelpSystemOpen(
	  Opaque *help_context,
	  Widget main_window,
	  char *help_file,
	  void ((*routine )()),
	  Opaque tag );


PARAMETERS

  help_context
      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
      DXmHelpSystemClose routines subsequently use the address initially set
      for this parameter.

  main_window
      The identifier (ID) for the main window of the application.

  help_file
      The file name of the help file.  The default specifications are as
      follows:

      _______________________________________
      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.

  routine
      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:

      __________________________________________________________________
      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.

  tag The parameter you supply to 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 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.


SEE ALSO

  DXmHelpSystemClose(3X), DXmHelpSystemDisplay(3X)

Index Index for
Section 3X
Index Alphabetical
listing for D
Top of page Top of
page