lib/smi_event.3.in

   1 .TH "smi_event" "3" "February 10, 2007" "" "SMI Management Information Library"
   2 .SH "NAME"
   3 .\" START OF MAN PAGE COPIES
   4 smiGetEvent,
   5 smiGetFirstEvent,
   6 smiGetNextEvent
   7 .\" END OF MAN PAGE COPIES
   8 \- SMI identity
   9 information routines
  10 .SH "SYNOPSIS"
  11 .nf
  12 .B #include <smi.h>
  13 .RS
  14 .RE
  15 .sp
  16 .BI "smiGetEvent(SmiClass *" smiClassPtr, char *" name) ;
  17 .RE
  18 .sp
  19 .BI "smiGetFirstEvent(SmiClass *" smiClassPtr);
  20 .RE
  21 .sp
  22 .BI "smiGetNextEvent(SmiEvent *" smiEventPtr);
  23 .RE
  24
  25 typedef struct SmiEvent {
  26     SmiIdentifier       name;
  27     SmiDecl             decl;
  28     SmiStatus           status;
  29     char                *description;
  30     char                *reference;
  31 } SmiEvent;
  32
  33 .fi
  34 .SH "DESCRIPTION"
  35 These functions retrieve information on a SMIng event definition (SMIng).
  36 .PP
  37 \fBsmiGetEvent(SmiClass *smiClassPtr, char *name)\fP returns a pointer
  38 to \fBstruct SmiEvent\fP for the event with the given \fIname\fP in
  39 the given class(\fIsmiClassPtr\fP), or NULL if the event with the
  40 given name does not exist
  41 .PP
  42 \fBsmiGetFirstEvent(SmiClass *smiClassPtr)\fP and
  43 \fBsmiGetNextEvent(SmiEvent *smiEventPtr)\fP are used to iterate
  44 through the events of the class given by \fIsmiClassPtr\fP. They
  45 return a pointer to \fBstruct SmiEvent\fP that represents an event or
  46 NULL if there are no events left in the class, or error has occurred.
  47 .SH "FILES"
  48 .nf
  49 @includedir@/smi.h    SMI library header file
  50 .fi
  51 .SH "SEE ALSO"
  52 .BR libsmi "(3), "
  53 .BR smi_module "(3), "
  54 .BR smi_class "(3), "
  55 .BR smi.h
  56 .SH "AUTHOR"
  57 (C) 2007 Kaloyan Kanev, Jacobs University, Germany <k.kanev@jacobs-university.de>
  58 .br