Index for Section 3

Alphabetical listing for F

Bottom of page

fmtmsg(3)
NAME
  fmtmsg - Display a message in the specified format

SYNOPSIS
  #include <fmtmsg.h>

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

LIBRARY
  Standard C Library (libc)

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  fmtmsg(): XSH5.0

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

PARAMETERS
  classification
      Defines the source of the message and directs the display of the
      formatted 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:

  Major Classifications
      Identifies the source of the condition. The options are MM_HARD
      (hardware), MM_SOFT (software), and MM_FIRM (firmware).

  Message Source Subclassifications
      Identifies the software type that exhibits the problem. The options are
      MM_APPL (application), MM_UTIL (utility), MM_OPSYS, and (operating
      system).

  Display Subclassifications
      Identifies where the message is to be displayed. The options are
      MM_PRINT (standard error) or MM_CONSOLE (system console). One or both
      options may be used.

  Status Subclassifications
      Identifies 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 classification
      component is supplied for the message.

  label
      Identifies the message source. The label format consists of two fields
      separated 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.

  severity
      Indicates the seriousness of the condition. The options are as follows:

  MM_ERROR
      Indicates that application has encountered an error. Produces the
      string ERROR.

  MM_HALT
      Indicates that the application has stopped running because it has found
      a severe error. Produces the string HALT.

  MM_INFO
      Displays information about a nonerror condition. Produces the string
      INFO.

  MM_NOSEV
      Indicates that no severity level is provided for the message.

  MM_WARNING
      Indicates a condition that might be a problem and should be monitored.
      Produces the string WARNING.

  text
      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.

  action
      Describes the first action to be taken to recover from the error
      condition. The fmtmsg() function precedes every action string with the
      prefix TO FIX:. The action string has no maximum length.

  tag 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.

DESCRIPTION
  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
  classification 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:

Index for Section 3

Alphabetical listing for F

Top of page