Blame lib/smi_event.3

Packit 022b05
.TH "smi_event" "3" "February 10, 2007" "" "SMI Management Information Library"
Packit 022b05
.SH "NAME"
Packit 022b05
.\" START OF MAN PAGE COPIES
Packit 022b05
smiGetEvent,
Packit 022b05
smiGetFirstEvent,
Packit 022b05
smiGetNextEvent
Packit 022b05
.\" END OF MAN PAGE COPIES
Packit 022b05
\- SMI identity
Packit 022b05
information routines
Packit 022b05
.SH "SYNOPSIS"
Packit 022b05
.nf 
Packit 022b05
.B #include <smi.h>
Packit 022b05
.RS
Packit 022b05
.RE
Packit 022b05
.sp
Packit 022b05
.BI "smiGetEvent(SmiClass *" smiClassPtr, char *" name) ;
Packit 022b05
.RE
Packit 022b05
.sp
Packit 022b05
.BI "smiGetFirstEvent(SmiClass *" smiClassPtr);
Packit 022b05
.RE
Packit 022b05
.sp
Packit 022b05
.BI "smiGetNextEvent(SmiEvent *" smiEventPtr);
Packit 022b05
.RE
Packit 022b05
Packit 022b05
typedef struct SmiEvent {
Packit 022b05
    SmiIdentifier       name;
Packit 022b05
    SmiDecl             decl;
Packit 022b05
    SmiStatus           status;
Packit 022b05
    char                *description;
Packit 022b05
    char                *reference;
Packit 022b05
} SmiEvent;
Packit 022b05
Packit 022b05
.fi 
Packit 022b05
.SH "DESCRIPTION"
Packit 022b05
These functions retrieve information on a SMIng event definition (SMIng).
Packit 022b05
.PP 
Packit 022b05
\fBsmiGetEvent(SmiClass *smiClassPtr, char *name)\fP returns a pointer
Packit 022b05
to \fBstruct SmiEvent\fP for the event with the given \fIname\fP in
Packit 022b05
the given class(\fIsmiClassPtr\fP), or NULL if the event with the
Packit 022b05
given name does not exist
Packit 022b05
.PP 
Packit 022b05
\fBsmiGetFirstEvent(SmiClass *smiClassPtr)\fP and
Packit 022b05
\fBsmiGetNextEvent(SmiEvent *smiEventPtr)\fP are used to iterate
Packit 022b05
through the events of the class given by \fIsmiClassPtr\fP. They
Packit 022b05
return a pointer to \fBstruct SmiEvent\fP that represents an event or
Packit 022b05
NULL if there are no events left in the class, or error has occurred.
Packit 022b05
.SH "FILES"
Packit 022b05
.nf 
Packit 022b05
${prefix}/include/smi.h    SMI library header file
Packit 022b05
.fi 
Packit 022b05
.SH "SEE ALSO"
Packit 022b05
.BR libsmi "(3), "
Packit 022b05
.BR smi_module "(3), "
Packit 022b05
.BR smi_class "(3), "
Packit 022b05
.BR smi.h
Packit 022b05
.SH "AUTHOR"
Packit 022b05
(C) 2007 Kaloyan Kanev, Jacobs University, Germany <k.kanev@jacobs-university.de>
Packit 022b05
.br