xnu-6153.121.1.tar.gz

[apple/xnu.git] / bsd / man / man2 / getsockname.2

diff --git a/bsd/man/man2/getsockname.2 b/bsd/man/man2/getsockname.2
index 45241e307ce78ce1dfaa577b13a4ccb88bc44046..fd2bd1d3b8cca867540d0379cd25295f1092e4b3 100644 (file)
--- a/bsd/man/man2/getsockname.2
+++ b/bsd/man/man2/getsockname.2
@@ -48,16 +48,32 @@
 .Fa "socklen_t *restrict address_len"
 .Fc
 .Sh DESCRIPTION
 .Fa "socklen_t *restrict address_len"
 .Fc
 .Sh DESCRIPTION

-.Fn Getsockname
-returns the current 
+The
+.Fn getsockname
+function returns the current

 .Fa address
 .Fa address

-for the specified socket.  The
+for the specified socket. 
+.Pp
+The

 .Fa address_len
 parameter should be initialized to indicate
 the amount of space pointed to by
 .Fa address .
 .Fa address_len
 parameter should be initialized to indicate
 the amount of space pointed to by
 .Fa address .

-On return it contains the actual size of the name
+On return it contains the actual size of the address

 returned (in bytes).
 returned (in bytes).

+.Pp
+The address is truncated if the buffer provided is too small.
+.Pp
+Note: For the UNIX domain, the address length returned is the
+.Fa address_len
+parameter passed to the previous
+.Xr bind 2
+system call and not the
+.Va sa_len
+field of the
+.Fa address
+parameter passed to
+.Xr bind 2 .

 .Sh RETURN VALUES
 .Rv -std getsockname
 .Sh ERRORS
 .Sh RETURN VALUES
 .Rv -std getsockname
 .Sh ERRORS


@@ -101,7 +117,7 @@ is not supported for the protocol in use by
 .Sh BUGS
 Names bound to sockets in the UNIX domain are inaccessible;
 .Fn getsockname
 .Sh BUGS
 Names bound to sockets in the UNIX domain are inaccessible;
 .Fn getsockname

-returns a zero-length name.
+returns a zero-length address.

 .Sh HISTORY
 The
 .Fn getsockname
 .Sh HISTORY
 The
 .Fn getsockname