KbdGetHWID: Difference between revisions
Created page with "==Description== Returns the type of keyboard in use. The hardware ID specifies the type of keyboard attached and is defined by the manufacturer. ==Syntax== <PRE> #define INCL..." |
mNo edit summary |
||
| Line 12: | Line 12: | ||
return = KbdGetHWID(pkbdhwid, hkbd); | return = KbdGetHWID(pkbdhwid, hkbd); | ||
</PRE> | |||
==Parameters== | ==Parameters== | ||
; | ;pkbdhwid (PKBDHWID) - output : Pointer to hardware ID. | ||
A pointer to a KBDHWID structure in which the keyboard hardware ID is returned. | :A pointer to a KBDHWID structure in which the keyboard hardware ID is returned. | ||
;hkbd (HKBD) - input : Reserved. Must be 0. | |||
==Return Code== | ==Return Code== | ||
return (APIRET) - returns | return (APIRET) - returns | ||
KbdGetHWID returns one of the following values: | KbdGetHWID returns one of the following values: | ||
* 0 NO_ERROR | |||
* 373 ERROR_KBD_PARAMETER | |||
* 439 ERROR_KBD_INVALID_HANDLE | |||
* 447 ERROR_KBD_KEYBOARD_BUSY | |||
* 504 ERROR_KBD_EXTENDED_SG | |||
==Remarks== | ==Remarks== | ||
The hardware ID indicates the basic layout of the keyboard, such as whether or not a numeric keypad exists. It gives no information about key values. | The hardware ID indicates the basic layout of the keyboard, such as whether or not a numeric keypad exists. It gives no information about key values. | ||
[[Category: | [[Category:Kbd]] | ||
Revision as of 20:54, 29 November 2016
Description
Returns the type of keyboard in use. The hardware ID specifies the type of keyboard attached and is defined by the manufacturer.
Syntax
#define INCL_KBD #include <os2.h> PKBDHWID pkbdhwid; /* Pointer to hardware ID. */ HKBD hkbd; /* Reserved. Must be 0. */ APIRET return; /* Return code. */ return = KbdGetHWID(pkbdhwid, hkbd);
Parameters
- pkbdhwid (PKBDHWID) - output
- Pointer to hardware ID.
- A pointer to a KBDHWID structure in which the keyboard hardware ID is returned.
- hkbd (HKBD) - input
- Reserved. Must be 0.
Return Code
return (APIRET) - returns
KbdGetHWID returns one of the following values:
- 0 NO_ERROR
- 373 ERROR_KBD_PARAMETER
- 439 ERROR_KBD_INVALID_HANDLE
- 447 ERROR_KBD_KEYBOARD_BUSY
- 504 ERROR_KBD_EXTENDED_SG
Remarks
The hardware ID indicates the basic layout of the keyboard, such as whether or not a numeric keypad exists. It gives no information about key values.