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

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" 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.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH INET_NTOP 3XNET "Nov 1, 2003"
  11 .SH NAME
  12 inet_ntop, inet_pton \- convert IPv4 and IPv6 addresses between binary and text
  13 form
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  18 #include <arpa/inet.h>
  19
  20 \fBconst char *\fR\fBinet_ntop\fR(\fBint\fR \fIaf\fR, \fBconst void *restrict\fR \fIsrc\fR,
  21      \fBchar *restrict\fR \fIdst\fR, \fBsocklen_t\fR \fIsize\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBint\fR \fBinet_pton\fR(\fBint\fR \fIaf\fR, \fBconst char *restrict\fR \fIsrc\fR, \fIdst\fR);
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBinet_ntop()\fR function converts a numeric address into a text string
  33 suitable for presentation. The \fIaf\fR argument specifies the family of the
  34 address. This can be \fBAF_INET\fR or \fBAF_INET6\fR. The \fIsrc\fR argument
  35 points to a buffer holding an IPv4 address if the \fIaf\fR argument is
  36 \fBAF_INET\fR,  or an IPv6 address if the \fIaf\fR argument is \fBAF_INET6\fR.
  37 The \fIdst\fR argument points to a buffer where the function stores the
  38 resulting text string; it cannot be \fINULL\fR. The \fIsize\fR argument
  39 specifies the size of this buffer, which must be large enough to hold the text
  40 string (\fBINET_ADDRSTRLEN\fR characters for IPv4, \fBINET6_ADDRSTRLEN\fR
  41 characters for IPv6).
  42 .sp
  43 .LP
  44 The \fBinet_pton()\fR function converts an address in its standard text
  45 presentation form into its numeric binary form. The \fIaf\fR argument specifies
  46 the family of the address. The \fBAF_INET\fR and \fBAF_INET6\fR address
  47 families are supported. The \fIsrc\fR argument points to the string being
  48 passed in. The \fIdst\fR argument points to a buffer into which the function
  49 stores the numeric address; this must be large enough to hold the numeric
  50 address (32 bits for \fBAF_INET\fR, 128 bits for \fBAF_INET6\fR).
  51 .sp
  52 .LP
  53 If the \fIaf\fR argument of \fBinet_pton()\fR is \fBAF_INET\fR, the \fIsrc\fR
  54 string is in the standard IPv4 dotted-decimal form:
  55 .sp
  56 .in +2
  57 .nf
  58 ddd.ddd.ddd.ddd
  59 .fi
  60 .in -2
  61
  62 .sp
  63 .LP
  64 where "\fBddd\fR"is a one to three digit decimal number between 0 and 255 (see
  65 \fBinet_addr\fR(3XNET)). The \fBinet_pton()\fR function does not accept other
  66 formats (such as the octal numbers, hexadecimal numbers, and fewer than four
  67 numbers that \fBinet_addr()\fR accepts).
  68 .sp
  69 .LP
  70 If the \fIaf\fR argument of \fBinet_pton()\fR is \fBAF_INET6\fR, the \fIsrc\fR
  71 string is in one of the following standard IPv6 text forms:
  72 .RS +4
  73 .TP
  74 1.
  75 The preferred form is "\fBx:x:x:x:x:x:x:x\fR", where the '\fBx\fR's are the
  76 hexadecimal values of the eight 16-bit pieces of the address. Leading zeros in
  77 individual fields can be omitted, but there must be at least one numeral in
  78 every field.
  79 .RE
  80 .RS +4
  81 .TP
  82 2.
  83 A string of contiguous zero fields in the preferred form can be shown as
  84 "\fB::\fR". The "\fB::\fR" can only appear once in an address. Unspecified
  85 addresses ("\fB0:0:0:0:0:0:0:0\fR") can be represented simply as "\fB::\fR".
  86 .RE
  87 .RS +4
  88 .TP
  89 3.
  90 A third form that is sometimes more convenient when dealing with a mixed
  91 environment of IPv4 and IPv6 nodes is "\fBx:x:x:x:x:x:d.d.d.d\fR", where
  92 the '\fBx\fR's are the hexadecimal values of the six high-order 16-bit pieces of
  93 the address, and the '\fBd\fR's are the decimal values of the four low-order
  94 8-bit pieces of the address (standard IPv4 representation).
  95 .RE
  96 .sp
  97 .LP
  98 A more extensive description of the standard representations of IPv6 addresses
  99 can be found in RFC 2373.
 100 .SH RETURN VALUES
 101 .sp
 102 .LP
 103 The \fBinet_ntop()\fR function returns a pointer to the buffer containing the
 104 text string if the conversion succeeds. Otherwise it returns \fINULL\fR  and
 105 sets \fBerrno\fR to indicate the error.
 106 .sp
 107 .LP
 108 The \fBinet_pton()\fR function returns 1 if the conversion succeeds, with the
 109 address pointed to by \fIdst\fR in network byte order. It returns 0 if the
 110 input is not a valid IPv4 dotted-decimal string or a valid IPv6 address string.
 111 It returns \(mi1 and sets \fBerrno\fR to \fBEAFNOSUPPORT\fR if the \fIaf\fR
 112 argument is unknown.
 113 .SH ERRORS
 114 .sp
 115 .LP
 116 The \fBinet_ntop()\fR and \fBinet_pton()\fR functions will fail if:
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fBEAFNOSUPPORT\fR\fR
 121 .ad
 122 .RS 16n
 123 The \fIaf\fR argument is invalid.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBENOSPC\fR\fR
 130 .ad
 131 .RS 16n
 132 The size of the \fBinet_ntop()\fR result buffer is inadequate.
 133 .RE
 134
 135 .SH ATTRIBUTES
 136 .sp
 137 .LP
 138 See \fBattributes\fR(5) for descriptions of the following attributes:
 139 .sp
 140
 141 .sp
 142 .TS
 143 box;
 144 c | c
 145 l | l .
 146 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 147 _
 148 Interface Stability     Standard
 149 _
 150 MT-Level        MT-Safe
 151 .TE
 152
 153 .SH SEE ALSO
 154 .sp
 155 .LP
 156 \fBinet_addr\fR(3XNET), \fBattributes\fR(5)