fmtmsg man page on DigitalUNIX

Printed from

fmtmsg(3)							     fmtmsg(3)

       fmtmsg - Display a message in the specified format

       #include <fmtmsg.h>

       int fmtmsg(
	       long classification,
	       const char *label,
	       int severity,
	       const char *text,
	       const char *action,
	       const char *tag );

       Standard C Library (libc)

       Interfaces  documented on this reference page conform to industry stan‐
       dards as follows:

       fmtmsg(): XSH5.0

       Refer to the standards(5) reference page	 for  more  information	 about
       industry standards and associated tags.

       Defines	the  source of the message and directs the display of the for‐
       matted message, using the classes of identifiers listed below. Any  one
       identifier  from	 a  subclass  can be combined with a single identifier
       from a different subclass. Using two or more identifiers from the  same
       subclass	 is  not  allowed,  with the exception of identifiers from the
       Display subclass. (Both Display subclass identifiers  may  be  used  so
       that  messages  can  be displayed to both standard error and the system
       console). The  following	 identifiers  are  available:  Identifies  the
       source  of  the	condition. The options are MM_HARD (hardware), MM_SOFT
       (software), and MM_FIRM (firmware).  Identifies the software type  that
       exhibits	 the  problem.	The options are MM_APPL (application), MM_UTIL
       (utility), MM_OPSYS, and (operating system).  Identifies where the mes‐
       sage  is	 to be displayed. The options are MM_PRINT (standard error) or
       MM_CONSOLE (system console). One or both options may be used.   Identi‐
       fies  whether  the  application	will  recover  from the condition. The
       options are MM_RECOVER (can recover) or MM_NRECOV (cannot recover).

	      An additional identifier, MM_NULLMC, indicates that no classifi‐
	      cation  component	 is  supplied for the message.	Identifies the
	      message source. The label format consists of  two	 fields	 sepa‐
	      rated  by	 a  colon. The first field can contain up to 10 bytes.
	      The second field can contain up to 14  bytes.  It	 is  suggested
	      that  label contain at least the name of the application.	 Indi‐
	      cates the seriousness of the condition. The options are as  fol‐
	      lows:  Indicates that application has encountered an error. Pro‐
	      duces the string ERROR.	Indicates  that	 the  application  has
	      stopped  running	because	 it has found a severe error. Produces
	      the string HALT.	Displays information about a  nonerror	condi‐
	      tion.  Produces  the  string  INFO.   Indicates that no severity
	      level is provided for the message.  Indicates a  condition  that
	      might  be a problem and should be monitored. Produces the string
	      WARNING.	Describes the error that  produced  the	 message.  The
	      text  string has no maximum length. If the text string is empty,
	      the text produced is unspecified.	 Describes the first action to
	      be taken to recover from the error condition. The fmtmsg() func‐
	      tion precedes every action string with the prefix TO  FIX:.  The
	      action  string  has  no  maximum length.	Points the user to the
	      online documentation for the message. It is suggested  that  tag
	      include  the  label  as well as a unique identifying number. For
	      example, program:subroutine:003.

       The fmtmsg() function writes a formatted	 message  to  either  standard
       error,  the  system  console, or both. Any message typically written to
       standard error (stderr) by printf() can also  be	 displayed  using  the
       fmtmsg() function.

       A formatted message consists of up to five components (label, severity,
       text, action, and tag), as described in the previous section. The clas‐
       sification  component  is  not part of a message displayed to the user,
       but defines the source of the message and directs the  display  of  the
       formatted message.

       To  omit	 any  field  from  messages, use the null value of the field's
       parameter, as shown in the following table:


List of man pages available for DigitalUNIX

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]
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