Changeset 23f014a in rtems


Ignore:
Timestamp:
Sep 11, 1998, 7:21:41 PM (21 years ago)
Author:
Wade A Smith <warm38@…>
Branches:
4.10, 4.11, 4.8, 4.9, 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:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/eventlog.t

    rb29378e r23f014a  
    3636@item @code{log_facilitydelset} - Manipulate log facility sets
    3737@item @code{log_facilityismember} - Manipulate log facility sets
     38@item @code{log_facilityisvalid} - Manipulate log facility sets
    3839@end itemize
    3940
     
    7172@subsection Creating and Writing a non-System Log
    7273
    73 Discuss creating and writing to a non-system log.
    74 
    75 @example
    76   log_create
    77   log_write loop
     74The following snips of code create a non-System log file at /temp/.
     75A previously read entry and buffer (log_buf) of size readsize are written
     76into the log.  See the dicussion on opening and reading a log for
     77how the entry is created.
     78
     79@example
     80#include <evlog.h>
     81   :
     82  logd_t           *outlog = NULL;
     83  char             *path   = "/temp/";
     84
     85  log_create( outlog, path );
     86   : 
     87  log_write_entry( outlog, &entry, log_buf, readsize );
     88
    7889@end example
    7990
     
    700711@item EBADF
    701712The @code{logdes} argument is not a valid log file descriptor.
     713@item EINVAL
     714The @code{log_recid} argument is not a valid record id.
    702715
    703716@end table
     
    10281041
    10291042@page
     1043@subsection log_facilityismember - Manipulate log facility sets
     1044
     1045@subheading CALLING SEQUENCE:
     1046
     1047@ifset is-C
     1048@example
     1049#include <evlog.h>
     1050
     1051int log_facilityisvalid(
     1052  log_facility_t        facilityno
     1053);
     1054@end example
     1055@end ifset
     1056
     1057@ifset is-Ada
     1058@end ifset
     1059
     1060@subheading STATUS CODES:
     1061
     1062@table @b
     1063@item EFAULT
     1064The @code{set} or @code{member} argument is an invalid pointer.
     1065
     1066@item EINVAL
     1067The @code{facilityno} argument is not a valid facility.
     1068
     1069@end table
     1070
     1071@subheading DESCRIPTION:
     1072
     1073The @code{log_facilityisvalid} function tests whether the facility
     1074specified by the value of the argument @code{facilityno} is a valid
     1075facility number which is less than 32.  Upon successful completion,
     1076the @code{log_facilityisvalid} function either returns a value of
     10770 if the specified facility is a valid facility or value of EINVAL
     1078if the specified facility is not a valid facility.
     1079
     1080@subheading NOTES:
     1081
     1082The @code{_POSIX_LOGGING} feature flag is defined to indicate
     1083this service is available.
     1084
     1085Applications shall call either @code{log_facilityemptyset} or
     1086@code{log_facilityfillset} at least once for each object of type
     1087@code{log_facilityset_t} prior to any other use of that object.  If
     1088such an object is not initialized in this way, but is nonetheless
     1089supplied as an argument to any of the @code{log_facilityaddset},
     1090@code{logfacilitydelset}, @code{log_facilityismember} or
     1091@code{log_open} functions, the results are undefined.
     1092
     1093@page
    10301094@subsection log_create - Creates a log file
    10311095
Note: See TracChangeset for help on using the changeset viewer.