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

DXmHelpSystemDisplay(3X)


NAME

  DXmHelpSystemDisplay - Displays a topic or directory of the help file in
  Bookreader.


SYNOPSIS

  void DXmHelpSystemDisplay(
	  Opaque help_context,
	  char *help_file,
	  char *keyword,
	  char *name,
	  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.

  help_file
      Optional.	 The file name of the help file. If Null or is supplied,
      Bookreader will use the help file name passed in to the
      DXmHelpSystemOpen routine; otherwise a new file name can be passed.

  keyword
      One of two values: "topic" or "dir".  Pointers to these strings can be
      passed instead.

  name
      The topic symbol from the help callback if "topic" is used for the
      keyword. If "dir" is used, then name refers to the name of the
      Bookreader directory that should be opened, such as "Contents" or
      "Index". Either specific strings or pointers to strings may be passed
      in.

  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.

  The DXmHelpSystemDisplay routine (which you use instead of a call to the
  help widget) displays a topic or directory of the help file in Bookreader,
  using the DECwindows Motif Help System.  This routine can also be used to
  display topics or directories of books other than the ones passed in to
  DXmHelpSystemOpen.


SEE ALSO

  DXmHelpSystemDisplay(3X), DXmHelpSystemOpen(3X)

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