ipq_errstr.3 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .TH IPQ_ERRSTR 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual"
  2. .\"
  3. .\" Copyright (c) 2000 Netfilter Core Team
  4. .\"
  5. .\" This program is free software; you can redistribute it and/or modify
  6. .\" it under the terms of the GNU General Public License as published by
  7. .\" the Free Software Foundation; either version 2 of the License, or
  8. .\" (at your option) any later version.
  9. .\"
  10. .\" This program is distributed in the hope that it will be useful,
  11. .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. .\" GNU General Public License for more details.
  14. .\"
  15. .\" You should have received a copy of the GNU General Public License
  16. .\" along with this program; if not, write to the Free Software
  17. .\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18. .\"
  19. .\"
  20. .SH NAME
  21. ipq_errstr, ipq_perror \(em libipq error handling routines
  22. .SH SYNOPSIS
  23. .B #include <linux/netfilter.h>
  24. .br
  25. .B #include <libipq.h>
  26. .sp
  27. .BI "char *ipq_errstr(" void );
  28. .br
  29. .BI "void ipq_perror(const char *" s );
  30. .SH DESCRIPTION
  31. The
  32. .B ipq_errstr
  33. function returns a descriptive error message based on the current
  34. value of the internal
  35. .B ipq_errno
  36. variable. All libipq API functions set this internal variable
  37. upon failure.
  38. .PP
  39. The
  40. .B ipq_perror
  41. function prints an error message to stderr corresponding to the
  42. current value of the internal
  43. .B ipq_error
  44. variable, and the global
  45. .B errno
  46. variable (if set). The error message is prefixed with the string
  47. .I s
  48. as supplied by the application. If
  49. .I s
  50. is NULL, the error message is prefixed with the string "ERROR".
  51. .SH RETURN VALUE
  52. .B ipq_errstr
  53. returns an error message as outlined above.
  54. .SH BUGS
  55. None known.
  56. .SH AUTHOR
  57. James Morris <jmorris@intercode.com.au>
  58. .SH COPYRIGHT
  59. Copyright (c) 2000-2001 Netfilter Core Team.
  60. .PP
  61. Distributed under the GNU General Public License.
  62. .SH SEE ALSO
  63. .BR iptables (8),
  64. .BR libipq (3).