2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright 2000 Sam Varshavchik <mrsam@courier-mta.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" References: RFC 2553
|
|
|
|
.TH inet_ntop 3 2000-12-18 "Linux Man Page" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
|
|
|
inet_ntop \- Parse network address structures
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <sys/types.h>
|
|
|
|
.B #include <sys/socket.h>
|
|
|
|
.B #include <arpa/inet.h>
|
|
|
|
.sp
|
|
|
|
.BI "const char *inet_ntop(int " "af" ", const void *" "src" ,
|
|
|
|
.BI " char *" "dst" ", socklen_t " "cnt" );
|
|
|
|
.SH DESCRIPTION
|
|
|
|
This function converts the network address structure
|
|
|
|
.I src
|
|
|
|
in the
|
|
|
|
.I af
|
|
|
|
address family into a character string, which is copied to a character buffer
|
|
|
|
.IR dst ,
|
|
|
|
which is
|
|
|
|
.I cnt
|
|
|
|
bytes long.
|
|
|
|
.PP
|
|
|
|
.BR inet_ntop (3)
|
|
|
|
extends the
|
|
|
|
.BR inet_ntoa (3)
|
|
|
|
function to support multiple address families,
|
|
|
|
.BR inet_ntoa (3)
|
|
|
|
is now considered to be deprecated in favor of
|
|
|
|
.BR inet_ntop (3).
|
|
|
|
The following address families are currently supported:
|
|
|
|
.TP
|
|
|
|
.B AF_INET
|
|
|
|
.I src
|
|
|
|
points to a
|
|
|
|
.I struct in_addr
|
|
|
|
(network byte order format)
|
|
|
|
which is converted to an IPv4 network address in
|
|
|
|
the dotted-quad format, "\fIddd.ddd.ddd.ddd\fP".
|
|
|
|
The buffer
|
|
|
|
.I dst
|
|
|
|
must be at least
|
|
|
|
.B INET_ADDRSTRLEN
|
|
|
|
bytes long.
|
|
|
|
.TP
|
|
|
|
.B AF_INET6
|
|
|
|
.I src
|
|
|
|
points to a
|
|
|
|
.I struct in6_addr
|
|
|
|
(network byte order format)
|
|
|
|
which is converted to a representation of this address in the
|
|
|
|
most appropriate IPv6 network address format for this address.
|
|
|
|
The buffer
|
|
|
|
.I dst
|
|
|
|
must be at least
|
|
|
|
.B INET6_ADDRSTRLEN
|
|
|
|
bytes long.
|
|
|
|
.SH "RETURN VALUE"
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR inet_ntop ()
|
2004-11-03 13:51:07 +00:00
|
|
|
returns a non-null pointer to
|
|
|
|
.IR dst .
|
|
|
|
NULL is returned if there was an error, with
|
|
|
|
.I errno
|
|
|
|
set to
|
|
|
|
.B EAFNOSUPPORT
|
|
|
|
if
|
|
|
|
.I af
|
|
|
|
was not set to a valid address family,
|
|
|
|
or to
|
|
|
|
.B ENOSPC
|
|
|
|
if the converted address string would exceed the size of
|
|
|
|
.IR dst
|
|
|
|
given by the
|
|
|
|
.I cnt
|
|
|
|
argument.
|
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:30 +00:00
|
|
|
POSIX.1-2001.
|
2005-07-20 07:50:45 +00:00
|
|
|
Note that RFC\ 2553 defines a prototype where the last parameter
|
2004-11-03 13:51:07 +00:00
|
|
|
.I cnt
|
|
|
|
is of type
|
|
|
|
.BR size_t .
|
2005-07-20 07:50:45 +00:00
|
|
|
Many systems follow RFC\ 2553.
|
2004-11-03 13:51:07 +00:00
|
|
|
Glibc 2.0 and 2.1 have size_t, but 2.2 has socklen_t.
|
|
|
|
.\" 2.1.3: size_t, 2.1.91: socklen_t
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR inet_pton (3)
|
|
|
|
.SH BUGS
|
|
|
|
.B AF_INET6
|
|
|
|
converts IPv6-mapped IPv4 addresses into an IPv6 format.
|