|
Packit |
022b05 |
.TH "smi_attribute" "3" "February 10, 2007" "" "SMI Management Information Library"
|
|
Packit |
022b05 |
.SH "NAME"
|
|
Packit |
022b05 |
.\" START OF MAN PAGE COPIES
|
|
Packit |
022b05 |
smiGetAttribute,
|
|
Packit |
022b05 |
smiGetFirstAttribute,
|
|
Packit |
022b05 |
smiGetNextAttribute,
|
|
Packit |
022b05 |
smiGetAttributeParentClass,
|
|
Packit |
022b05 |
smiGetAttributeParentType,
|
|
Packit |
022b05 |
smiGetFirstUniqueAttribute,
|
|
Packit |
022b05 |
smiGetNextUniqueAttribute,
|
|
Packit |
022b05 |
smiGetEvent,
|
|
Packit |
022b05 |
smiGetFirstEvent,
|
|
Packit |
022b05 |
smiGetNextEvent,
|
|
Packit |
022b05 |
smiGetAttributeFirstRange,
|
|
Packit |
022b05 |
smiGetAttributeNextRange,
|
|
Packit |
022b05 |
smiGetAttributeFirstNamedNumber,
|
|
Packit |
022b05 |
smiGetAttributeNextNamedNumber
|
|
Packit |
022b05 |
.\" END OF MAN PAGE COPIES
|
|
Packit |
022b05 |
\- SMI Attribute
|
|
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 "SmiAttribute *smiGetAttribute(SmiClass *" smiClassPtr ", char *" name);
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiAttribute *smiGetFirstAttribute(SmiClass *" smiClassPtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiAttribute *smiGetNextAttribute(SmiAttribute *" smiAttributePtr );
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiType *smiGetAttributeParentType(SmiType *" smiAttributePtr);
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiClass *smiGetAttributeParentClass(SmiType *" smiAttributePtr);
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiAttribute *smiGetFirstUniqueAttribute(SmiClass *" smiClassPtr);
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiAttribute *smiGetNextUniqueAttribute(SmiAttribute *" smiAttributePtr);
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiRange *smiGetAttributeFirstRange(SmiAttribute *" smiAttributePtr);
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiRange *smiGetAttributeNextRange(SmiRange *" smiRangePtr);
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiNamedNumber *smiGetAttributeFirstNamedNumber(SmiAttribute *" smiAttributePtr) ;
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
.sp
|
|
Packit |
022b05 |
.BI "SmiNamedNumber *smiGetAttributeNextNamedNumber(SmiNamedNumber *" smiNamedNumberPtr);
|
|
Packit |
022b05 |
.RE
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiAttribute {
|
|
Packit |
022b05 |
SmiIdentifier name;
|
|
Packit |
022b05 |
SmiDecl decl;
|
|
Packit |
022b05 |
SmiStatus status;
|
|
Packit |
022b05 |
char *description;
|
|
Packit |
022b05 |
char *reference;
|
|
Packit |
022b05 |
} SmiAttribute;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiRange {
|
|
Packit |
022b05 |
SmiValue minValue;
|
|
Packit |
022b05 |
SmiValue maxValue;
|
|
Packit |
022b05 |
} SmiRange;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
typedef struct SmiNamedNumber {
|
|
Packit |
022b05 |
SmiIdentifier name;
|
|
Packit |
022b05 |
SmiValue value;
|
|
Packit |
022b05 |
} SmiNamedNumber;
|
|
Packit |
022b05 |
|
|
Packit |
022b05 |
.fi
|
|
Packit |
022b05 |
.SH "DESCRIPTION"
|
|
Packit |
022b05 |
These functions retrieve information on a SMIng Attribute definition (SMIng).
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
\fBsmiGetAttribute(SmiClass *smiClassPtr, char *name)\fP returns a
|
|
Packit |
022b05 |
pointer to \fBstruct SmiAttribute\fP for the Attribute with the given
|
|
Packit |
022b05 |
\fIname\fP in the given class(\fIsmiClassPtr\fP), or NULL if the
|
|
Packit |
022b05 |
attribute with the given name does not exist.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
\fBsmiGetFirstAttribute(SmiClass *smiClassPtr)\fP and
|
|
Packit |
022b05 |
\fBsmiGetNextAttribute(SmiAttribute *smiAttributePtr)\fP are used to
|
|
Packit |
022b05 |
iterate through the attributes of the class given by
|
|
Packit |
022b05 |
\fIsmiClassPtr\fP. They return a pointer to \fBstruct SmiAttribute\fP
|
|
Packit |
022b05 |
that represents an attribute or NULL if there are no attributes left
|
|
Packit |
022b05 |
in the class, or error has occurred.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
\fBsmiGetAttributeParentClass(SmiAttribute *smiAttributePtr)\fP
|
|
Packit |
022b05 |
returns a pointer to a \fBstruct SmiClass\fP, pointing to the parent
|
|
Packit |
022b05 |
class of the given \fIsmiAttributePtr\fP, or NULL if the attribute
|
|
Packit |
022b05 |
does not reference class. Note that attributes always have either
|
|
Packit |
022b05 |
parent type or parent class.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
\fBsmiGetAttributeParentType(SmiType *smiAttributePtr)\fP returns a
|
|
Packit |
022b05 |
pointer to a \fBstruct SmiType\fP, pointing to the parent type of the
|
|
Packit |
022b05 |
given \fIsmiAttributePtr\fP, or NULL if the attribute does not
|
|
Packit |
022b05 |
reference type. Note that attributes always have either parent type
|
|
Packit |
022b05 |
or parent class.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
\fBsmiGetFirstUniqueAttribute(SmiClass *smiClassPtr)\fP and
|
|
Packit |
022b05 |
\fBsmiGetNextUniqueAttribute(SmiType *smiAttributePtr)\fP are used to
|
|
Packit |
022b05 |
iterate through the unique attributes of the class given by
|
|
Packit |
022b05 |
\fIsmiClassPtr\fP. They return a pointer to \fBstruct SmiAttribute\fP
|
|
Packit |
022b05 |
that represents a unique attribute or NULL if there are no unique
|
|
Packit |
022b05 |
attributes left in the class, or error has occurred. This function
|
|
Packit |
022b05 |
\fBMUST NOT\fP be used for scalar classes, so it should only be called
|
|
Packit |
022b05 |
after \fBisClassScalar()\fP has returned 0.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
\fBsmiGetAttributeFirstRange(SmiAttribute *smiAttributePtr)\fP, and
|
|
Packit |
022b05 |
\fBsmiGetAttributeNextRange(SmiRange *smiRangePtr)\fP are used to
|
|
Packit |
022b05 |
iterate through ranges that restrict number or octet string types.
|
|
Packit |
022b05 |
Both functions return a pointer to the \fBstruct SmiRange\fP
|
|
Packit |
022b05 |
representing the range, or NULL if there are no more ranges, or error
|
|
Packit |
022b05 |
has occurred.
|
|
Packit |
022b05 |
.PP
|
|
Packit |
022b05 |
\fBsmiGetAttributeFirstNamedNumber(SmiAttribute *smiAttributePtr)\fP
|
|
Packit |
022b05 |
and \fBsmiGetAttributeNextNamedNumber(SmiNamedNumber
|
|
Packit |
022b05 |
*smiNamedNumberPtr)\fP are used to iterate through named numbers of
|
|
Packit |
022b05 |
bits or enumerations for attributes, which reference types, and to
|
|
Packit |
022b05 |
retrieve the reference restriction of a pointer. Both functions
|
|
Packit |
022b05 |
return a pointer to the struct SmiNamedNumber representing the named
|
|
Packit |
022b05 |
number, or NULL if there are no named numbers left, or error has
|
|
Packit |
022b05 |
occurred. \fBsmiGetFirstNamedNumber()\fP can be used to retrieve the
|
|
Packit |
022b05 |
name of the identity that is restricting Pointer type, as it is stored
|
|
Packit |
022b05 |
as the name of the first named number.
|
|
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) 2007 Kaloyan Kanev, Jacobs University, Germany <k.kanev@jacobs-university.de>
|
|
Packit |
022b05 |
.br
|