Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dxmhelpsystemdisplay(3x) [osf1 man page]

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". Pointers 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 process- ing. If an error occurs within the DECwindows Motif Help System and it cannot be processed by either LinkWorks or Bookreader, the DECwin- dows 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. 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) DXmHelpSystemDisplay(3X)

Check Out this Related Man Page

gss_display_status(3)					     Library Functions Manual					     gss_display_status(3)

NAME
gss_display_status() - provide an application with the textual representation of a GSSAPI status code that can be displayed to a user or used for logging SYNOPSIS
DESCRIPTION
The routine provides the context initiator with a textual representation of a status code so that the application can display the message to a user or log the message. Because some status values can indicate more than one error, the routine enables the calling application to process status codes with multiple messages. The message_context parameter indicates which error message the application should extract from the status_value parameter. The first time an application calls the routine, it should initialize the message_context parameter to 0 (zero) and return the first message. If there are additional messages to read, the routine returns a nonzero value. The application can call repeatedly to generate a single text string for each call. Input Parameters status_value Specifies the status value to convert. status_type Specifies one of the following status types: Major status - GSS status code Minor status - mechanism status code eg. Kerberos mech_type Specifies the underlying security mechanism. Supply to obtain the system default. Input/Output message_context Indicates whether the status code has multiple messages to read. The first time an application calls the routine, you initialize the parameter to 0 (zero). The routine returns the first message. If there are more messages, the routine sets the parameter to a nonzero value. The application calls the routine repeatedly to get the next message, until the message_context parameter is zero again. Output status_string Returns the status value as a text message. minor_status Returns a status code from the security mechanism. STATUS CODES
The following status codes can be returned: The routine was completed successfully. The translation requires a mechanism that is unsupported or unavailable. Indicates either the status value was not recognized or the status type was something other than or The routine failed. Check the minor_status for details. AUTHOR
was developed by Sun Microsystems, Inc. SEE ALSO
The manpages for DCE-GSSAPI are included with the DCE-CoreTools product. To see those manpages add to gss_display_status(3)
Man Page