]> git.ipfire.org Git - thirdparty/glibc.git/commitdiff
manual: Document error codes missing for 'inet_pton'
authorMaciej W. Rozycki <macro@redhat.com>
Wed, 4 Jun 2025 15:27:20 +0000 (16:27 +0100)
committerMaciej W. Rozycki <macro@redhat.com>
Wed, 4 Jun 2025 15:27:20 +0000 (16:27 +0100)
Add documentation for EAFNOSUPPORT error code returned, and the possible
return values on non-success.

Reviewed-by: Florian Weimer <fweimer@redhat.com>
manual/socket.texi

index e8285b9200bbfc6d3cb88777512281de5086170f..d804c7a48b91b403eaa895d1a36c760f34eb0b5e 100644 (file)
@@ -1216,6 +1216,17 @@ either @code{AF_INET} or @code{AF_INET6}, as appropriate for the type of
 address being converted.  @var{cp} is a pointer to the input string, and
 @var{buf} is a pointer to a buffer for the result.  It is the caller's
 responsibility to make sure the buffer is large enough.
+
+The return value is @code{1} on success and @code{0} if @var{cp} does not
+point to a valid address string for the address family @var{af} requested.
+On failure, the function's return value is @code{-1} and @code{errno} is
+set accordingly.  The following @code{errno} values are specific to this
+function:
+
+@table @code
+@item EAFNOSUPPORT
+The address family requested is neither @code{AF_INET} nor @code{AF_INET6}.
+@end table
 @end deftypefun
 
 @deftypefun {const char *} inet_ntop (int @var{af}, const void *@var{cp}, char *@var{buf}, socklen_t @var{len})