KbdGetHWId: Difference between revisions
Created page with "==Description== Returns the attached keyboard's hardware-generated Identification value. ==Syntax== <PRE> KbdGetHWId (KeyboardID, KbdHandle) </PRE> ==Parameters== ; K..." |
mNo edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Returns the attached keyboard's hardware-generated Identification value. | Returns the attached keyboard's hardware-generated Identification value. | ||
==Syntax== | ==Syntax== | ||
KbdGetHWId (KeyboardID, KbdHandle) | |||
KbdGetHWId | |||
==Parameters== | ==Parameters== | ||
; | ;KeyboardID (P[[KBDHWID]]) - input : Pointer to the caller's data area. | ||
;KbdHandle (HKBD) - input : Word identifying the logical keyboard. | |||
; KbdHandle (HKBD) - input : Word identifying the logical keyboard. | |||
==Return Code== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | |||
* 0 NO_ERROR | |||
*373 ERROR_KBD_PARAMETER | |||
Return code descriptions are: | *447 ERROR_KBD_KEYBOARD_BUSY | ||
*464 ERROR_KBD_DETACHED | |||
* 0 | *504 ERROR_KBD_EXTENDED_SG | ||
* 373 | |||
* 447 | |||
* 464 | |||
* 504 | |||
==Remarks== | ==Remarks== | ||
In past OS/2 releases, all keyboards could be supported by knowing the hardware family information available with keyboard IOCTL 77H. However, with the addition of the 122-key keyboard, recognition was not containable by hardware family information alone. The 122-key keyboard has a number of differences from other keyboards. Therefore, applications performing keystroke specific functions may need to determine specifically which keyboard is attached. | In past OS/2 releases, all keyboards could be supported by knowing the hardware family information available with keyboard IOCTL 77H. However, with the addition of the 122-key keyboard, recognition was not containable by hardware family information alone. The 122-key keyboard has a number of differences from other keyboards. Therefore, applications performing keystroke specific functions may need to determine specifically which keyboard is attached. | ||
This function is of particular usefulness for applications providing Custom Translate Tables and mapping keyboard layouts. | This function is of particular usefulness for applications providing Custom Translate Tables and mapping keyboard layouts. | ||
== | ==Bindings== | ||
===C | ===C=== | ||
<PRE> | <PRE> | ||
typedef struct _KBDHWID { | typedef struct _KBDHWID { | ||
USHORT length; | USHORT length; /* length in bytes of this structure */ | ||
USHORT kbd_id; | USHORT kbd_id; /* attached keyboard's hardware ID (returned) */ | ||
USHORT reserved1; /* reserved (set to zero) */ | |||
USHORT reserved1; | USHORT reserved2; /* reserved (set to zero) */ | ||
USHORT reserved2; | |||
}KBDHWID; | }KBDHWID; | ||
| Line 61: | Line 35: | ||
USHORT rc = KbdGetHWId(KeyboardID, KbdHandle); | USHORT rc = KbdGetHWId(KeyboardID, KbdHandle); | ||
PKBDHWID | PKBDHWID KeyboardID; /* Keyboard ID structure (returned) */ | ||
HKBD | HKBD KbdHandle; /* Keyboard handle */ | ||
USHORT | USHORT rc; /* return code */ | ||
</PRE> | </PRE> | ||
===MASM | ===MASM=== | ||
<PRE> | <PRE> | ||
KBDHWID struc | KBDHWID struc | ||
| Line 85: | Line 59: | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
[[Category: | [[Category:Kbd]] | ||
Latest revision as of 17:22, 11 December 2019
Returns the attached keyboard's hardware-generated Identification value.
Syntax
KbdGetHWId (KeyboardID, KbdHandle)
Parameters
- KeyboardID (PKBDHWID) - input
- Pointer to the caller's data area.
- KbdHandle (HKBD) - input
- Word identifying the logical keyboard.
Return Code
- rc (USHORT) - return
- Return code descriptions are:
- 0 NO_ERROR
- 373 ERROR_KBD_PARAMETER
- 447 ERROR_KBD_KEYBOARD_BUSY
- 464 ERROR_KBD_DETACHED
- 504 ERROR_KBD_EXTENDED_SG
Remarks
In past OS/2 releases, all keyboards could be supported by knowing the hardware family information available with keyboard IOCTL 77H. However, with the addition of the 122-key keyboard, recognition was not containable by hardware family information alone. The 122-key keyboard has a number of differences from other keyboards. Therefore, applications performing keystroke specific functions may need to determine specifically which keyboard is attached.
This function is of particular usefulness for applications providing Custom Translate Tables and mapping keyboard layouts.
Bindings
C
typedef struct _KBDHWID {
USHORT length; /* length in bytes of this structure */
USHORT kbd_id; /* attached keyboard's hardware ID (returned) */
USHORT reserved1; /* reserved (set to zero) */
USHORT reserved2; /* reserved (set to zero) */
}KBDHWID;
#define INCL_KBD
USHORT rc = KbdGetHWId(KeyboardID, KbdHandle);
PKBDHWID KeyboardID; /* Keyboard ID structure (returned) */
HKBD KbdHandle; /* Keyboard handle */
USHORT rc; /* return code */
MASM
KBDHWID struc length; dw ? ;length in bytes of this structure kbd_id; dw ? ;attached keyboard's hardware ID (returned) reserved1; dw ? ;reserved (set to zero) reserved2; dw ? ;reserved (set to zero) KBDHWID ends EXTRN KbdGetHWId:FAR INCL_KBD EQU 1 PUSH@ OTHER KeyboardID ;Keyboard ID structure (returned) PUSH WORD KbdHandle ;Keyboard handle CALL KbdGetHWId Returns WORD