Changeset d65d22a0 in rtems


Ignore:
Timestamp:
Aug 27, 1998, 6:53:34 PM (21 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
6520befe
Parents:
c5568160
Message:

Corrected descriptions of log facility set manipulation routines as
part of the review.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/eventlog.t

    rc5568160 rd65d22a0  
    560560
    561561@table @b
    562 @item EINVAL
    563 The facilityno argument is not a valid facility.
    564 
    565 @end table
    566 
    567 @subheading DESCRIPTION:
    568 
    569 The facilitysetops primitives manipulate sets of facilities.  They
    570 operate on data objects addressable by the application.
     562@item EFAULT
     563The @code{set} argument is an invalid pointer.
     564
     565@end table
     566
     567@subheading DESCRIPTION:
    571568
    572569The @code{log_facilityemptyset} function initializes the facility
    573570set pointed to by the argument @code{set}, such that all facilities
    574 are included.
     571are excluded.
     572
     573@subheading NOTES:
     574
     575The @code{_POSIX_LOGGING} feature flag is defined to indicate
     576this service is available.
    575577
    576578Applications shall call either @code{log_facilityemptyset} or
     
    578580@code{log_facilityset_t} prior to any other use of that object.  If
    579581such an object is not initialized in this way, but is nonetheless
    580 supplied as an argument  to any of the @code{log_facilityaddset},
     582supplied as an argument to any of the @code{log_facilityaddset},
    581583@code{logfacilitydelset}, @code{log_facilityismember} or
    582584@code{log_open} functions, the results are undefined.
    583585
    584 The @code{log_facilityaddset} and @code{log_facilitydelset} functions
    585 respectively add or delete the individual facility specified by the
    586 value of the argument @code{facilityno} to or from the facility set
    587 pointed to by the argument @code{set}
     586@page
     587@subsection log_facilityfillset - Manipulate log facility sets
     588
     589@subheading CALLING SEQUENCE:
     590
     591@ifset is-C
     592@example
     593#include <evlog.h>
     594
     595int log_facilityfillset(
     596  log_facility_set_t  *set
     597);
     598@end example
     599@end ifset
     600
     601@ifset is-Ada
     602@end ifset
     603
     604@subheading STATUS CODES:
     605
     606@table @b
     607@item EFAULT
     608The @code{set} argument is an invalid pointer.
     609
     610@end table
     611
     612@subheading DESCRIPTION:
     613
     614The @code{log_facilityfillset} function initializes the facility
     615set pointed to by the argument @code{set}, such that all facilities
     616are included.
     617
     618@subheading NOTES:
     619
     620The @code{_POSIX_LOGGING} feature flag is defined to indicate
     621this service is available.
     622
     623Applications shall call either @code{log_facilityemptyset} or
     624@code{log_facilityfillset} at least once for each object of type
     625@code{log_facilityset_t} prior to any other use of that object.  If
     626such an object is not initialized in this way, but is nonetheless
     627supplied as an argument to any of the @code{log_facilityaddset},
     628@code{logfacilitydelset}, @code{log_facilityismember} or
     629@code{log_open} functions, the results are undefined.
     630
     631@page
     632@subsection log_facilityaddset - Manipulate log facility sets
     633
     634@subheading CALLING SEQUENCE:
     635
     636@ifset is-C
     637@example
     638#include <evlog.h>
     639
     640int log_facilityaddset(
     641  log_facility_set_t  *set,
     642  log_facility_t       facilityno
     643);
     644@end example
     645@end ifset
     646
     647@ifset is-Ada
     648@end ifset
     649
     650@subheading STATUS CODES:
     651
     652@table @b
     653@item EFAULT
     654The @code{set} argument is an invalid pointer.
     655
     656@item EINVAL
     657The @code{facilityno} argument is not a valid facility.
     658
     659@end table
     660
     661@subheading DESCRIPTION:
     662
     663The @code{log_facilityaddset} function adds the individual
     664facility specified by the value of the argument @code{facilityno}
     665to the facility set pointed to by the argument @code{set}.
     666
     667@subheading NOTES:
     668
     669The @code{_POSIX_LOGGING} feature flag is defined to indicate
     670this service is available.
     671
     672Applications shall call either @code{log_facilityemptyset} or
     673@code{log_facilityfillset} at least once for each object of type
     674@code{log_facilityset_t} prior to any other use of that object.  If
     675such an object is not initialized in this way, but is nonetheless
     676supplied as an argument to any of the @code{log_facilityaddset},
     677@code{logfacilitydelset}, @code{log_facilityismember} or
     678@code{log_open} functions, the results are undefined.
     679
     680@page
     681@subsection log_facilitydelset - Manipulate log facility sets
     682
     683@subheading CALLING SEQUENCE:
     684
     685@ifset is-C
     686@example
     687#include <evlog.h>
     688
     689int log_facilitydelset(
     690  log_facility_set_t  *set,
     691  log_facility_t       facilityno
     692);
     693@end example
     694@end ifset
     695
     696@ifset is-Ada
     697@end ifset
     698
     699@subheading STATUS CODES:
     700
     701@table @b
     702@item EFAULT
     703The @code{set} argument is an invalid pointer.
     704
     705@item EINVAL
     706The @code{facilityno} argument is not a valid facility.
     707
     708@end table
     709
     710@subheading DESCRIPTION:
     711
     712The @code{log_facilitydelset} function deletes the individual
     713facility specified by the value of the argument @code{facilityno}
     714from the facility set pointed to by the argument @code{set}.
     715
     716@subheading NOTES:
     717
     718The @code{_POSIX_LOGGING} feature flag is defined to indicate
     719this service is available.
     720
     721Applications shall call either @code{log_facilityemptyset} or
     722@code{log_facilityfillset} at least once for each object of type
     723@code{log_facilityset_t} prior to any other use of that object.  If
     724such an object is not initialized in this way, but is nonetheless
     725supplied as an argument to any of the @code{log_facilityaddset},
     726@code{logfacilitydelset}, @code{log_facilityismember} or
     727@code{log_open} functions, the results are undefined.
     728
     729@page
     730@subsection log_facilityismember - Manipulate log facility sets
     731
     732@subheading CALLING SEQUENCE:
     733
     734@ifset is-C
     735@example
     736#include <evlog.h>
     737
     738int log_facilityismember(
     739  const log_facility_set_t *set,
     740  log_facility_t            facilityno,
     741  const int                *member
     742);
     743@end example
     744@end ifset
     745
     746@ifset is-Ada
     747@end ifset
     748
     749@subheading STATUS CODES:
     750
     751@table @b
     752@item EFAULT
     753The @code{set} or @code{member} argument is an invalid pointer.
     754
     755@item EINVAL
     756The @code{facilityno} argument is not a valid facility.
     757
     758@end table
     759
     760@subheading DESCRIPTION:
    588761
    589762The @code{log_facilityismember} function tests whether the facility
     
    592765completion, the @code{log_facilityismember} function either returns
    593766a value of one to the location specified by @code{member} if the
    594 specified facility is a member of the specified set or returns a
    595 value of zero to the location specified by @code{member} if the
    596 specified facility is not a member of the specified set.
    597 
    598 @subheading NOTES:
    599 
    600 The @code{_POSIX_LOGGING} feature flag is defined to indicate
    601 this service is available.
    602 
    603 @page
    604 @subsection log_facilityfillset - Manipulate log facility sets
    605 
    606 @subheading CALLING SEQUENCE:
    607 
    608 @ifset is-C
    609 @example
    610 #include <evlog.h>
    611 
    612 int log_facilityfillset(
    613   log_facility_set_t  *set
    614 );
    615 @end example
    616 @end ifset
    617 
    618 @ifset is-Ada
    619 @end ifset
    620 
    621 @subheading STATUS CODES:
    622 
    623 @table @b
    624 @item EINVAL
    625 The facilityno argument is not a valid facility.
    626 
    627 @end table
    628 
    629 @subheading DESCRIPTION:
    630 
    631 The facilitysetops primitives manipulate sets of facilities.  They
    632 operate on data objects addressable by the application.
    633 
    634 The @code{log_facilityemptyset} function initializes the facility
    635 set pointed to by the argument @code{set}, such that all facilities
    636 are included.
     767specified facility is a member of the specified set or value of
     768zero to the location specified by @code{member} if the specified
     769facility is not a member of the specified set.
     770
     771@subheading NOTES:
     772
     773The @code{_POSIX_LOGGING} feature flag is defined to indicate
     774this service is available.
    637775
    638776Applications shall call either @code{log_facilityemptyset} or
     
    640778@code{log_facilityset_t} prior to any other use of that object.  If
    641779such an object is not initialized in this way, but is nonetheless
    642 supplied as an argument  to any of the @code{log_facilityaddset},
     780supplied as an argument to any of the @code{log_facilityaddset},
    643781@code{logfacilitydelset}, @code{log_facilityismember} or
    644782@code{log_open} functions, the results are undefined.
    645 
    646 The @code{log_facilityaddset} and @code{log_facilitydelset} functions
    647 respectively add or delete the individual facility specified by the
    648 value of the argument @code{facilityno} to or from the facility set
    649 pointed to by the argument @code{set}
    650 
    651 The @code{log_facilityismember} function tests whether the facility
    652 specified by the value of the argument @code{facilityno} is a member
    653 of the set pointed to by the argument @code{set}.  Upon successful
    654 completion, the @code{log_facilityismember} function either returns
    655 a value of one to the location specified by @code{member} if the
    656 specified facility is a member of the specified set or returns a
    657 value of zero to the location specified by @code{member} if the
    658 specified facility is not a member of the specified set.
    659 
    660 @subheading NOTES:
    661 
    662 The @code{_POSIX_LOGGING} feature flag is defined to indicate
    663 this service is available.
    664 
    665 @page
    666 @subsection log_facilityaddset - Manipulate log facility sets
    667 
    668 @subheading CALLING SEQUENCE:
    669 
    670 @ifset is-C
    671 @example
    672 #include <evlog.h>
    673 
    674 int log_facilityaddset(
    675   log_facility_set_t  *set,
    676   log_facility_t      facilityno
    677 );
    678 @end example
    679 @end ifset
    680 
    681 @ifset is-Ada
    682 @end ifset
    683 
    684 @subheading STATUS CODES:
    685 
    686 @table @b
    687 @item EINVAL
    688 The facilityno argument is not a valid facility.
    689 
    690 @end table
    691 
    692 @subheading DESCRIPTION:
    693 
    694 The facilitysetops primitives manipulate sets of facilities.  They
    695 operate on data objects addressable by the application.
    696 
    697 The @code{log_facilityemptyset} function initializes the facility
    698 set pointed to by the argument @code{set}, such that all facilities
    699 are included.
    700 
    701 Applications shall call either @code{log_facilityemptyset} or
    702 @code{log_facilityfillset} at least once for each object of type
    703 @code{log_facilityset_t} prior to any other use of that object.  If
    704 such an object is not initialized in this way, but is nonetheless
    705 supplied as an argument  to any of the @code{log_facilityaddset},
    706 @code{logfacilitydelset}, @code{log_facilityismember} or
    707 @code{log_open} functions, the results are undefined.
    708 
    709 The @code{log_facilityaddset} and @code{log_facilitydelset} functions
    710 respectively add or delete the individual facility specified by the
    711 value of the argument @code{facilityno} to or from the facility set
    712 pointed to by the argument @code{set}
    713 
    714 The @code{log_facilityismember} function tests whether the facility
    715 specified by the value of the argument @code{facilityno} is a member
    716 of the set pointed to by the argument @code{set}.  Upon successful
    717 completion, the @code{log_facilityismember} function either returns
    718 a value of one to the location specified by @code{member} if the
    719 specified facility is a member of the specified set or returns a
    720 value of zero to the location specified by @code{member} if the
    721 specified facility is not a member of the specified set.
    722 
    723 @subheading NOTES:
    724 
    725 The @code{_POSIX_LOGGING} feature flag is defined to indicate
    726 this service is available.
    727 
    728 @page
    729 @subsection log_facilitydelset - Manipulate log facility sets
    730 
    731 @subheading CALLING SEQUENCE:
    732 
    733 @ifset is-C
    734 @example
    735 #include <evlog.h>
    736 
    737 int log_facilitydelset(
    738   log_facility_set_t  *set,
    739   log_facility_t      facilityno
    740 );
    741 @end example
    742 @end ifset
    743 
    744 @ifset is-Ada
    745 @end ifset
    746 
    747 @subheading STATUS CODES:
    748 
    749 @table @b
    750 @item EINVAL
    751 The facilityno argument is not a valid facility.
    752 
    753 @end table
    754 
    755 @subheading DESCRIPTION:
    756 
    757 The facilitysetops primitives manipulate sets of facilities.  They
    758 operate on data objects addressable by the application.
    759 
    760 The @code{log_facilityemptyset} function initializes the facility
    761 set pointed to by the argument @code{set}, such that all facilities
    762 are included.
    763 
    764 Applications shall call either @code{log_facilityemptyset} or
    765 @code{log_facilityfillset} at least once for each object of type
    766 @code{log_facilityset_t} prior to any other use of that object.  If
    767 such an object is not initialized in this way, but is nonetheless
    768 supplied as an argument  to any of the @code{log_facilityaddset},
    769 @code{logfacilitydelset}, @code{log_facilityismember} or
    770 @code{log_open} functions, the results are undefined.
    771 
    772 The @code{log_facilityaddset} and @code{log_facilitydelset} functions
    773 respectively add or delete the individual facility specified by the
    774 value of the argument @code{facilityno} to or from the facility set
    775 pointed to by the argument @code{set}
    776 
    777 The @code{log_facilityismember} function tests whether the facility
    778 specified by the value of the argument @code{facilityno} is a member
    779 of the set pointed to by the argument @code{set}.  Upon successful
    780 completion, the @code{log_facilityismember} function either returns
    781 a value of one to the location specified by @code{member} if the
    782 specified facility is a member of the specified set or returns a
    783 value of zero to the location specified by @code{member} if the
    784 specified facility is not a member of the specified set.
    785 
    786 @subheading NOTES:
    787 
    788 The @code{_POSIX_LOGGING} feature flag is defined to indicate
    789 this service is available.
    790 
    791 @page
    792 @subsection log_facilityismember - Manipulate log facility sets
    793 
    794 @subheading CALLING SEQUENCE:
    795 
    796 @ifset is-C
    797 @example
    798 #include <evlog.h>
    799 
    800 int log_facilityismember(
    801   const log_facility_set_t *set,
    802   log_facility_t            facilityno,
    803   const int                *member
    804 );
    805 @end example
    806 @end ifset
    807 
    808 @ifset is-Ada
    809 @end ifset
    810 
    811 @subheading STATUS CODES:
    812 
    813 @table @b
    814 @item EINVAL
    815 The facilityno argument is not a valid facility.
    816 
    817 @end table
    818 
    819 @subheading DESCRIPTION:
    820 
    821 The facilitysetops primitives manipulate sets of facilities.  They
    822 operate on data objects addressable by the application.
    823 
    824 The @code{log_facilityemptyset} function initializes the facility
    825 set pointed to by the argument @code{set}, such that all facilities
    826 are included.
    827 
    828 Applications shall call either @code{log_facilityemptyset} or
    829 @code{log_facilityfillset} at least once for each object of type
    830 @code{log_facilityset_t} prior to any other use of that object.  If
    831 such an object is not initialized in this way, but is nonetheless
    832 supplied as an argument  to any of the @code{log_facilityaddset},
    833 @code{logfacilitydelset}, @code{log_facilityismember} or
    834 @code{log_open} functions, the results are undefined.
    835 
    836 The @code{log_facilityaddset} and @code{log_facilitydelset} functions
    837 respectively add or delete the individual facility specified by the
    838 value of the argument @code{facilityno} to or from the facility set
    839 pointed to by the argument @code{set}
    840 
    841 The @code{log_facilityismember} function tests whether the facility
    842 specified by the value of the argument @code{facilityno} is a member
    843 of the set pointed to by the argument @code{set}.  Upon successful
    844 completion, the @code{log_facilityismember} function either returns
    845 a value of one to the location specified by @code{member} if the
    846 specified facility is a member of the specified set or returns a
    847 value of zero to the location specified by @code{member} if the
    848 specified facility is not a member of the specified set.
    849 
    850 @subheading NOTES:
    851 
    852 The @code{_POSIX_LOGGING} feature flag is defined to indicate
    853 this service is available.
    854783
    855784@page
Note: See TracChangeset for help on using the changeset viewer.