diff options
author | Wade A Smith <warm38@juno.com> | 1998-08-25 15:26:19 +0000 |
---|---|---|
committer | Wade A Smith <warm38@juno.com> | 1998-08-25 15:26:19 +0000 |
commit | 2a23c28060c126b209c25dad0500b7dbf42f6d87 (patch) | |
tree | 100a47ff2b8f30cd5830f78946e9a12a1f61cf16 /doc/new_chapters | |
parent | Posix users manual now makes multiple info files. (diff) | |
download | rtems-2a23c28060c126b209c25dad0500b7dbf42f6d87.tar.bz2 |
Documented the log_create and log_sys_create routines
Diffstat (limited to 'doc/new_chapters')
-rw-r--r-- | doc/new_chapters/eventlog.t | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/new_chapters/eventlog.t b/doc/new_chapters/eventlog.t index ef0af4af4b..a0b19da2fb 100644 --- a/doc/new_chapters/eventlog.t +++ b/doc/new_chapters/eventlog.t @@ -818,3 +818,79 @@ Otherwise: @subheading NOTES: +@page +@subsection log_create - Creates a log file + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_create( + logd_t *ld, + const char *path, +); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@table @b +@item ENOMEM +The is ???????????? + +@end table + +@subheading DESCRIPTION: + +If {_POSIX_LOGGING} is defined: + + This function dynamically allocates memory for the @code{ld}, associates + a directory path to the @code{Ld}, andprovides access permissions to the + @code{ld}. + +Otherwise: + + The function fails + +@subheading NOTES: + +@page +@subsection log_sys_create - Creates a system log file + +@subheading CALLING SEQUENCE: + +@ifset is-C +@example +int log_sys_create(); +@end example +@end ifset + +@ifset is-Ada +@end ifset + +@subheading STATUS CODES: + +@table @b +@item EEXIST +The directory path to the system log already exist. + +@end table + +@subheading DESCRIPTION: + +If {_POSIX_LOGGING} is defined: + + This function will create a predefined system log directory path and system log + file if they do not already exist. + +Otherwise: + + The function fails + +@subheading NOTES: + + + |