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

gai_strerror.3p (2561B)

    

  1. '\" et
  2. .TH GAI_STRERROR "3P" 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. gai_strerror
  12. \(em address and name information error description
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <netdb.h>
  17. .P
  18. const char *gai_strerror(int \fIecode\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fIgai_strerror\fR()
  23. function shall return a text string describing an error value for the
  24. \fIgetaddrinfo\fR()
  25. and
  26. \fIgetnameinfo\fR()
  27. functions listed in the
  28. .IR <netdb.h> 
  29. header.
  30. .P
  31. When the
  32. .IR ecode
  33. argument is one of the following values listed in the
  34. .IR <netdb.h> 
  35. header:
  36. .TS
  37. tab(!);
  38. le le.
  39. T{
  40. .nf
  41. .BR [EAI_AGAIN] 
  42. .BR [EAI_BADFLAGS] 
  43. .BR [EAI_FAIL] 
  44. .BR [EAI_FAMILY] 
  45. .BR [EAI_MEMORY] 
  46. T}!T{
  47. .nf
  48. .BR [EAI_NONAME] 
  49. .BR [EAI_OVERFLOW] 
  50. .BR [EAI_SERVICE] 
  51. .BR [EAI_SOCKTYPE] 
  52. .BR [EAI_SYSTEM] 
  53. .fi
  54. T}
  55. .TE
  56. .P
  57. the function return value shall point to a string describing the error.
  58. If the argument is not one of those values, the function shall return a
  59. pointer to a string whose contents indicate an unknown error.
  60. .SH "RETURN VALUE"
  61. Upon successful completion,
  62. \fIgai_strerror\fR()
  63. shall return a pointer to an implementation-defined string.
  64. .SH "ERRORS"
  65. No errors are defined.
  66. .LP
  67. .IR "The following sections are informative."
  68. .SH EXAMPLES
  69. None.
  70. .SH "APPLICATION USAGE"
  71. None.
  72. .SH RATIONALE
  73. None.
  74. .SH "FUTURE DIRECTIONS"
  75. None.
  76. .SH "SEE ALSO"
  77. .IR "\fIfreeaddrinfo\fR\^(\|)"
  78. .P
  79. The Base Definitions volume of POSIX.1\(hy2017,
  80. .IR "\fB<netdb.h>\fP"
  81. .\"
  82. .SH COPYRIGHT
  83. Portions of this text are reprinted and reproduced in electronic form
  84. from IEEE Std 1003.1-2017, Standard for Information Technology
  85. -- Portable Operating System Interface (POSIX), The Open Group Base
  86. Specifications Issue 7, 2018 Edition,
  87. Copyright (C) 2018 by the Institute of
  88. Electrical and Electronics Engineers, Inc and The Open Group.
  89. In the event of any discrepancy between this version and the original IEEE and
  90. The Open Group Standard, the original IEEE and The Open Group Standard
  91. is the referee document. The original Standard can be obtained online at
  92. http://www.opengroup.org/unix/online.html .
  93. .PP
  94. Any typographical or formatting errors that appear
  95. in this page are most likely
  96. to have been introduced during the conversion of the source files to
  97. man page format. To report such errors, see
  98. https://www.kernel.org/doc/man-pages/reporting_bugs.html .