|
Packit |
022b05 |
.\"
|
|
Packit |
022b05 |
.\" $Id: smi_type.3.in 4432 2006-05-29 16:21:11Z strauss $
|
|
Packit |
022b05 |
.\"
|
|
Packit |
022b05 |
.TH smi_type 3 "August 16, 2001" "IBR" "SMI Management Information Library"
|
|
Packit |
022b05 |
.SH NAME
|
|
Packit |
022b05 |
.\" START OF MAN PAGE COPIES
|
|
Packit |
022b05 |
smiGetType,
|
|
Packit |
022b05 |
smiGetFirstType,
|
|
Packit |
022b05 |
smiGetNextType,
|
|
Packit |
022b05 |
smiGetParentType,
|
|
Packit |
022b05 |
smiGetTypeLine,
|
|
Packit |
022b05 |
smiGetFirstRange,
|
|
Packit |
022b05 |
smiGetNextRange,
|
|
Packit |
022b05 |
smiGetFirstNamedNumber,
|
|
Packit |
022b05 |
smiGetNextNamedNumber,
|
|
Packit |
022b05 |
smiGetTypeModule
|
|
Packit |
022b05 |
.\" END OF MAN PAGE COPIES
|
|
Packit |
022b05 |
\- SMI type
|
|
Packit |
022b05 |
information routines
|
|
Packit |
022b05 |
.SH SYNOPSIS
|
|
Packit |
022b05 |
.nf
|
|
Packit |
022b05 |
.B #include <smi.h>
|
|
Packit |
022b05 |
.RS
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiType *smiGetType(SmiModule *" smiModulePtr ", char *" type );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiType *smiGetFirstType(SmiModule *" smiModulePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiType *smiGetNextType(SmiType *" smiTypePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiType *smiGetParentType(SmiType *" smiTypePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "int smiGetTypeLine(SmiType *" smiTypePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiRange *smiGetFirstRange(SmiType *" smiTypePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiRange *smiGetNextRange(SmiRange *" smiRangePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiNamedNumber *smiGetFirstNamedNumber(SmiType *" smiTypePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiNamedNumber *smiGetNextNamedNumber(SmiNamedNumber *" smiNamedNumberPtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiModule *smiGetTypeModule(SmiType *" smiTypePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiType {
|
|
Packit |
022b05 |
SmiIdentifier name;
|
|
Packit |
022b05 |
SmiBasetype basetype;
|
|
Packit |
022b05 |
SmiDecl decl;
|
|
Packit |
022b05 |
char *format;
|
|
Packit |
022b05 |
SmiValue value;
|
|
Packit |
022b05 |
char *units;
|
|
Packit |
022b05 |
SmiStatus status;
|
|
Packit |
022b05 |
char *description;
|
|
Packit |
022b05 |
char *reference;
|
|
Packit |
022b05 |
} SmiType;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiNamedNumber {
|
|
Packit |
022b05 |
SmiIdentifier name;
|
|
Packit |
022b05 |
SmiValue value;
|
|
Packit |
022b05 |
} SmiNamedNumber;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiRange {
|
|
Packit |
022b05 |
SmiValue minValue;
|
|
Packit |
022b05 |
SmiValue maxValue;
|
|
Packit |
022b05 |
} SmiRange;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
.fi
|
|
Packit |
022b05 |
.SH DESCRIPTION
|
|
Packit |
022b05 |
These functions retrieve information on a type definition (SMIng) or
|
|
Packit |
022b05 |
a simple ASN.1 type definition (SMIv1/v2) or a TEXTUAL-CONVENTION
|
|
Packit |
022b05 |
definition (SMIv2). Base types may also be retrieved by these functions.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetType()\fP function retrieves a \fBstruct SmiType\fP that
|
|
Packit |
022b05 |
represents a type. \fIType\fP may be either a
|
|
Packit |
022b05 |
fully qualified descriptor or a simple type name.
|
|
Packit |
022b05 |
If \fIsmiModulePtr\fP is not NULL it used to limit the search to the
|
|
Packit |
022b05 |
given module. If the type is not found, \fBsmiGetType()\fP returns NULL.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetFirstType()\fP and \fBsmiGetNextType()\fP functions are
|
|
Packit |
022b05 |
used to iteratively retrieve \fBstruct SmiType\fPs. \fBsmiGetFirstType()\fP
|
|
Packit |
022b05 |
returns the first one defined in the module
|
|
Packit |
022b05 |
specified by \fIsmiModulePtr\fP. Subsequent calls to
|
|
Packit |
022b05 |
\fBsmiGetNextType()\fP return the following ones. If there are no
|
|
Packit |
022b05 |
more type definitions in the module NULL is returned.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetParentType()\fP function retrieves a \fBstruct SmiType\fP
|
|
Packit |
022b05 |
of the type from which the type specified by \fIsmiTypePtr\fP is
|
|
Packit |
022b05 |
derived. If there is no parent type (i.e. the type specified
|
|
Packit |
022b05 |
by \fIsmiTypePtr\fP is a base type), \fBsmiGetParentType()\fP returns NULL.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
Similarly, the \fBsmiGetFirstRange()\fP and \fBsmiGetNextRange()\fP
|
|
Packit |
022b05 |
functions are used to iteratively retrieve \fBstruct SmiRange\fPs
|
|
Packit |
022b05 |
that represent range restrictions of the type specified by \fIsmiTypePtr\fP,
|
|
Packit |
022b05 |
either size ranges of an octet string type or value
|
|
Packit |
022b05 |
ranges in case of a numeric type.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
Similarly, the \fBsmiGetFirstNamedNumber()\fP and \fBsmiGetNextNamedNumber()\fP
|
|
Packit |
022b05 |
functions are used to iteratively retrieve \fBstruct SmiNamedNumber\fPs
|
|
Packit |
022b05 |
that represent named numbers of the type specified by \fIsmiTypePtr\fP, which
|
|
Packit |
022b05 |
has to be either a bit set or an enumeration type.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetTypeModule()\fP function returns the module that defines
|
|
Packit |
022b05 |
the type given by \fIstruct SmiTypePtr\fP.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
The \fBsmiGetTypeLine()\fP function returns the line number within the
|
|
Packit |
022b05 |
module where the type specified by \fIsmiTypePtr\fP is defined.
|
|
Packit |
022b05 |
.SH "FILES"
|
|
Packit |
022b05 |
.nf
|
|
Packit |
022b05 |
@includedir@/smi.h SMI library header file
|
|
Packit |
022b05 |
.fi
|
|
Packit |
022b05 |
.SH "SEE ALSO"
|
|
Packit |
022b05 |
.BR libsmi "(3), "
|
|
Packit |
022b05 |
.BR smi_module "(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
|