summaryrefslogtreecommitdiff
path: root/lib/tsocket
diff options
context:
space:
mode:
authorAndreas Schneider <asn@redhat.com>2009-12-15 12:57:35 +0100
committerStefan Metzmacher <metze@samba.org>2009-12-15 23:34:22 +0100
commite33ae22b87597f31caefd5466bb8e8f240405972 (patch)
treefe1f5766d8b5e5d8abcd8d0d4f57617823d57c18 /lib/tsocket
parentab04dd3be743806bf3c9cf9db4b5326ce0476bf5 (diff)
downloadsamba-e33ae22b87597f31caefd5466bb8e8f240405972.tar.gz
samba-e33ae22b87597f31caefd5466bb8e8f240405972.tar.bz2
samba-e33ae22b87597f31caefd5466bb8e8f240405972.zip
tsocket: Fixed documentation for tsocket_address_bsd_sockaddr().
Diffstat (limited to 'lib/tsocket')
-rw-r--r--lib/tsocket/tsocket_guide.txt11
1 files changed, 5 insertions, 6 deletions
diff --git a/lib/tsocket/tsocket_guide.txt b/lib/tsocket/tsocket_guide.txt
index 287fe8a4e5..b47f153e2e 100644
--- a/lib/tsocket/tsocket_guide.txt
+++ b/lib/tsocket/tsocket_guide.txt
@@ -433,12 +433,11 @@ int tsocket_address_bsd_from_sockaddr(TALLOC_CTX *mem_ctx,
socklen_t sa_socklen,
struct tsocket_address **addr);
-In some situations it's needed to get a 'struct a tsocket_address from
-a given 'struct sockaddr'. You can use tsocket_address_bsd_from_sockaddr()
-for that. This should only be used if really needed, because of
-already existing fixed APIs. Only AF_INET, AF_INET6 and AF_UNIX
-sockets are allowed. The function returns -1 and set errno on error.
-Otherwise it returns 0.
+In some situations it's needed to get a 'struct sockaddr' from a
+given tsocket_address . You can use tsocket_address_bsd_sockaddr()
+for that. This should only be used if really needed. Only AF_INET,
+AF_INET6 and AF_UNIX are supported. It returns the size of '*sa' on
+success, otherwise it returns -1 and sets 'errno'.
int tsocket_address_bsd_sockaddr(const struct tsocket_address *addr,
struct sockaddr *sa,