en:docs:fapi:kbdgetstatus

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:docs:fapi:kbdgetstatus [2021/08/20 07:59] – prokusheven:docs:fapi:kbdgetstatus [2021/09/18 15:30] (current) – prokushev
Line 5: Line 5:
 This call gets the current state of the keyboard. This call gets the current state of the keyboard.
  
-==Syntax== +===== Syntax ===== 
- KbdGetStatus (StatData, KbdHandle)+<code c> 
 +KbdGetStatus (StatData, KbdHandle) 
 +</code>
  
-===Parameters=== +===== Parameters ===== 
-;StatData (PKBDINFO) - output : Address of the keyboard status structure: + 
-:length (USHORT) : Length, in bytes, of this data structure, including length. +  * StatData (PKBDINFO) - output : Address of the keyboard status structure: 
- 10            Only valid value.  +    * length (USHORT) : Length, in bytes, of this data structure, including length. 
-:sysstate (USHORT) : State as follows: +      * 10            Only valid value.  
- '''Bit                Description''' +    * sysstate (USHORT) : State as follows: 
- 15-9                Reserved, set to zero.  + 
- 8                Shift return is on.  +^ Bit ^ Description ^ 
- 7                Length of the turn-around character (meaningful only if bit 6 is on).  +| 15-9 | Reserved, set to zero. | 
- 6                Turn-around character is modified.  +| 8 | Shift return is on. | 
- 5                Interim character flags are modified.  +| 7 | Length of the turn-around character (meaningful only if bit 6 is on). | 
- 4                Shift state is modified.  +| 6 | Turn-around character is modified. | 
- 3                ASCII mode is on.  +| 5 | Interim character flags are modified. | 
- 2                Binary mode is on.  +| 4 | Shift state is modified. | 
- 1                Echo off.  +| 3 | ASCII mode is on. | 
- 0                Echo on.  +| 2 | Binary mode is on. | 
-: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.  +| 1 | Echo off. | 
-:intcharflag (USHORT) : Interim character flags: +| 0 | Echo on. | 
- Bit     Description + 
- 15-8    NLS shift state.  +    * 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.  
- 7       Interim character flag is on.  +    * intcharflag (USHORT) : Interim character flags: 
- 6       Reserved, set to zero.  + 
- 5       Application requested immediate conversion.  +^ Bit ^ Description ^ 
- 4-0     Reserved, set to zero.  +| 15-8 | NLS shift state. | 
-:shiftstate (USHORT) : Shift state as follows: +| 7 | Interim character flag is on. | 
- '''Bit                        Description''' +| 6 | Reserved, set to zero. | 
- 15                        SysReq key down  +| 5 | Application requested immediate conversion. | 
- 14                        CapsLock key down  +| 4-0 | Reserved, set to zero. | 
- 13                        NumLock key down  + 
- 12                        ScrollLock key down  +      * shiftstate (USHORT) : Shift state as follows: 
- 11                        Right Alt key down  + 
- 10                        Right Ctrl key down  +^ Bit ^ Description ^ 
- 9                        Left Alt key down  +| 15 | SysReq key down | 
- 8                        Left Ctrl key down  +| 14 | CapsLock key down | 
- 7                        Insert on  +| 13 | NumLock key down | 
- 6                        CapsLock on  +| 12 | ScrollLock key down | 
- 5                        NumLock on  +| 11 | Right Alt key down | 
- 4                        ScrollLock on  +| 10 | Right Ctrl key down | 
- 3                        Either Alt key down  +| 9 | Left Alt key down | 
- 2                        Either Ctrl key down  +| 8 | Left Ctrl key down | 
- 1                        Left Shift key down  +| 7 | Insert on | 
- 0                        Right Shift key down. +| 6 | CapsLock on | 
-; KbdHandle (HKBD) - input : Default keyboard or the logical keyboard.+| 5 | NumLock on | 
 +| 4 | ScrollLock on | 
 +| 3 | Either Alt key down | 
 +| 2 | Either Ctrl key down | 
 +| 1 | Left Shift key down | 
 +| 0 | Right Shift key down | 
 + 
 +  * KbdHandle (HKBD) - input : Default keyboard or the logical keyboard. 
 + 
 +===== Return Code ===== 
 + 
 +rc ([[USHORT]]) - return
  
