DXmHelpSystemDisplay man page on Tru64

Man page or keyword search:  
man Server   12896 pages
apropos Keyword Search (all sections)
Output format
Tru64 logo
[printable version]

DXmHelpSystemDisplay(3X)			      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
       Used by the DECwindows Motif Help System to pass required LinkWorks and
       help information from one routine to another.  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.	 One of two values: “topic” or “dir”.	Point‐
       ers  to these strings can be passed instead.  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.	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.	 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.

       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)

						      DXmHelpSystemDisplay(3X)
[top]
                             _         _         _ 
                            | |       | |       | |     
                            | |       | |       | |     
                         __ | | __ __ | | __ __ | | __  
                         \ \| |/ / \ \| |/ / \ \| |/ /  
                          \ \ / /   \ \ / /   \ \ / /   
                           \   /     \   /     \   /    
                            \_/       \_/       \_/ 
More information is available in HTML format for server Tru64

List of man pages available for Tru64

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net