usr/src/man/man3xnet/inet_addr.3xnet

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Portions Copyright (c) 2000, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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.opengroup.org/unix/online.html.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH INET_ADDR 3XNET "Jun 10, 2002"
  12 .SH NAME
  13 inet_addr, inet_network, inet_makeaddr, inet_lnaof, inet_netof, inet_ntoa \-
  14 Internet address manipulation
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  19 #include <arpa/inet.h>
  20
  21 \fBin_addr_t\fR \fBinet_addr\fR(\fBconst char *\fR\fIcp\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBin_addr_t\fR \fBinet_lnaof\fR(\fBstruct in_addr\fR \fIin\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBstruct in_addr\fR \fBinet_makeaddr\fR(\fBin_addr_t\fR \fInet\fR, \fBin_addr_t\fR \fIlna\fR);
  32 .fi
  33
  34 .LP
  35 .nf
  36 \fBin_addr_t\fR \fBinet_netof\fR(\fBstruct in_addr\fR \fIin\fR);
  37 .fi
  38
  39 .LP
  40 .nf
  41 \fBin_addr_t\fR \fBinet_network\fR(\fBconst char *\fR\fIcp\fR);
  42 .fi
  43
  44 .LP
  45 .nf
  46 \fBchar *\fR\fBinet_ntoa\fR(\fBstruct in_addr\fR \fIin\fR);
  47 .fi
  48
  49 .SH DESCRIPTION
  50 .sp
  51 .LP
  52 The \fBinet_addr()\fR function converts the string pointed to by \fIcp\fR, in
  53 the Internet standard dot notation, to an integer value suitable for use as an
  54 Internet address.
  55 .sp
  56 .LP
  57 The \fBinet_lnaof()\fR function takes an Internet host address specified by
  58 \fIin\fR and extracts the local network address part, in host byte order.
  59 .sp
  60 .LP
  61 The \fBinet_makeaddr()\fR function takes the Internet network number specified
  62 by \fInet\fR and the local network address specified by \fIlna\fR, both in host
  63 byte order, and constructs an Internet address from them.
  64 .sp
  65 .LP
  66 The \fBinet_netof()\fR function takes an Internet host address specified by
  67 \fIin\fR and extracts the network number part, in host byte order.
  68 .sp
  69 .LP
  70 The \fBinet_network()\fR function converts the string pointed to by \fIcp\fR,
  71 in the Internet standard dot notation, to an integer value suitable for use as
  72 an Internet network number.
  73 .sp
  74 .LP
  75 The \fBinet_ntoa()\fR function converts the Internet host address specified by
  76 \fIin\fR to a string in the Internet standard dot notation.
  77 .sp
  78 .LP
  79 All Internet addresses are returned in network order (bytes ordered from left
  80 to right).
  81 .sp
  82 .LP
  83 Values specified using dot notation take one of the following forms:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBa.b.c.d\fR\fR
  88 .ad
  89 .RS 11n
  90 When four parts are specified, each is interpreted as a byte of data and
  91 assigned, from left to right, to the four bytes of an Internet address.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBa.b.c\fR\fR
  98 .ad
  99 .RS 11n
 100 When a three-part address is specified, the last part is interpreted as a
 101 16-bit quantity and placed in the rightmost two bytes of the network address.
 102 This makes the three-part address format convenient for specifying Class B
 103 network addresses as \fB128.\fR\fInet\fR.\fIhost\fR.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBa.b\fR\fR
 110 .ad
 111 .RS 11n
 112 When a two-part address is supplied, the last part is interpreted as a 24-bit
 113 quantity and placed in the rightmost three bytes of the network address. This
 114 makes the two-part address format convenient for specifying Class A network
 115 addresses as \fInet\fR\fB\&.\fR\fIhost\fR.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBa\fR\fR
 122 .ad
 123 .RS 11n
 124 When only one part is given, the value is stored directly in the network
 125 address without any byte rearrangement.
 126 .RE
 127
 128 .sp
 129 .LP
 130 All numbers supplied as parts in dot notation may be decimal, octal, or
 131 hexadecimal, that is, a leading 0x or 0X implies hexadecimal, as specified in
 132 the \fIISO C\fR standard; otherwise, a leading 0 implies octal; otherwise, the
 133 number is interpreted as decimal.
 134 .SH USAGE
 135 .sp
 136 .LP
 137 The return value of \fBinet_ntoa()\fR may point to static data that may be
 138 overwritten by subsequent calls to \fBinet_ntoa()\fR.
 139 .SH RETURN VALUES
 140 .sp
 141 .LP
 142 Upon successful completion, \fBinet_addr()\fR returns the Internet address.
 143 Otherwise, it returns (\fBin_addr_t\fR)(\(mi1).
 144 .sp
 145 .LP
 146 Upon successful completion, \fBinet_network()\fR returns the converted Internet
 147 network number. Otherwise, it returns (\fBin_addr_t\fR)(\(mi1).
 148 .sp
 149 .LP
 150 The \fBinet_makeaddr()\fR function returns the constructed Internet address.
 151 .sp
 152 .LP
 153 The \fBinet_lnaof()\fR function returns the local network address part.
 154 .sp
 155 .LP
 156 The \fBinet_netof()\fR function returns the network number.
 157 .sp
 158 .LP
 159 The \fBinet_ntoa()\fR function returns a pointer to the network address in
 160 Internet-standard dot notation.
 161 .SH ERRORS
 162 .sp
 163 .LP
 164 No errors are defined.
 165 .SH ATTRIBUTES
 166 .sp
 167 .LP
 168 See \fBattributes\fR(5) for descriptions of the following attributes:
 169 .sp
 170
 171 .sp
 172 .TS
 173 box;
 174 c | c
 175 l | l .
 176 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 177 _
 178 Interface Stability     Standard
 179 _
 180 MT-Level        MT-Safe
 181 .TE
 182
 183 .SH SEE ALSO
 184 .sp
 185 .LP
 186 \fBendhostent\fR(3XNET), \fBendnetent\fR(3XNET), \fBattributes\fR(5),
 187 \fBstandards\fR(5)