libipq/ipq_errstr.3

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