These functions retrieve information on any SMI node definition in the object identifier tree, these are
ASN.1 object identifier assignments, MODULE-IDENTITYs, OBJECT-IDENTITYs, OBJECT-TYPEs, NOTIFICATION-
TYPEs, TRAP-TYPEs, OBJECT-GROUPs, NOTIFICATION-GROUPs, MODULE-COMPLIANCEs, and AGENT-CAPABILITYs in
SMIv1/v2 and node, scalar, table, row, column, notification, group, and compliance statements in SMIng.
The smiGetNode() function retrieves a structSmiNode that represents a node of any kind. Node may be
either a fully qualified descriptor, a simple node name, or a numerical OID. Nodes are also found, if
node contains an instance identifier suffix. If smiModulePtr is not NULL it used to limit the search to
the given module. If the node is not found, smiGetNode() returns NULL.
The smiGetNodeByOID() function retrieves a structSmiNode that matches the longest prefix of the node
that is specified by the object identifier oid[] with the length oidlen. If no such node is not found,
smiGetNodeByOID() returns NULL.
The smiGetFirstNode() and smiGetNextNode() functions are used to iteratively retrieve structSmiNodes in
tree pre-order. smiGetFirstNode() returns the first node defined in the module specified by smiModulePtr
that is of any kind specified in the kinds bitset. Subsequent calls to smiGetNextNode() return the next
node of any kind specified in the kinds bitset. If there are no more node definitions in the module, NULL
is returned.
The smiGetFirstChildNode() and smiGetNextChildNode() functions are used to iteratively retrieve structSmiNodes that represent the immediate child nodes of the node specified by smiNodePtr passed to the
smiGetFirstChildNode() call.
The smiGetParentNode() function is used to retrieve a structSmiNodes that represents the parent node of
the node specified by smiNodePtr.
The smiGetRelatedNode() function is used to retrieve a structSmiNodes that is related to the node
specified by smiNodePtr. Actually, this is used for SMIv2 table augmentation entries and similar SMIng
constructs.
The smiGetNodeModule() function returns the module that defines the node given by structSmiNodePtr.
The smiGetNodeType() function returns the type of the (scalar or columnar) node given by structSmiNodePtr. If structSmiNodePtr does not specify a scalar or columnar node, NULL is returned.
The smiGetFirstElement() and smiGetNextElement() functions are used to iteratively retrieve structSmiElements that represent elements of index clauses or notification object lists, groups of object types
or notification types, and mandatory groups of module compliance statements. The node to which the list
belongs has to be specified by smiNodePtr. To retrieve the node that is represented by a structSmiElement, the smiGetElementNode() function has to be called.
The smiGetFirstOption() and smiGetNextOption() functions are used to iteratively retrieve structSmiOptions that represent statements on optional (object or notification) groups within the compliance
statement specified by smiComplianceNodePtr. The group node which is subject of such a statement can be
retrieved by the smiGetOptionNode() function.
Similarly, the smiGetFirstRefinement() and smiGetNextRefinement() functions are used to iteratively
retrieve structSmiRefinements that represent statements on optional object refinements within the
compliance statement specified by smiComplianceNodePtr. The node which is subject of such a refinement
can be retrieved by the smiGetRefinementNode() function. The optional refined type and write-type of a
refinement can be retrieved by the smiGetRefinementType() and smiGetRefinementWriteType() functions. If
they are not present, NULL is returned.
The smiGetNodeLine() function returns the line number within the module where the node specified by
smiNodePtr is defined.