Blame lib/smi_event.3.in

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