summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2013/man3p/inet_addr.3p
blob: 565770ed1d91b52922b0ccbad9bcbe85e816677c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
'\" et
.TH INET_ADDR "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.

.SH NAME
inet_addr,
inet_ntoa
\(em IPv4 address manipulation
.SH SYNOPSIS
.LP
.nf
#include <arpa/inet.h>
.P
in_addr_t inet_addr(const char *\fIcp\fP);
char *inet_ntoa(struct in_addr \fIin\fP);
.fi
.SH DESCRIPTION
The
\fIinet_addr\fR()
function shall convert the string pointed to by
.IR cp ,
in the standard IPv4 dotted decimal notation, to an integer value
suitable for use as an Internet address.
.P
The
\fIinet_ntoa\fR()
function shall convert the Internet host address specified by
.IR in
to a string in the Internet standard dot notation.
.P
The
\fIinet_ntoa\fR()
function need not be thread-safe.
.P
All Internet addresses shall be returned in network order (bytes
ordered from left to right).
.P
Values specified using IPv4 dotted decimal notation take one of the
following forms:
.IP "\fRa.b.c.d\fP" 10
When four parts are specified, each shall be interpreted as a byte of
data and assigned, from left to right, to the four bytes of an Internet
address.
.IP "\fRa.b.c\fP" 10
When a three-part address is specified, the last part shall be
interpreted as a 16-bit quantity and placed in the rightmost two bytes
of the network address. This makes the three-part address format
convenient for specifying Class B network addresses as
.BR \(dq128.net.host\(dq .
.IP "\fRa.b\fP" 10
When a two-part address is supplied, the last part shall be interpreted
as a 24-bit quantity and placed in the rightmost three bytes of the
network address. This makes the two-part address format convenient for
specifying Class A network addresses as
.BR \(dqnet.host\(dq .
.IP "\fRa\fP" 10
When only one part is given, the value shall be stored directly in the
network address without any byte rearrangement.
.P
All numbers supplied as parts in IPv4 dotted decimal notation may be
decimal, octal, or hexadecimal, as specified in the ISO\ C standard (that is, a
leading 0x or 0X implies hexadecimal; otherwise, a leading
.BR '0' 
implies octal; otherwise, the number is interpreted as decimal).
.SH "RETURN VALUE"
Upon successful completion,
\fIinet_addr\fR()
shall return the Internet address. Otherwise, it shall return (\c
.BR in_addr_t )(\(mi1).
.P
The
\fIinet_ntoa\fR()
function shall return a pointer to the network address in Internet
standard dot notation.
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH "EXAMPLES"
None.
.SH "APPLICATION USAGE"
The return value of
\fIinet_ntoa\fR()
may point to static data that may be overwritten by subsequent calls to
\fIinet_ntoa\fR().
.SH "RATIONALE"
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIendhostent\fR\^(\|)",
.IR "\fIendnetent\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2008,
.IR "\fB<arpa_inet.h>\fP"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.unix.org/online.html .

Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .