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

NAME

6       smiGetMacro, smiGetFirstMacro, smiGetNextMacro, smiGetMacroModule - SMI
7       macro and extension information routines
8

SYNOPSIS

10       #include <smi.h>
11
12       SmiMacro *smiGetMacro(SmiModule *smiModulePtr, char *macro);
13
14       SmiMacro *smiGetFirstMacro(SmiModule *smiModulePtr);
15
16       SmiMacro *smiGetNextMacro(SmiMacro *smiMacroPtr);
17
18       SmiModule *smiGetMacroModule(SmiMacro *smiMacroPtr);
19
20       typedef struct SmiMacro {
21           SmiIdentifier       name;
22           SmiDecl             decl;
23           SmiStatus           status;
24           char                *description;
25           char                *reference;
26       } SmiMacro;
27
28

DESCRIPTION

30       These functions retrieve information on an extension statement  defini‐
31       tion (SMIng) or a macro (SMIv1/v2).
32
33       The  smiGetMacro() function retrieves a struct SmiMacro that represents
34       an extension or macro definition. Macro may be either a fully qualified
35       descriptor or a simple macro or extension name.  If smiModulePtr is not
36       NULL it used to limit the search to the given module. If the  macro  is
37       not found, smiGetMacro() returns NULL.
38
39       The  smiGetFirstMacro()  and  smiGetNextMacro()  functions  are used to
40       iteratively retrieve struct SmiMacros.  smiGetFirstMacro() returns  the
41       first  one defined in the module specified by smiModulePtr.  Subsequent
42       calls to smiGetNextMacro() return the following ones.  If there are  no
43       more extension or macro definitions in the module, NULL is returned.
44
45       The  smiGetMacroModule()  function  returns the module that defines the
46       macro or extension given by struct SmiMacroPtr.
47

FILES

49       /usr/include/smi.h    SMI library header file
50

SEE ALSO

52       libsmi(3), smi_module(3), smi.h
53

AUTHOR

55       (C)    1999-2001    Frank    Strauss,    TU    Braunschweig,    Germany
56       <strauss@ibr.cs.tu-bs.de>
57
58
59
60IBR                             August 16, 2001                   smi_macro(3)