logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

fmtmsg.h.0p (3595B)

    

  1. '\" et
  2. .TH fmtmsg.h "0P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. fmtmsg.h
  12. \(em message display structures
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <fmtmsg.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <fmtmsg.h> 
  21. header shall define the following symbolic constants:
  22. .IP MM_HARD 14
  23. Source of the condition is hardware.
  24. .IP MM_SOFT 14
  25. Source of the condition is software.
  26. .IP MM_FIRM 14
  27. Source of the condition is firmware.
  28. .IP MM_APPL 14
  29. Condition detected by application.
  30. .IP MM_UTIL 14
  31. Condition detected by utility.
  32. .IP MM_OPSYS 14
  33. Condition detected by operating system.
  34. .IP MM_RECOVER 14
  35. Recoverable error.
  36. .IP MM_NRECOV 14
  37. Non-recoverable error.
  38. .IP MM_HALT 14
  39. Error causing application to halt.
  40. .IP MM_ERROR 14
  41. Application has encountered a non-fatal fault.
  42. .IP MM_WARNING 14
  43. Application has detected unusual non-error condition.
  44. .IP MM_INFO 14
  45. Informative message.
  46. .IP MM_NOSEV 14
  47. No severity level provided for the message.
  48. .IP MM_PRINT 14
  49. Display message on standard error.
  50. .IP MM_CONSOLE 14
  51. Display message on system console.
  52. .P
  53. The table below indicates the null values and identifiers for
  54. \fIfmtmsg\fR()
  55. arguments. The
  56. .IR <fmtmsg.h> 
  57. header shall define the symbolic constants in the
  58. .BR Identifier
  59. column, which shall have the type indicated in the
  60. .BR Type
  61. column:
  62. .TS
  63. box tab(!) center;
  64. cB | cB | cB | cB
  65. lI | lB | l | l.
  66. Argument!Type!Null-Value!Identifier
  67. _
  68. label!char *!(\fBchar\fR*)0!MM_NULLLBL
  69. severity!int!0!MM_NULLSEV
  70. class!long!\fB0L\fR!MM_NULLMC
  71. text!char *!(\fBchar\fR*)0!MM_NULLTXT
  72. action!char *!(\fBchar\fR*)0!MM_NULLACT
  73. tag!char *!(\fBchar\fR*)0!MM_NULLTAG
  74. .TE
  75. .P
  76. The
  77. .IR <fmtmsg.h> 
  78. header shall also define the following symbolic constants for use
  79. as return values for
  80. \fIfmtmsg\fR():
  81. .IP MM_OK 14
  82. The function succeeded.
  83. .IP MM_NOTOK 14
  84. The function failed completely.
  85. .IP MM_NOMSG 14
  86. The function was unable to generate a message on standard error, but
  87. otherwise succeeded.
  88. .IP MM_NOCON 14
  89. The function was unable to generate a console message, but otherwise
  90. succeeded.
  91. .P
  92. The following shall be declared as a function and may also be defined
  93. as a macro. A function prototype shall be provided.
  94. .sp
  95. .RS 4
  96. .nf
  98. int fmtmsg(long, const char *, int,
  99.     const char *, const char *, const char *);
  100. .fi
  101. .P
  102. .RE
  103. .LP
  104. .IR "The following sections are informative."
  105. .SH "APPLICATION USAGE"
  106. None.
  107. .SH RATIONALE
  108. None.
  109. .SH "FUTURE DIRECTIONS"
  110. None.
  111. .SH "SEE ALSO"
  112. The System Interfaces volume of POSIX.1\(hy2017,
  113. .IR "\fIfmtmsg\fR\^(\|)"
  114. .\"
  115. .SH COPYRIGHT
  116. Portions of this text are reprinted and reproduced in electronic form
  117. from IEEE Std 1003.1-2017, Standard for Information Technology
  118. -- Portable Operating System Interface (POSIX), The Open Group Base
  119. Specifications Issue 7, 2018 Edition,
  120. Copyright (C) 2018 by the Institute of
  121. Electrical and Electronics Engineers, Inc and The Open Group.
  122. In the event of any discrepancy between this version and the original IEEE and
  123. The Open Group Standard, the original IEEE and The Open Group Standard
  124. is the referee document. The original Standard can be obtained online at
  125. http://www.opengroup.org/unix/online.html .
  126. .PP
  127. Any typographical or formatting errors that appear
  128. in this page are most likely
  129. to have been introduced during the conversion of the source files to
  130. man page format. To report such errors, see
  131. https://www.kernel.org/doc/man-pages/reporting_bugs.html .