Changeset 23f014a in rtems

Timestamp:

09/11/98 19:21:41 (25 years ago)

Author:

Wade A Smith <warm38@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

bfcf4cb3

Parents:

b29378e

Message:

Added documentation for the log_facilityisvalid routine and add thew
status code EINVAL to the log_seek routine.

File:

• doc/new_chapters/eventlog.t (modified) (4 diffs)

doc/new_chapters/eventlog.t

@@ -36 +36 @@
 @item @code{log_facilitydelset} - Manipulate log facility sets
 @item @code{log_facilityismember} - Manipulate log facility sets
+@item @code{log_facilityisvalid} - Manipulate log facility sets
 @end itemize
 
@@ -71 +72 @@
 @subsection Creating and Writing a non-System Log
 
-Discuss creating and writing to a non-system log.
-
-@example
-  log_create
-  log_write loop
+The following snips of code create a non-System log file at /temp/.
+A previously read entry and buffer (log_buf) of size readsize are written
+into the log.  See the dicussion on opening and reading a log for
+how the entry is created.
+
+@example
+#include <evlog.h>
+   :
+  logd_t           *outlog = NULL;
+  char             *path   = "/temp/";
+
+  log_create( outlog, path );
+   :  
+  log_write_entry( outlog, &entry, log_buf, readsize );
+
 @end example
 
@@ -700 +711 @@
 @item EBADF
 The @code{logdes} argument is not a valid log file descriptor.
+@item EINVAL
+The @code{log_recid} argument is not a valid record id.
 
 @end table
@@ -1028 +1041 @@
 
 @page
+@subsection log_facilityismember - Manipulate log facility sets
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@example
+#include <evlog.h>
+
+int log_facilityisvalid(
+  log_facility_t        facilityno
+);
+@end example
+@end ifset
+
+@ifset is-Ada
+@end ifset
+
+@subheading STATUS CODES:
+
+@table @b
+@item EFAULT
+The @code{set} or @code{member} argument is an invalid pointer.
+
+@item EINVAL
+The @code{facilityno} argument is not a valid facility.
+
+@end table
+
+@subheading DESCRIPTION:
+
+The @code{log_facilityisvalid} function tests whether the facility
+specified by the value of the argument @code{facilityno} is a valid
+facility number which is less than 32.  Upon successful completion, 
+the @code{log_facilityisvalid} function either returns a value of
+0 if the specified facility is a valid facility or value of EINVAL 
+if the specified facility is not a valid facility.
+
+@subheading NOTES:
+
+The @code{_POSIX_LOGGING} feature flag is defined to indicate
+this service is available.
+
+Applications shall call either @code{log_facilityemptyset} or 
+@code{log_facilityfillset} at least once for each object of type
+@code{log_facilityset_t} prior to any other use of that object.  If
+such an object is not initialized in this way, but is nonetheless 
+supplied as an argument to any of the @code{log_facilityaddset}, 
+@code{logfacilitydelset}, @code{log_facilityismember} or 
+@code{log_open} functions, the results are undefined.
+
+@page
 @subsection log_create - Creates a log file