Blame libipq/ipq_errstr.3

Packit 7b22a4
.TH IPQ_ERRSTR 3 "16 October 2001" "Linux iptables 1.2" "Linux Programmer's Manual" 
Packit 7b22a4
.\"
Packit 7b22a4
.\"     Copyright (c) 2000 Netfilter Core Team
Packit 7b22a4
.\"
Packit 7b22a4
.\"     This program is free software; you can redistribute it and/or modify
Packit 7b22a4
.\"     it under the terms of the GNU General Public License as published by
Packit 7b22a4
.\"     the Free Software Foundation; either version 2 of the License, or
Packit 7b22a4
.\"     (at your option) any later version.
Packit 7b22a4
.\"
Packit 7b22a4
.\"     This program is distributed in the hope that it will be useful,
Packit 7b22a4
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 7b22a4
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit 7b22a4
.\"     GNU General Public License for more details.
Packit 7b22a4
.\"
Packit 7b22a4
.\"     You should have received a copy of the GNU General Public License
Packit 7b22a4
.\"     along with this program; if not, write to the Free Software
Packit 7b22a4
.\"     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Packit 7b22a4
.\"
Packit 7b22a4
.\"
Packit 7b22a4
.SH NAME
Packit 7b22a4
ipq_errstr, ipq_perror \(em libipq error handling routines
Packit 7b22a4
.SH SYNOPSIS
Packit 7b22a4
.B #include <linux/netfilter.h>
Packit 7b22a4
.br
Packit 7b22a4
.B #include <libipq.h>
Packit 7b22a4
.sp
Packit 7b22a4
.BI "char *ipq_errstr(" void );
Packit 7b22a4
.br
Packit 7b22a4
.BI "void ipq_perror(const char *" s );
Packit 7b22a4
.SH DESCRIPTION
Packit 7b22a4
The
Packit 7b22a4
.B ipq_errstr
Packit 7b22a4
function returns a descriptive error message based on the current
Packit 7b22a4
value of the internal
Packit 7b22a4
.B ipq_errno
Packit 7b22a4
variable.  All libipq API functions set this internal variable
Packit 7b22a4
upon failure.
Packit 7b22a4
.PP
Packit 7b22a4
The
Packit 7b22a4
.B ipq_perror
Packit 7b22a4
function prints an error message to stderr corresponding to the
Packit 7b22a4
current value of the internal
Packit 7b22a4
.B ipq_error
Packit 7b22a4
variable, and the global
Packit 7b22a4
.B errno
Packit 7b22a4
variable (if set).  The error message is prefixed with the string
Packit 7b22a4
.I s
Packit 7b22a4
as supplied by the application. If
Packit 7b22a4
.I s
Packit 7b22a4
is NULL, the error message is prefixed with the string "ERROR".
Packit 7b22a4
.SH RETURN VALUE
Packit 7b22a4
.B ipq_errstr
Packit 7b22a4
returns an error message as outlined above.
Packit 7b22a4
.SH BUGS
Packit 7b22a4
None known.
Packit 7b22a4
.SH AUTHOR
Packit 7b22a4
James Morris <jmorris@intercode.com.au>
Packit 7b22a4
.SH COPYRIGHT
Packit 7b22a4
Copyright (c) 2000-2001 Netfilter Core Team.
Packit 7b22a4
.PP
Packit 7b22a4
Distributed under the GNU General Public License.
Packit 7b22a4
.SH SEE ALSO
Packit 7b22a4
.BR iptables (8),
Packit 7b22a4
.BR libipq (3).