Changeset 0cac61e in rtems


Ignore:
Timestamp:
Aug 10, 1998, 10:35:04 PM (21 years ago)
Author:
Wade A Smith <warm38@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
339737b
Parents:
3fbd528
Message:

Update the description section for the log_write function.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/eventlog.t

    r3fbd528 r0cac61e  
    8585@subheading DESCRIPTION:
    8686
    87 The @code{log_write} function writes an event record, consisting
    88 of event attributes, and the data identified by the @code{buf}
    89 argument, to the system log.
     87If {_POSIX_LOGGING} is defined:
     88
     89   The @code{log_write} function writes an event record, consisting
     90   of event attributes, and the data identified by the @code{buf}
     91   argument, to the system log.  The @code{len} argument specifies
     92   the length in bytes of the buffer pointed to by @code{buf}.  The
     93   @code{len} argument shall specify the value of the event record
     94   length attribute.  The value of @code{len} shall be less than or
     95   equal to {LOG_ENTRY_MAXLEN} or the @code{log_write} shall fail.
     96
     97   The @code{event_id} argument identifies the type of event record
     98   being written.  The @code{event_id} argument shall specify the value
     99   of the event ID attribute of the event record.
     100
     101   The argument @code{facility} indicates the facility from which the
     102   event type is drawn.  The @code{facility} aargument shall specify the
     103   value of the event record facility attribute.  The value of the
     104   @code{facility} argument shall be a valid log facility or the
     105   @code{log_write} function shall fail.
     106
     107   The @code{severity} argument indicates the severity level of the
     108   event record.  The @code{severity} argument shall specify the value
     109   of the event record severity attribute.  The value of the
     110   @code{severity} argument shall be less than or equal to
     111   {LOG_SEVERITY_MAX} or the @code{log_write} function shall fail. 
     112
     113   The effective_UID of the calling process shall specify the event
     114   record UID attribute.  The efective-GID of the calling process
     115   shall specify the event record GID attribute.  The process ID
     116   of the calling process shall specify the event record process ID
     117   attribute.  The process group ID of the calling process shall
     118   specify the event record process group ID attribute.  The current
     119   value of the system clock shall specify the event record timestamp
     120   attribute.
     121
     122Otherwise:
     123
     124   The @code{log_write} function shall fail.
    90125
    91126@subheading NOTES:
Note: See TracChangeset for help on using the changeset viewer.