MIB Viewer

saHpiCtrlTextState

OBJECT-TYPE
1.3.6.1.4.1.18568.2.1.1.4.7.11.1.15
Access
read-write
Status
current
Sub-identifiers
0
This columnar object can be used to write to the text controls. To do so, first set the line number in saHpiCtrlTextLine and then write to this object. The first line of the text control is line number 1 . If less than a full line of data is written, the control will clear all spaces beyond those written on the line. Thus writing a zero-length string will clear the addressed line. It is also possible to include more characters in the text passed in this columnar object than will fit on one line; in this case, the control will wrap to the next line (still clearing the trailing characters on the last line written). Thus, there are two ways to write multiple lines to a text control: (a) set saHpiCtrlTextState repeatedly for each line, or (b) set saHpiCtrlTextState once and send more characters than will fit on one line. An HPI SNMP Manager should not assume any cursor positioning characters are available to use, but rather should always write full lines and allow wrapping to occur. When calling this object, an HPI SNMP Manager may set the line number to 255; in this case, the entire control will be cleared, and the data will be written starting on line 1. (This is different from simply writing at line 1, which only alters the lines written to.) This feature may be used to clear the entire control, which can be accomplished by setting: saHpiCtrlTextLine = 255; saHpiCtrlState = ''; Note that the number of lines and columns in a text control can be obtained from the saHpiCtrlTextMaxLines and saHpiCtrlTextMaxChars. Note that the saHpiCtrlTextLanguage object has the language setting and saHpiCtrlTextType object has the text type. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)
SaHpiText