summaryrefslogtreecommitdiffstats
path: root/lib/libnetgraph
diff options
context:
space:
mode:
authorbrian <brian@FreeBSD.org>2001-08-24 21:39:27 +0000
committerbrian <brian@FreeBSD.org>2001-08-24 21:39:27 +0000
commitc6694b94dbbbc71c81e849632fbc80d1680487b3 (patch)
tree7c7f03c4cf6c3319c039f955c096a7f4fb597668 /lib/libnetgraph
parentafb098d153662e7ba618c257d0ef7b484d0c02b8 (diff)
downloadFreeBSD-src-c6694b94dbbbc71c81e849632fbc80d1680487b3.zip
FreeBSD-src-c6694b94dbbbc71c81e849632fbc80d1680487b3.tar.gz
Rename the DIAGNOSTICS section to RETURN VALUES and describe the
return values a little more. Specifically, mention that a return of 0 from NgRecvData() and NgRecvMsg() means the socket has been closed. Suggested by: jkh
Diffstat (limited to 'lib/libnetgraph')
-rw-r--r--lib/libnetgraph/netgraph.314
1 files changed, 10 insertions, 4 deletions
diff --git a/lib/libnetgraph/netgraph.3 b/lib/libnetgraph/netgraph.3
index bf2de91..f51c515 100644
--- a/lib/libnetgraph/netgraph.3
+++ b/lib/libnetgraph/netgraph.3
@@ -255,12 +255,18 @@ and
.Xr ng_socket 4
KLD modules must have been loaded via
.Xr kldload 8 .
-.Sh DIAGNOSTICS
-All functions except
+.Sh RETURN VALUES
.Fn NgSetDebug
-and
+returns the previous debug setting.
.Fn NgSetErrLog
-return -1 if there was an error and set errno accordingly.
+has no return value.
+All other functions return -1 if there was an error and set errno
+accordingly.
+A return value of zero from
+.Fn NgRecvMsg
+or
+.Fn NgRecvData
+indicates that the netgraph socket has been closed.
.Pp
For
.Fn NgSendAsciiMsg
OpenPOWER on IntegriCloud