-===Return Code=== 
- rc (USHORT) - return 
 Return code descriptions are: Return code descriptions are:
-* 0    NO_ERROR  
-* 376        ERROR_KBD_INVALID_LENGTH  
-* 439        ERROR_KBD_INVALID_HANDLE  
-* 445        ERROR_KBD_FOCUS_REQUIRED  
-* 447        ERROR_KBD_KEYBOARD_BUSY  
-* 464        ERROR_KBD_DETACHED  
-* 504        ERROR_KBD_EXTENDED_SG 
  
-==Remarks==+  * 0    NO_ERROR  
 +  * 376        ERROR_KBD_INVALID_LENGTH  
 +  * 439        ERROR_KBD_INVALID_HANDLE  
 +  * 445        ERROR_KBD_FOCUS_REQUIRED  
 +  * 447        ERROR_KBD_KEYBOARD_BUSY  
 +  * 464        ERROR_KBD_DETACHED  
 +  * 504        ERROR_KBD_EXTENDED_SG 
 + 
 +===== Remarks ===== 
 The initial state of the keyboard is established by the system at application load time. Some default states may be modified by the application through KbdSetStatus. KbdGetStatus returns only those keyboard parameters initially set by KbdSetStatus. The returned parameters are: The initial state of the keyboard is established by the system at application load time. Some default states may be modified by the application through KbdSetStatus. KbdGetStatus returns only those keyboard parameters initially set by KbdSetStatus. The returned parameters are:
-* Input Mode  + 
-* Interim Character Flags  +  * Input Mode  
-* Shift State  +  * Interim Character Flags  
-* Echo State  +  * Shift State  
-* Turnaround Character +  * Echo State  
 +  * Turnaround Character  
 KbdGetStatus completes only when the handle has access to the physical keyboard (focus) or the handle is 0 and no other handle has the focus. KbdGetStatus completes only when the handle has access to the physical keyboard (focus) or the handle is 0 and no other handle has the focus.
  
-===Family API Considerations===+==== Family API Considerations ==== 
 Some options operate differently in the DOS mode than in the OS/2 mode. Therefore, the following restrictions apply to KbdGetStatus when coding in the DOS mode: Some options operate differently in the DOS mode than in the OS/2 mode. Therefore, the following restrictions apply to KbdGetStatus when coding in the DOS mode:
-* Interim character is not supported  +  * Interim character is not supported  
-* TurnAround character is not supported  +  * TurnAround character is not supported  
-* NLS_SHIFT_STATE is always NULL. +  * NLS_SHIFT_STATE is always NULL. 
-* KbdHandle is ignored.+  * KbdHandle is ignored.
  
-==Example Code== +===== Bindings ===== 
-===C Binding=== + 
-<PRE>+==== C Binding ==== 
 + 
 +<code c>
 typedef struct _KBDINFO {     /* kbst */ typedef struct _KBDINFO {     /* kbst */
   USHORT cb;                  /* length in bytes of this structure */   USHORT cb;                  /* length in bytes of this structure */
Line 98: Line 116:
  
 USHORT           rc;            /* return code */ USHORT           rc;            /* return code */
-</PRE>+</code>
  
-===MASM Binding=== +==== MASM Binding ==== 
-<PRE>+ 
 +<code c>
 KBDINFO struc KBDINFO struc
   kbst_cb           dw  ? ;length in bytes of this structure   kbst_cb           dw  ? ;length in bytes of this structure
Line 118: Line 137:
  
 Returns WORD Returns WORD
-</PRE> +</code>
- +
- +
  
-====== Note ======+===== Note =====
  
 This text based on [[http://www.edm2.com/index.php/KbdGetStatus_(FAPI)]] This text based on [[http://www.edm2.com/index.php/KbdGetStatus_(FAPI)]]