ares_inet_ntop.3

   1 .\"
   2 .\" Copyright (C) 2013 by Daniel Stenberg
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this
   5 .\" software and its documentation for any purpose and without
   6 .\" fee is hereby granted, provided that the above copyright
   7 .\" notice appear in all copies and that both that copyright
   8 .\" notice and this permission notice appear in supporting
   9 .\" documentation, and that the name of M.I.T. not be used in
  10 .\" advertising or publicity pertaining to distribution of the
  11 .\" software without specific, written prior permission.
  12 .\" M.I.T. makes no representations about the suitability of
  13 .\" this software for any purpose.  It is provided "as is"
  14 .\" without express or implied warranty.
  15 .\"
  16 .TH ARES_INET_NTOP 3 "17 Feb 2013"
  17 .SH NAME
  18 ares_inet_ntop \- convert a network format address to presentation format
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <ares.h>
  22 .PP
  23 .B const char *ares_inet_ntop(int af, const void *src, char *dst, size_t size);
  24 .fi
  25 .SH DESCRIPTION
  26 This is a portable version with the identical functionality of the commonly
  27 available \fIinet_ntop\fP.
  28
  29 The ares_inet_ntop() function converts a numeric address into a text string
  30 suitable for presentation. The \fBaf\fP argument shall specify the family of
  31 the address. This can be AF_INET or AF_INET6.  The \fBsrc\fP argument points
  32 to a buffer holding an IPv4 address if the af argument is AF_INET, or an IPv6
  33 address if the af argument is AF_INET6; the address must be in network byte
  34 order. The \fBdst\fP argument points to a buffer where the function stores the
  35 resulting text string; it shall not be NULL. The \fBsize\fP argument specifies
  36 the size of this buffer, which shall be large enough to hold the text string
  37 (INET_ADDRSTRLEN (16) characters for IPv4, INET6_ADDRSTRLEN (46) characters
  38 for IPv6).
  39 .SH SEE ALSO
  40 .BR ares_init(3),
  41 .BR ares_inet_pton(3)
  42 .SH AVAILABILITY
  43 made properly publicly available in c-ares for real in version 1.10.0
  44 .SH AUTHOR
  45 Daniel Stenberg
  46