contrib/bind-9.3/lib/lwres/man/lwres_inetntop.3

   1 .\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14 .\" PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $Id: lwres_inetntop.3,v 1.12.2.1.8.6 2006/06/29 13:02:31 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: lwres_inetntop
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
  23 .\"      Date: Jun 30, 2000
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "LWRES_INETNTOP" "3" "Jun 30, 2000" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 lwres_net_ntop \- lightweight resolver IP address presentation
  34 .SH "SYNOPSIS"
  35 .nf
  36 #include <lwres/net.h>
  37 .fi
  38 .HP 28
  39 .BI "const char * lwres_net_ntop(int\ af, const\ void\ *src, char\ *dst, size_t\ size);"
  40 .SH "DESCRIPTION"
  41 .PP
  42 \fBlwres_net_ntop()\fR
  43 converts an IP address of protocol family
  44 \fIaf\fR
  45 \(em IPv4 or IPv6 \(em at location
  46 \fIsrc\fR
  47 from network format to its conventional representation as a string. For IPv4 addresses, that string would be a dotted\-decimal. An IPv6 address would be represented in colon notation as described in RFC1884.
  48 .PP
  49 The generated string is copied to
  50 \fIdst\fR
  51 provided
  52 \fIsize\fR
  53 indicates it is long enough to store the ASCII representation of the address.
  54 .SH "RETURN VALUES"
  55 .PP
  56 If successful, the function returns
  57 \fIdst\fR: a pointer to a string containing the presentation format of the address.
  58 \fBlwres_net_ntop()\fR
  59 returns
  60 \fBNULL\fR
  61 and sets the global variable
  62 \fBerrno\fR
  63 to
  64 \fBEAFNOSUPPORT\fR
  65 if the protocol family given in
  66 \fIaf\fR
  67 is not supported.
  68 .SH "SEE ALSO"
  69 .PP
  70 \fBRFC1884\fR(),
  71 \fBinet_ntop\fR(3),
  72 \fBerrno\fR(3).
  73 .SH "COPYRIGHT"
  74 Copyright \(co 2004, 2005 Internet Systems Consortium, Inc. ("ISC")