|
Packit Service |
9ccfef |
.\"
|
|
Packit Service |
9ccfef |
.TH "smi_class" "3" "February 10, 2007" "" "SMI Management Information Library"
|
|
Packit Service |
9ccfef |
.SH "NAME"
|
|
Packit Service |
9ccfef |
.\" START OF MAN PAGE COPIES
|
|
Packit Service |
9ccfef |
smiGetClass
|
|
Packit Service |
9ccfef |
smiGetFirstClass,
|
|
Packit Service |
9ccfef |
smiGetNextClass,
|
|
Packit Service |
9ccfef |
smiGetClassModule,
|
|
Packit Service |
9ccfef |
smiGetParentClass,
|
|
Packit Service |
9ccfef |
smiIsClassScalar
|
|
Packit Service |
9ccfef |
.\" END OF MAN PAGE COPIES
|
|
Packit Service |
9ccfef |
\- SMI class
|
|
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 "SmiClass *smiGetClass(SmiModule *" smiModulePtr ", char *" name );
|
|
Packit Service |
9ccfef |
.RE
|
|
Packit Service |
9ccfef |
.sp
|
|
Packit Service |
9ccfef |
.BI "SmiClass *smiGetFirstClass(SmiModule *" smiModulePtr );
|
|
Packit Service |
9ccfef |
.RE
|
|
Packit Service |
9ccfef |
.sp
|
|
Packit Service |
9ccfef |
.BI "SmiClass *smiGetNextClass(SmiClass *" smiClassPtr );
|
|
Packit Service |
9ccfef |
.RE
|
|
Packit Service |
9ccfef |
.sp
|
|
Packit Service |
9ccfef |
.BI "SmiClass *smiGetParentClass(SmiClass *" smiClassPtr );
|
|
Packit Service |
9ccfef |
.RE
|
|
Packit Service |
9ccfef |
.sp
|
|
Packit Service |
9ccfef |
.BI "SmiModule *smiGetClassModule(SmiClass *" smiClassPtr );
|
|
Packit Service |
9ccfef |
.RE
|
|
Packit Service |
9ccfef |
.sp
|
|
Packit Service |
9ccfef |
.BI "int smiIsClassScalar(SmiClass *" smiClassPtr );
|
|
Packit Service |
9ccfef |
.RE
|
|
Packit Service |
9ccfef |
|
|
Packit Service |
9ccfef |
typedef struct SmiClass {
|
|
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 |
} SmiClass;
|
|
Packit Service |
9ccfef |
|
|
Packit Service |
9ccfef |
.fi
|
|
Packit Service |
9ccfef |
.SH "DESCRIPTION"
|
|
Packit Service |
9ccfef |
These functions retrieve information on a SMIng class definition (SMIng).
|
|
Packit Service |
9ccfef |
.PP
|
|
Packit Service |
9ccfef |
\fBsmiGetClass(SmiModule *smiModulePtr,char *name)\fP returns a
|
|
Packit Service |
9ccfef |
pointer to \fBstruct SmiClass\fP that represents the class with the
|
|
Packit Service |
9ccfef |
given \fIname\fP in the given module(\fIsmiModulePtr\fP ), or NULL if
|
|
Packit Service |
9ccfef |
the class with the given name does not exist.
|
|
Packit Service |
9ccfef |
.PP
|
|
Packit Service |
9ccfef |
\fBsmiGetFirstClass(SmiModule *smiModulePtr)\fP and
|
|
Packit Service |
9ccfef |
\fBsmiGetNextClass(SmiClass *smiClassPtr)\fP are used to iterate
|
|
Packit Service |
9ccfef |
through the classes of the module given by \fIsmiModulePtr\fP. They
|
|
Packit Service |
9ccfef |
return a pointer to \fBstruct SmiClass\fP that represents a class or
|
|
Packit Service |
9ccfef |
NULL if there are no classes left in the module, or error has
|
|
Packit Service |
9ccfef |
occurred.
|
|
Packit Service |
9ccfef |
.PP
|
|
Packit Service |
9ccfef |
\fBsmiGetClassModule(SmiClass *smiClassPtr)\fP returns a pointer to
|
|
Packit Service |
9ccfef |
\fBstruct SmiModule\fP, of the module containing the given class.
|
|
Packit Service |
9ccfef |
.PP
|
|
Packit Service |
9ccfef |
\fBsmiGetParentClass(SmiClass *smiClassPtr)\fP returns a pointer to
|
|
Packit Service |
9ccfef |
\fBstruct SmiClass\fP pointing to the parent of the given
|
|
Packit Service |
9ccfef |
\fIsmiClassPtr\fP, or NULL if the class is not derived.
|
|
Packit Service |
9ccfef |
.PP
|
|
Packit Service |
9ccfef |
\fBsmiIsClassScalar(SmiClass *smiClassPtr)\fP returns \fBint\fP
|
|
Packit Service |
9ccfef |
\fI1\fP if the class is scalar(its unique statement contains an empty
|
|
Packit Service |
9ccfef |
list) or \fI0\fP otherwise. This method can be used in conjunction
|
|
Packit Service |
9ccfef |
with \fBsmiGetFirstUniqueAttribute()\fP to determine whether the class
|
|
Packit Service |
9ccfef |
is meant to be instantiated separately (has unique statement with
|
|
Packit Service |
9ccfef |
nonempty list), or if it is meant to be used as part of another class
|
|
Packit Service |
9ccfef |
(has no unique statement).
|
|
Packit Service |
9ccfef |
.SH "FILES"
|
|
Packit Service |
9ccfef |
.nf
|
|
Packit Service |
9ccfef |
${prefix}/include/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.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
|