Bmip(3tlib)

Bmip -- BMIP response parsing routines

Synopsis

BmipResponseOperation BmipVariableName
BmipResponseClass BmipVariableName
BmipResponseObjectInstance BmipVariableName
BmipResponseAttrValList BmipVariableName
BmipResponseActionType BmipVariableName
BmipResponseActionInfo BmipVariableName
BmipResponseErrorStack BmipVariableName
BmipResponseErrorId BmipVariableName[index]
BmipResponseErrorText BmipVariableName[index]
BmipResponseErrorIsPresent BmipVariableName

Description

These functions provide convenient handling of the BMIP response data structure and its components while hidding its actual format from the caller. A BMIP response is the return value for all of the Object(3tlib) functions in the SCOadmin framework.

BmipResponseOperation: returns the operation name that the BMIP response is an output from.
BmipResponseClass: returns the class name that the BMIP response is an output from.
BmipResponseObjectInstance: returns the name of the object instance that the BMIP response is about.
BmipResponseAttrValList: returns the name of the attributes and their values from a BMIP response.
BmipResponseActionType: returns the name of the specific action that resulted in this BMIP response.
BmipResponseActionInfo: returns the information supplied by the operation action to the client in the BMIP response.
BmipResponseErrorStack: returns the error stack generated by a BMIP Request.
BmipResponseErrorId: returns the identifier for a specific error message on the error stack.
BmipResponseErrorText: returns the text for a specific error message on the error stack.
BmipResponseErrorIsPresent: returns a boolean indicating whether or not there was an error associated with this BMIP response.

Arguments

BmipVariableName: the name of a Tcl variable containing the response from a BMIP request operation.
index: optional index into the error stack. Indicates which message (stack frame) the user wants to know about. Defaults to 0. ``end'' may be used to refer to the bottom most message.

References

Object(3tlib)