external/bsd/bind/dist/lib/lwres/man/lwres_inetntop.3

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