Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dxmhelpsystemdisplay(3x) [osf1 man page]

DXmHelpSystemDisplay(3X)												  DXmHelpSystemDisplay(3X)

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

knlist(3)						     Library Functions Manual							 knlist(3)

knlist - Look up symbols in the currently running kernel LIBRARY
Standard C Library (libc.a, SYNOPSIS
#include <nlist.h> int knlist( struct nlist namelist); PARAMETERS
On input, lists the symbol names for which you are requesting addresses. The namelist must be terminated with a null name at end. Without a terminating null name at end, knlist() cannot determine how many symbols there are in the namelist and therefore it may dump core. On return, contains a list of symbol addresses (or 0 if the attempt to find the addresses was unsuccessful). DESCRIPTION
The knlist() library routine looks up addresses of kernel symbols in the currently running kernel. In addition to finding symbols associ- ated with the kernel image, knlist() will also find symbols defined in dynamically loaded subsystems. Communication with the knlist() routine occurs using an array of type struct nlist. The <nlist.h> header file declares that type as fol- lows: struct nlist{ char *n_name; unsigned long n_value; short n_type; /* 0 if not there, 1 if found */ short reserved; }; When your application calls knlist() it passes the names of symbols in the n_name field of the structure. For each symbol, the knlist() routine attempts to determine its current address in memory. If the routine can determine the address of the symbol, it returns that address in the n_value field, and it returns one(1) in the n_type field. If the routine cannot determine the address, it returns zero(0) in both the n_value field and the n_type field. For BSD compatibility, the knlist routine allows symbol names to be preceded by an underscore. If it does not find a symbol that matches the name as specified, knlist attempts to locate the symbol name with the leading underscore removed. EXAMPLES
The following example illustrates the use of the knlist() routine: #include <stdio.h> #include <string.h> #include <stdlib.h> #include <nlist.h> main () { struct nlist nl[3]; int retval, i; nl[0].n_name = (char *)malloc(10); nl[1].n_name = (char *)malloc(10); nl[2].n_name = ""; /*******************************************************/ /* Store names of kernel symbols in the nl array */ strcpy (nl[0].n_name, "ncpus"); strcpy (nl[1].n_name, "lockmode"); /*******************************************************/ /* Call the knlist routine */ retval = knlist(nl); /******************************************************/ /* Display addresses if returned. Otherwise, display */ /* the appropriate error message. */ if (retval < 0) printf ("No kernel symbol addresses returned. "); else if (retval >= 0 ) for (i=0; i<2; i++) if (nl[i].n_type == 0) printf ("Unable to return address of symbol %s ", nl[i].n_name); else printf ("The address of symbol %s is %lx ", nl[i].n_name, nl[i].n_value); free (nl[0].n_name); free (nl[1].n_name); } This example tests the return value from the knlist() routine. If the routine returns an error status, a message is displayed to the application user. Otherwise, the application checks the status of each kernel symbol. If the knlist() routine was unable to return an address, the application displays a message and the symbol name. If the knlist() routine returns an address, the application displays the symbol name and address to the application user. RETURN VALUES
The knlist() routine returns zero on success. The routine returns -1 if it was unable to connect to the kloadsrv daemon. In this case, the routine was unable to determine any of the requested addresses. The routine returns a positive integer if it successfully finds some addresses and fails to find others. The integer value indicates the number of addresses knlist() was unable to return. The routine returns the negative value of EINVAL if the argument is bad. RELATED INFORMATION
Routines: nlist(3) delim off knlist(3)
Man Page