Description This command reports the full range of information available, including the information that is provided by the service provider.
Input Param None.
Output Param LPWFSTTUSTATUS lpStatus;
typedef struct _wfs_ttu_status
{
WORD fwDevice;
WORD wKeyboard;
WORD wKeyLock;
WORD wLEDs [WFS_TTU_LEDS_MAX];
WORD wDisplaySizeX;
WORD wDisplaySizeY;
LPSTR lpszExtra;
} WFSTTUSTATUS, * LPWFSTTUSTATUS;
fwDevice
Specifies the state of the text terminal unit as one of the following flags:
Value Meaning
WFS_TTU_DEVONLINE The device is on-line. The device is present and operational (i.e. not busy processing a request and not having a hardware error).
WFS_TTU_DEVOFFLINE The device is off-line. The device is present and powered on but it is not operational (e.g. a switch may have been used to change it to an off-line state).
WFS_TTU_DEVPOWEROFF The device is powered off. The device is present, but is currently powered off.
WFS_TTU_DEVBUSY The device is busy processing a request. The device is present and an EXECUTE request is currently being processed.
WFS_TTU_DEVNODEVICE There is no device connected.
WFS_TTU_DEVHWERROR The device is inoperable due to a hardware error. The device is present but a hardware fault prevents it from being used.
WFS_TTU_DEVUSERERROR The device is present but a person is preventing proper operation. The application should suspend the device operation or remove the device from service until the service provider generates a device state change event indicating the condition of the device has changed i.e. the error is removed (WFS_TTU_DEVONLINE) or a permanent error condition has occurred (WFS_TTU_DEVHWERROR).
wKeyboard
Specifies the state of the keyboard in the text terminal unit as one of the following flags:
Value Meaning
WFS_TTU_KBDON The keyboard is activated.
WFS_TTU_KBDOFF The keyboard is not activated.
WFS_TTU_KBDNA The keyboard is not available.
wKeyLock
Specifies the state of the keyboard lock of the text terminal unit as one of the following flags:
Value Meaning
WFS_TTU_KBDLOCKON The keyboard lock switch is activated.
WFS_TTU_KBDLOCKOFF The keyboard lock switch is not activated.
WFS_TTU_KBDLOCKNA The keyboard lock switch is not available.
wLEDs [WFS_TTU_LEDS_MAX]
Specifies the state of the LEDs. The maximum guidance light index is WFS_TTU_LEDS_MAX. The number of available LEDs can be retrieved with the WFS_INF_TTU_CAPABILITIES info command. All member elements in this array are specified as one of the following flags:
Value Meaning
WFS_TTU_LEDNA The status is not available.
WFS_TTU_LEDOFF The LED is turned off.
WFS_TTU_LEDSLOWFLASH The LED is blinking slowly.
WFS_TTU_LEDMEDIUMFLASH The LED is blinking medium frequency.
WFS_TTU_LEDQUICKFLASH The LED is blinking quickly.
WFS_TTU_LEDCONTINUOUS The light is turned on continuous (steady).
wDisplaySizeX
Specifies the horizontal size of the display of the text terminal unit (the number of columns that can be displayed).
wDisplaySizeY
Specifies the vertical size of the display of the text terminal unit (the number of rows that can be displayed).
lpszExtra
Specifies a list of vendor-specific, or any other extended, information. The information is returned as a series of "key=value" strings so that it is easily extensible by service providers. Each string will be null-terminated, with the final string terminating with two null characters.
Error Codes There are no additional error codes generated by this command.
Comments Applications which require or expect specific information to be present in the lpszExtra parameter may not be device or vendor-independent.