smirendertype(3) [debian man page]

smi_render(3)						SMI Management Information Library					     smi_render(3)

NAME

       smiRenderOID, smiRenderValue, smiRenderNode, smiRenderType - SMI data and MIB data rendering routines

SYNOPSIS

       #include <smi.h>

       char *smiRenderOID(unsigned int oidlen, SmiSubid *oid, int flags);

       char *smiRenderValue(SmiValue *smiValuePtr, SmiType *smiTypePtr, int flags);

       char *smiRenderNode(SmiNode *smiNodePtr, int flags);

       char *smiRenderType(SmiType *smiTypePtr, int flags);

DESCRIPTION

       These functions provide can be used to render OIDs, values of MIB data, or names of MIB nodes or types.

       The smiRenderOID() function renders an OID given by its length oidlen and its array of sub-identifiers oid*.  The flags can be used to con-
       trol the resulting format, see FORMATS below.

       The smiRenderValue() function renders a MIB data value given by smiValuePtr. An underlying type smiTypePtr may be  supplied  to	support  a
       more human friendly rendering.  The flags can be used to control the resulting format, see FORMATS below.

       The  smiRenderNode()  function  renders the name of a node given by smiNodePtr.	The flags can be used to control the resulting format, see
       FORMATS below.

       The smiRenderType() function renders the name of a type given by smiTypePtr.  The flags can be used to control the  resulting  format,  see
       FORMATS below.

FORMATS

       Each  of these functions gets a last argument named flags. This is a logcially or-ed set of flags that can be used to control the format of
       the rendered items:

       SMI_RENDER_NUMERIC
	      Allow numeric representation (default).

       SMI_RENDER_NAME
	      Allow a representation by name(s) if possible.

       SMI_RENDER_QUALIFIED
	      In case of a name representation, force a module prefix, e.g. IF-MIB::ifIndex instead of just ifIndex.

       SMI_RENDER_FORMAT
	      In case of smiRenderValue(), force the application of a format specification (e.g. an SMIv2 DISPLAY-HINT) of an underlying  type	if
	      the smiTypePtr argument is not NULL and this type contains such a format specification.

       SMI_RENDER_PRINTABLE
	      In case of octet string value rendering, force a printable representation if all octets of the octet string are printable.

       SMI_RENDER_UNKNOWN
	      Force  the  return of a string containing SMI_LABEL_UNKNOWN ("<unknown>"), if the rendering would fail. This way, the only condition
	      where NULL can be returned is the lack of memory.

       SMI_RENDER_ALL
	      Apply a combination of all these flags. This supports the (hopefully) most human friendly representations.

RETURN VALUE

       All of these functions return a string, if successful, or NULL in case of a rendering failure. See also the SMI_RENDER_UNKNOWN flag above.

SEE ALSO

       libsmi(3), smi.h

AUTHOR

       (C) 2002 Frank Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>

IBR
								   July 24, 2002						     smi_render(3)

smi_type(3)						SMI Management Information Library					       smi_type(3)

NAME

       smiGetType,  smiGetFirstType,  smiGetNextType, smiGetParentType, smiGetTypeLine, smiGetFirstRange, smiGetNextRange, smiGetFirstNamedNumber,
       smiGetNextNamedNumber, smiGetTypeModule - SMI type information routines

SYNOPSIS

       #include <smi.h>

       SmiType *smiGetType(SmiModule *smiModulePtr, char *type);

       SmiType *smiGetFirstType(SmiModule *smiModulePtr);

       SmiType *smiGetNextType(SmiType *smiTypePtr);

       SmiType *smiGetParentType(SmiType *smiTypePtr);

       int smiGetTypeLine(SmiType *smiTypePtr);

       SmiRange *smiGetFirstRange(SmiType *smiTypePtr);

       SmiRange *smiGetNextRange(SmiRange *smiRangePtr);

       SmiNamedNumber *smiGetFirstNamedNumber(SmiType *smiTypePtr);

       SmiNamedNumber *smiGetNextNamedNumber(SmiNamedNumber *smiNamedNumberPtr);

       SmiModule *smiGetTypeModule(SmiType *smiTypePtr);

       typedef struct SmiType {
	   SmiIdentifier       name;
	   SmiBasetype	       basetype;
	   SmiDecl	       decl;
	   char 	       *format;
	   SmiValue	       value;
	   char 	       *units;
	   SmiStatus	       status;
	   char 	       *description;
	   char 	       *reference;
       } SmiType;

       typedef struct SmiNamedNumber {
	   SmiIdentifier       name;
	   SmiValue	       value;
       } SmiNamedNumber;

       typedef struct SmiRange {
	   SmiValue	       minValue;
	   SmiValue	       maxValue;
       } SmiRange;

DESCRIPTION

       These functions retrieve information on a type definition (SMIng) or a simple ASN.1 type definition (SMIv1/v2) or a TEXTUAL-CONVENTION def-
       inition (SMIv2). Base types may also be retrieved by these functions.

       The  smiGetType()  function  retrieves a struct SmiType that represents a type. Type may be either a fully qualified descriptor or a simple
       type name.  If smiModulePtr is not NULL it used to limit the search to the given module. If the type is	not  found,  smiGetType()  returns
       NULL.

       The  smiGetFirstType() and smiGetNextType() functions are used to iteratively retrieve struct SmiTypes. smiGetFirstType() returns the first
       one defined in the module specified by smiModulePtr. Subsequent calls to smiGetNextType() return the following ones.  If there are no  more
       type definitions in the module NULL is returned.

       The  smiGetParentType() function retrieves a struct SmiType of the type from which the type specified by smiTypePtr is derived. If there is
       no parent type (i.e. the type specified by smiTypePtr is a base type), smiGetParentType() returns NULL.

       Similarly, the smiGetFirstRange() and smiGetNextRange() functions are used to iteratively retrieve struct SmiRanges  that  represent  range
       restrictions of the type specified by smiTypePtr, either size ranges of an octet string type or value ranges in case of a numeric type.

       Similarly,  the smiGetFirstNamedNumber() and smiGetNextNamedNumber() functions are used to iteratively retrieve struct SmiNamedNumbers that
       represent named numbers of the type specified by smiTypePtr, which has to be either a bit set or an enumeration type.

       The smiGetTypeModule() function returns the module that defines the type given by struct SmiTypePtr.

       The smiGetTypeLine() function returns the line number within the module where the type specified by smiTypePtr is defined.

FILES

       ${prefix}/include/smi.h	  SMI library header file

SEE ALSO

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

AUTHOR

       (C) 1999-2001 Frank Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>

IBR
								  August 16, 2001						       smi_type(3)