KbdSetStatus

This call sets the characteristics of the keyboard.

 KbdSetStatus (StatData, KbdHandle)

• StatData (PKBDINFO) - input : Address of the keyboard status structure:
  • length (USHORT) : Length, in bytes, of this data structure, including length.
    • 10 - Only valid value.
  • sysstate (USHORT) : The system state altered by this call. If bits 0 and 1 are off, the echo state of the system is not altered. If bits 2 and 3 are off, the binary and ASCII state of the system is not altered. If bits 0 and 1 are on, or if bits 2 and 3 are on, the function returns an error. If binary mode is set, echo is ignored.

• turnchardef (USHORT) : Definition of the turn-around character. In ASCII and extended-ASCII format, the turn-around character is defined as the carriage return. In ASCII format only, the turn-around character is defined in the low-order byte.
• intcharflag (USHORT) : Interim character flags:

• shiftstate (USHORT) : Shift state.

• KbdHandle (HKBD) - input : Default keyboard or the logical keyboard.

rc (USHORT) - return

Return code descriptions are:

• 0 NO_ERROR
• 376 ERROR_KBD_INVALID_LENGTH
• 377 ERROR_KBD_INVALID_ECHO_MASK
• 378 ERROR_KBD_INVALID_INPUT_MASK
• 439 ERROR_KBD_INVALID_HANDLE
• 445 ERROR_KBD_FOCUS_REQUIRED
• 447 ERROR_KBD_KEYBOARD_BUSY
• 464 ERROR_KBD_DETACHED
• 504 ERROR_KBD_EXTENDED_SG

Shift return (bit 8 in sysstate) must be disabled in ASCII mode.

KbdSetStatus is ignored for a Vio-windowed application.

Some options operate differently in the DOS mode than in the OS/2 mode. Therefore, the following restrictions apply to KbdSetStatus when coding in the DOS mode:

• KbdSetStatus does not accept a bit mask of 10 (ASCII on, Echo Off).
• Raw (binary) Mode and Echo On are not supported and return an error if requested.
• KbdHandle is ignored.
• Interim character is not supported.
• Turnaround character is not supported.

typedef struct _KBDINFO {     /* kbst */
  USHORT cb;                  /* length in bytes of this structure */
  USHORT fsMask;              /* bit mask of functions to be altered */
  USHORT chTurnAround;        /* define TurnAround character */
  USHORT fsInterim;           /* interim character flags */
  USHORT fsState;             /* shift states */
}KBDINFO;
 
#define INCL_KBD
 
USHORT  rc = KbdSetStatus(Structure, KbdHandle);
 
PKBDINFO         Structure;     /* Data structure */
HKBD             KbdHandle;     /* Keyboard Handle */
 
USHORT           rc;            /* return code */

KBDINFO struc
  kbst_cb           dw  ? ;length in bytes of this structure
  kbst_fsMask       dw  ? ;bit mask of functions to be altered
  kbst_chTurnAround dw  ? ;define TurnAround character
  kbst_fsInterim    dw  ? ;interim character flags
  kbst_fsState      dw  ? ;shift states
KBDINFO ends
 
EXTRN  KbdSetStatus:FAR
INCL_KBD            EQU 1
 
PUSH@  OTHER   Structure     ;Data structure
PUSH   WORD    KbdHandle     ;Keyboard Handle
CALL   KbdSetStatus
 
Returns WORD

Text based on http://www.edm2.com/index.php/KbdSetStatus_(FAPI)