Section (3) inet_ntop
Name
inet_ntop — convert IPv4 and IPv6 addresses from binary to text form
Synopsis
#include <arpa/inet.h>
const char
*inet_ntop( |
int af, |
const void *src, | |
char *dst, | |
socklen_t size) ; |
DESCRIPTION
This function converts the network address structure
src
in the af
address family into a
character string. The resulting string is copied to the
buffer pointed to by dst
, which must be a non-null
pointer. The caller specifies the number of bytes available
in this buffer in the argument size
.
inet_ntop
() extends the
inet_ntoa(3) function to
support multiple address families, inet_ntoa(3) is now
considered to be deprecated in favor of inet_ntop
(). The following address families
are currently supported:
AF_INET
-
src
points to a struct in_addr (in network byte order) which is converted to an IPv4 network address in the dotted-decimal format,ddd.ddd.ddd.ddd
. The bufferdst
must be at leastINET_ADDRSTRLEN
bytes long. AF_INET6
-
src
points to a struct in6_addr (in network byte order) which is converted to a representation of this address in the most appropriate IPv6 network address format for this address. The bufferdst
must be at leastINET6_ADDRSTRLEN
bytes long.
RETURN VALUE
On success, inet_ntop
()
returns a non-null pointer to dst
. NULL is returned if there
was an error, with errno
set to
indicate the error.
ERRORS
- EAFNOSUPPORT
-
af
was not a valid address family. - ENOSPC
-
The converted address string would exceed the size given by
size
.
ATTRIBUTES
For an explanation of the terms used in this section, see attributes(7).
Interface | Attribute | Value |
inet_ntop () |
Thread safety | MT-Safe locale |
CONFORMING TO
POSIX.1-2001, POSIX.1-2008. Note that RFC 2553 defines a
prototype where the last argument size
is of type size_t. Many systems follow RFC 2553. Glibc 2.0
and 2.1 have size_t, but 2.2 and
later have socklen_t.
COLOPHON
This page is part of release 4.16 of the Linux man-pages
project. A
description of the project, information about reporting bugs,
and the latest version of this page, can be found at
https://www.kernel.org/doc/man−pages/.
Copyright 2000 Sam Varshavchik <mrsamcourier-mta.com> %%%LICENSE_START(VERBATIM) 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. %%%LICENSE_END References: RFC 2553 |