lib/smi_macro.3.in

   1 .\"
   2 .\" $Id: smi_macro.3.in 4432 2006-05-29 16:21:11Z strauss $
   3 .\"
   4 .TH smi_macro 3  "August 16, 2001" "IBR" "SMI Management Information Library"
   5 .SH NAME
   6 .\" START OF MAN PAGE COPIES
   7 smiGetMacro,
   8 smiGetFirstMacro,
   9 smiGetNextMacro,
  10 smiGetMacroModule
  11 \- SMI macro and extension information routines
  12 .\" END OF MAN PAGE COPIES
  13 .SH SYNOPSIS
  14 .nf
  15 .B #include <smi.h>
  16 .RS
  17 .RE
  18 .sp
  19 .BI "SmiMacro *smiGetMacro(SmiModule *" smiModulePtr ", char *" macro );
  20 .RE
  21 .sp
  22 .BI "SmiMacro *smiGetFirstMacro(SmiModule *" smiModulePtr );
  23 .RE
  24 .sp
  25 .BI "SmiMacro *smiGetNextMacro(SmiMacro *" smiMacroPtr );
  26 .RE
  27 .sp
  28 .BI "SmiModule *smiGetMacroModule(SmiMacro *" smiMacroPtr );
  29 .RE
  30
  31 typedef struct SmiMacro {
  32     SmiIdentifier       name;
  33     SmiDecl             decl;
  34     SmiStatus           status;
  35     char                *description;
  36     char                *reference;
  37 } SmiMacro;
  38
  39 .fi
  40 .SH DESCRIPTION
  41 These functions retrieve information on an extension statement
  42 definition (SMIng) or a macro (SMIv1/v2).
  43 .PP
  44 The \fBsmiGetMacro()\fP function retrieves a \fBstruct SmiMacro\fP that
  45 represents an extension or macro definition. \fIMacro\fP may be either a
  46 fully qualified descriptor or a simple macro or extension name.
  47 If \fIsmiModulePtr\fP is not NULL it used to limit the search to the
  48 given module. If the macro is not found, \fBsmiGetMacro()\fP returns NULL.
  49 .PP
  50 The \fBsmiGetFirstMacro()\fP and \fBsmiGetNextMacro()\fP functions are
  51 used to iteratively retrieve \fBstruct SmiMacro\fPs.
  52 \fBsmiGetFirstMacro()\fP returns the first one defined in the module
  53 specified by \fIsmiModulePtr\fP.
  54 Subsequent calls to \fBsmiGetNextMacro()\fP return the following ones.
  55 If there are no
  56 more extension or macro definitions in the module, NULL is returned.
  57 .PP
  58 The \fBsmiGetMacroModule()\fP function returns the module that defines
  59 the macro or extension given by \fIstruct SmiMacroPtr\fP.
  60 .SH "FILES"
  61 .nf
  62 @includedir@/smi.h    SMI library header file
  63 .fi
  64 .SH "SEE ALSO"
  65 .BR libsmi "(3), "
  66 .BR smi_module "(3), "
  67 .BR smi.h
  68 .SH "AUTHOR"
  69 (C) 1999-2001 Frank Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>
  70 .br