|
Packit |
022b05 |
.\"
|
|
Packit |
022b05 |
.\" $Id: smi_module.3.in 4432 2006-05-29 16:21:11Z strauss $
|
|
Packit |
022b05 |
.\"
|
|
Packit |
022b05 |
.TH smi_module 3 "August 16, 2001" "IBR" "SMI Management Information Library"
|
|
Packit |
022b05 |
.SH NAME
|
|
Packit |
022b05 |
.\" START OF MAN PAGE COPIES
|
|
Packit |
022b05 |
smiGetModule,
|
|
Packit |
022b05 |
smiGetFirstModule,
|
|
Packit |
022b05 |
smiGetNextModule,
|
|
Packit |
022b05 |
smiGetModuleIdentityNode,
|
|
Packit |
022b05 |
smiGetFirstImport,
|
|
Packit |
022b05 |
smiGetNextImport,
|
|
Packit |
022b05 |
smiIsImported,
|
|
Packit |
022b05 |
smiGetFirstRevision,
|
|
Packit |
022b05 |
smiGetNextRevision
|
|
Packit |
022b05 |
.\" END OF MAN PAGE COPIES
|
|
Packit |
022b05 |
\- SMI module information routines
|
|
Packit |
022b05 |
.SH SYNOPSIS
|
|
Packit |
022b05 |
.nf
|
|
Packit |
022b05 |
.B #include <time.h>
|
|
Packit |
022b05 |
.B #include <smi.h>
|
|
Packit |
022b05 |
.RS
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiModule *smiGetModule(char *" module );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiModule *smiGetFirstModule();
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiModule *smiGetNextModule(SmiModule *" smiModulePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiNode *smiGetModuleIdentityNode(SmiModule *" smiModulePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiImport *smiGetFirstImport(SmiModule *" smiModulePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiImport *smiGetNextImport(SmiImport *" smiImportPtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "int smiIsImported(SmiModule *" smiModulePtr ", SmiModule *" importedModulePtr ", char *" importedName );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiRevision *smiGetFirstRevision(SmiModule *" smiModulePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiRevision *smiGetNextRevision(SmiRevision *" smiRevisionPtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiModule {
|
|
Packit |
022b05 |
SmiIdentifier name;
|
|
Packit |
022b05 |
char *path;
|
|
Packit |
022b05 |
char *organization;
|
|
Packit |
022b05 |
char *contactinfo;
|
|
Packit |
022b05 |
char *description;
|
|
Packit |
022b05 |
char *reference;
|
|
Packit |
022b05 |
SmiLanguage language;
|
|
Packit |
022b05 |
int conformance;
|
|
Packit |
022b05 |
} SmiModule;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiRevision {
|
|
Packit |
022b05 |
time_t date;
|
|
Packit |
022b05 |
char *description;
|
|
Packit |
022b05 |
} SmiRevision;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiImport {
|
|
Packit |
022b05 |
SmiIdentifier module;
|
|
Packit |
022b05 |
SmiIdentifier name;
|
|
Packit |
022b05 |
} SmiImport;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
.fi
|
|
Packit |
022b05 |
.SH DESCRIPTION
|
|
Packit |
022b05 |
These functions retrieve various meta information on MIB
|
|
Packit |
022b05 |
modules. Other functions to retrieve the definitions within a module are
|
|
Packit |
022b05 |
documented in \fBsmi_type\fP(3), \fBsmi_node\fP(3), and \fBsmi_macro\fP(3).
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetModule()\fP function retrieves a \fBstruct SmiModule\fP
|
|
Packit |
022b05 |
that represents the SMI module named \fBmodule\fP. Elements not available
|
|
Packit |
022b05 |
or not present for this module contain NULL. If the module is not found,
|
|
Packit |
022b05 |
\fBsmiGetModule()\fP returns NULL.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetFirstModule()\fP and \fBsmiGetNextModule()\fP functions are
|
|
Packit |
022b05 |
used to iteratively retrieve \fBstruct SmiModule\fPs of all known modules.
|
|
Packit |
022b05 |
\fBsmiGetFirstModule()\fP returns the first known module.
|
|
Packit |
022b05 |
Subsequent calls to \fBsmiGetNextModule()\fP return the following ones.
|
|
Packit |
022b05 |
If there are no more modules NULL is returned.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetModuleIdentityNode()\fP function retrieves
|
|
Packit |
022b05 |
a \fBstruct SmiNode\fP that represents the node that is used to
|
|
Packit |
022b05 |
identify the containing MIB module specified by \fIsmiModulePtr\fP.
|
|
Packit |
022b05 |
If there is no such identity node, i.e. if this is not an SMIv2 or
|
|
Packit |
022b05 |
SMIng module converted from SMIv2, \fBsmiGetModuleIdentityNode()\fP
|
|
Packit |
022b05 |
returns NULL.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetFirstImport()\fP and \fBsmiGetNextImport()\fP functions are
|
|
Packit |
022b05 |
used to iteratively retrieve \fBstruct SmiImport\fPs of a given module.
|
|
Packit |
022b05 |
\fBsmiGetFirstImport()\fP returns the first identifier imported by
|
|
Packit |
022b05 |
the module specified by \fIsmiModulePtr\fP.
|
|
Packit |
022b05 |
Subsequent calls to \fBsmiGetNextImport()\fP return the following ones.
|
|
Packit |
022b05 |
If there are no more imported identifiers NULL is returned.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiIsImported()\fP function returns a positive value if the
|
|
Packit |
022b05 |
identifier \fIimportedName\fP defined in the module specified by
|
|
Packit |
022b05 |
\fIimportedModulePtr\fP is imported in the module specified by
|
|
Packit |
022b05 |
\fIsmiModulePtr\fP, or zero otherwise.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetFirstRevision()\fP and \fBsmiGetNextRevision()\fP
|
|
Packit |
022b05 |
functions are used to iteratively retrieve \fBstruct SmiRevision\fPs of
|
|
Packit |
022b05 |
a given module. \fBsmiGetFirstRevision()\fP returns the first (that is
|
|
Packit |
022b05 |
most recent) revision information of the module specified by
|
|
Packit |
022b05 |
\fIsmiModulePtr\fP. Subsequent calls to \fBsmiGetNextRevision()\fP
|
|
Packit |
022b05 |
return the revision after (timely before) that one. If there are no
|
|
Packit |
022b05 |
more revisions NULL is returned.
|
|
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_config "(3), "
|
|
Packit |
022b05 |
.BR smi_node "(3), "
|
|
Packit |
022b05 |
.BR smi.h
|
|
Packit |
022b05 |
.SH "AUTHOR"
|
|
Packit |
022b05 |
(C) 1999-2001 Frank Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>
|
|
Packit |
022b05 |
.br
|