1smi_module(3)         SMI Management Information Library         smi_module(3)
2
3
4

NAME

6       smiGetModule,  smiGetFirstModule, smiGetNextModule, smiGetModuleIdenti‐
7       tyNode,  smiGetFirstImport,  smiGetNextImport,  smiIsImported,  smiGet‐
8       FirstRevision, smiGetNextRevision - SMI module information routines
9

SYNOPSIS

11       #include <time.h>
12       #include <smi.h>
13
14       SmiModule *smiGetModule(char *module);
15
16       SmiModule *smiGetFirstModule();
17
18       SmiModule *smiGetNextModule(SmiModule *smiModulePtr);
19
20       SmiNode *smiGetModuleIdentityNode(SmiModule *smiModulePtr);
21
22       SmiImport *smiGetFirstImport(SmiModule *smiModulePtr);
23
24       SmiImport *smiGetNextImport(SmiImport *smiImportPtr);
25
26       int smiIsImported(SmiModule *smiModulePtr, SmiModule *importedModulePtr, char *importedName);
27
28       SmiRevision *smiGetFirstRevision(SmiModule *smiModulePtr);
29
30       SmiRevision *smiGetNextRevision(SmiRevision *smiRevisionPtr);
31
32       typedef struct SmiModule {
33           SmiIdentifier       name;
34           char                *path;
35           char                *organization;
36           char                *contactinfo;
37           char                *description;
38           char                *reference;
39           SmiLanguage         language;
40           int                 conformance;
41       } SmiModule;
42
43       typedef struct SmiRevision {
44           time_t              date;
45           char                *description;
46       } SmiRevision;
47
48       typedef struct SmiImport {
49           SmiIdentifier       module;
50           SmiIdentifier       name;
51       } SmiImport;
52
53

DESCRIPTION

55       These functions retrieve various meta information on MIB modules. Other
56       functions to retrieve the definitions within a module are documented in
57       smi_type(3), smi_node(3), and smi_macro(3).
58
59       The  smiGetModule()  function  retrieves a struct SmiModule that repre‐
60       sents the SMI module  named  module.  Elements  not  available  or  not
61       present  for  this  module  contain  NULL.  If the module is not found,
62       smiGetModule() returns NULL.
63
64       The smiGetFirstModule() and smiGetNextModule() functions  are  used  to
65       iteratively  retrieve  struct SmiModules of all known modules.  smiGet‐
66       FirstModule() returns the first  known  module.   Subsequent  calls  to
67       smiGetNextModule()  return  the  following  ones.  If there are no more
68       modules NULL is returned.
69
70       The smiGetModuleIdentityNode() function retrieves a struct SmiNode that
71       represents  the node that is used to identify the containing MIB module
72       specified by smiModulePtr.  If there is no such identity node, i.e.  if
73       this  is  not an SMIv2 or SMIng module converted from SMIv2, smiGetMod‐
74       uleIdentityNode() returns NULL.
75
76       The smiGetFirstImport() and smiGetNextImport() functions  are  used  to
77       iteratively  retrieve  struct  SmiImports  of  a given module.  smiGet‐
78       FirstImport() returns the first identifier imported by the module spec‐
79       ified  by  smiModulePtr.  Subsequent calls to smiGetNextImport() return
80       the following ones.  If there are no more imported identifiers NULL  is
81       returned.
82
83       The smiIsImported() function returns a positive value if the identifier
84       importedName defined in the module specified  by  importedModulePtr  is
85       imported in the module specified by smiModulePtr, or zero otherwise.
86
87       The  smiGetFirstRevision()  and smiGetNextRevision() functions are used
88       to iteratively retrieve struct SmiRevisions of a given module.  smiGet‐
89       FirstRevision() returns the first (that is most recent) revision infor‐
90       mation of the module specified by  smiModulePtr.  Subsequent  calls  to
91       smiGetNextRevision()  return  the  revision  after (timely before) that
92       one. If there are no more revisions NULL is returned.
93

FILES

95       /usr/include/smi.h    SMI library header file
96

SEE ALSO

98       libsmi(3), smi_config(3), smi_node(3), smi.h
99

AUTHOR

101       (C)    1999-2001    Frank    Strauss,    TU    Braunschweig,    Germany
102       <strauss@ibr.cs.tu-bs.de>
103
104
105
106IBR                             August 16, 2001                  smi_module(3)
Impressum