From 1dedfde98f441e003f98f182ea461deb51ff5e21 Mon Sep 17 00:00:00 2001
From: Wade A Smith <warm38@juno.com>
Date: Wed, 30 Sep 1998 19:39:56 +0000
Subject: Updated the STATUS CODE section of the routines in this file.

---
 doc/new_chapters/eventlog.t | 48 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

(limited to 'doc')

diff --git a/doc/new_chapters/eventlog.t b/doc/new_chapters/eventlog.t
index ee9c03e3a5..8e17af4cee 100644
--- a/doc/new_chapters/eventlog.t
+++ b/doc/new_chapters/eventlog.t
@@ -140,6 +140,9 @@ int log_write(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_write()} returns a value of zero
+and an unsuccessful call returns the @code{errno}.
+
 @table @b
 @item E2BIG
 This error indicates an inconsistency in the implementation.
@@ -241,6 +244,9 @@ int log_write_any(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_write_any()} returns a value of zero
+and an unsuccessful call returns the @code{errno}.
+
 @table @b
 @item E2BIG
 This error indicates an inconsistency in the implementation.
@@ -346,6 +352,9 @@ int log_write_entry(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_write_entry()} returns a value of zero
+and an unsuccessful call returns the @code{errno}.
+
 @table @b
 @item E2BIG
 This error indicates an inconsistency in the implementation.
@@ -429,6 +438,9 @@ int log_open(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_open()} returns a value of zero
+and an unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EACCES
 Search permission is denied on a component of the @cdoe{path} prefix,
@@ -526,6 +538,9 @@ int log_read(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_read()} returns a value of zero
+and an unsuccessful call returns the @code{errno}.
+
 @table @b
 @item E2BIG
 This error indicates an inconsistency in the implementation.
@@ -613,6 +628,9 @@ int log_notify(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_notify()} returns a value of zero
+and an unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EBADF
 The logdes argument is not a valid log file descriptor.
@@ -671,6 +689,9 @@ int log_close(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_close()} returns a value of zero
+and an unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EBADF
 The logdes argument is not a valid log file descriptor.
@@ -718,6 +739,9 @@ int log_seek(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_seek()} returns a value of zero
+and an unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EBADF
 The @code{logdes} argument is not a valid log file descriptor.
@@ -828,6 +852,9 @@ int log_facilityemptyset(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_facilityemptyset()} returns a value of zero
+and a unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EFAULT
 The @code{set} argument is an invalid pointer.
@@ -873,6 +900,9 @@ int log_facilityfillset(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_facilityfillset()} returns a value of zero
+and a unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EFAULT
 The @code{set} argument is an invalid pointer.
@@ -919,6 +949,9 @@ int log_facilityaddset(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_facilityaddset()} returns a value of zero
+and a unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EFAULT
 The @code{set} argument is an invalid pointer.
@@ -968,6 +1001,9 @@ int log_facilitydelset(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_facilitydelset()} returns a value of zero
+and a unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EFAULT
 The @code{set} argument is an invalid pointer.
@@ -1018,6 +1054,9 @@ int log_facilityismember(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_facilityismember()} returns a value 
+of zero and a unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EFAULT
 The @code{set} or @code{member} argument is an invalid pointer.
@@ -1071,6 +1110,9 @@ int log_facilityisvalid(
 
 @subheading STATUS CODES:
 
+A return value of zero indicates that the @code{facilityno} is valid and 
+a return value other than zero represents an @code{errno}.
+
 @table @b
 @item EFAULT
 The @code{set} or @code{member} argument is an invalid pointer.
@@ -1123,6 +1165,9 @@ int log_create(
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_create()} returns a value 
+of zero and a unsuccessful call returns the @code{errno}.
+
 @table @b
 
 @item EEXIST 
@@ -1200,6 +1245,9 @@ int log_sys_create();
 
 @subheading STATUS CODES:
 
+A successful call to @code{log_sys_create()} returns a value 
+of zero and a unsuccessful call returns the @code{errno}.
+
 @table @b
 @item EEXIST
 The directory path to the system log already exist.
-- 
cgit v1.2.3