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.5 2005/10/13 02:33:53 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\" ** You probably do not want to edit this file directly **
  21 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
  22 .\" Instead of manually editing it, you probably should edit the DocBook XML
  23 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
  24 .TH "LWRES_INETNTOP" "3" "Jun 30, 2000" "BIND9" "BIND9"
  25 .\" disable hyphenation
  26 .nh
  27 .\" disable justification (adjust text to left margin only)
  28 .ad l
  29 .SH "NAME"
  30 lwres_net_ntop \- lightweight resolver IP address presentation
  31 .SH "SYNOPSIS"
  32 .nf
  33 #include <lwres/net.h>
  34 .fi
  35 .HP 28
  36 \fBconst\ char\ *\ \fBlwres_net_ntop\fR\fR\fB(\fR\fBint\ af\fR\fB, \fR\fBconst\ void\ *src\fR\fB, \fR\fBchar\ *dst\fR\fB, \fR\fBsize_t\ size\fR\fB);\fR
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBlwres_net_ntop()\fR
  40 converts an IP address of protocol family
  41 \fIaf\fR
  42 \(em IPv4 or IPv6 \(em at location
  43 \fIsrc\fR
  44 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.
  45 .PP
  46 The generated string is copied to
  47 \fIdst\fR
  48 provided
  49 \fIsize\fR
  50 indicates it is long enough to store the ASCII representation of the address.
  51 .SH "RETURN VALUES"
  52 .PP
  53 If successful, the function returns
  54 \fIdst\fR: a pointer to a string containing the presentation format of the address.
  55 \fBlwres_net_ntop()\fR
  56 returns
  57 \fBNULL\fR
  58 and sets the global variable
  59 \fBerrno\fR
  60 to
  61 \fBEAFNOSUPPORT\fR
  62 if the protocol family given in
  63 \fIaf\fR
  64 is not supported.
  65 .SH "SEE ALSO"
  66 .PP
  67 \fBRFC1884\fR(),
  68 \fBinet_ntop\fR(3),
  69 \fBerrno\fR(3).