path: root/ares_inet_ntop.3
diff options
Diffstat (limited to 'ares_inet_ntop.3')
1 files changed, 47 insertions, 0 deletions
diff --git a/ares_inet_ntop.3 b/ares_inet_ntop.3
new file mode 100644
index 0000000..93ee09c
--- /dev/null
+++ b/ares_inet_ntop.3
@@ -0,0 +1,47 @@
+.\" Copyright (C) 2013 by Daniel Stenberg
+.\" Permission to use, copy, modify, and distribute this
+.\" software and its documentation for any purpose and without
+.\" fee is hereby granted, provided that the above copyright
+.\" notice appear in all copies and that both that copyright
+.\" notice and this permission notice appear in supporting
+.\" documentation, and that the name of M.I.T. not be used in
+.\" advertising or publicity pertaining to distribution of the
+.\" software without specific, written prior permission.
+.\" M.I.T. makes no representations about the suitability of
+.\" this software for any purpose. It is provided "as is"
+.\" without express or implied warranty.
+.TH ARES_INET_NTOP 3 "17 Feb 2013"
+ares_inet_ntop \- convert a network format address to presentation format
+.B #include <ares.h>
+.B const char *
+.B ares_inet_ntop(int af, const void *src, char *dst, ares_socklen_t size);
+This is a portable version with the identical functionality of the commonly
+available \fIinet_ntop\fP.
+The ares_inet_ntop() function converts a numeric address into a text string
+suitable for presentation. The \fBaf\fP argument shall specify the family of
+the address. This can be AF_INET or AF_INET6. The \fBsrc\fP argument points
+to a buffer holding an IPv4 address if the af argument is AF_INET, or an IPv6
+address if the af argument is AF_INET6; the address must be in network byte
+order. The \fBdst\fP argument points to a buffer where the function stores the
+resulting text string; it shall not be NULL. The \fBsize\fP argument specifies
+the size of this buffer, which shall be large enough to hold the text string
+(INET_ADDRSTRLEN (16) characters for IPv4, INET6_ADDRSTRLEN (46) characters
+for IPv6).
+.BR ares_init(3),
+.BR ares_inet_pton(3)
+made properly publicly available in c-ares for real in version 1.10.0
+Daniel Stenberg