contrib/bind9/lib/lwres/man/lwres_inetntop.3

   1 .\" Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and/or 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 .hy 0
  17 .ad l
  18 '\" t
  19 .\"     Title: lwres_inetntop
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
  22 .\"      Date: 2007-06-18
  23 .\"    Manual: BIND9
  24 .\"    Source: ISC
  25 .\"  Language: English
  26 .\"
  27 .TH "LWRES_INETNTOP" "3" "2007\-06\-18" "ISC" "BIND9"
  28 .\" -----------------------------------------------------------------
  29 .\" * Define some portability stuff
  30 .\" -----------------------------------------------------------------
  31 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32 .\" http://bugs.debian.org/507673
  33 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .ie \n(.g .ds Aq \(aq
  36 .el       .ds Aq '
  37 .\" -----------------------------------------------------------------
  38 .\" * set default formatting
  39 .\" -----------------------------------------------------------------
  40 .\" disable hyphenation
  41 .nh
  42 .\" disable justification (adjust text to left margin only)
  43 .ad l
  44 .\" -----------------------------------------------------------------
  45 .\" * MAIN CONTENT STARTS HERE *
  46 .\" -----------------------------------------------------------------
  47 .SH "NAME"
  48 lwres_net_ntop \- lightweight resolver IP address presentation
  49 .SH "SYNOPSIS"
  50 .sp
  51 .ft B
  52 .nf
  53 #include <lwres/net\&.h>
  54 .fi
  55 .ft
  56 .HP \w'const\ char\ *\ lwres_net_ntop('u
  57 .BI "const char * lwres_net_ntop(int\ " "af" ", const\ void\ *" "src" ", char\ *" "dst" ", size_t\ " "size" ");"
  58 .SH "DESCRIPTION"
  59 .PP
  60 \fBlwres_net_ntop()\fR
  61 converts an IP address of protocol family
  62 \fIaf\fR
  63 \(em IPv4 or IPv6 \(em at location
  64 \fIsrc\fR
  65 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\&.
  66 .PP
  67 The generated string is copied to
  68 \fIdst\fR
  69 provided
  70 \fIsize\fR
  71 indicates it is long enough to store the ASCII representation of the address\&.
  72 .SH "RETURN VALUES"
  73 .PP
  74 If successful, the function returns
  75 \fIdst\fR: a pointer to a string containing the presentation format of the address\&.
  76 \fBlwres_net_ntop()\fR
  77 returns
  78 \fBNULL\fR
  79 and sets the global variable
  80 \fBerrno\fR
  81 to
  82 \fBEAFNOSUPPORT\fR
  83 if the protocol family given in
  84 \fIaf\fR
  85 is not supported\&.
  86 .SH "SEE ALSO"
  87 .PP
  88 \fBRFC1884\fR(),
  89 \fBinet_ntop\fR(3),
  90 \fBerrno\fR(3)\&.
  91 .SH "AUTHOR"
  92 .PP
  93 \fBInternet Systems Consortium, Inc\&.\fR
  94 .SH "COPYRIGHT"
  95 .br
  96 Copyright \(co 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
  97 .br
  98 Copyright \(co 2000, 2001 Internet Software Consortium.
  99 .br