Jump to content

KbdGetHWID: Difference between revisions

From EDM2
Ak120 (talk | contribs)
m Ak120 moved page OS2 API:CPI:KbdGetHWID to KbdGetHWID
Ak120 (talk | contribs)
mNo edit summary
 
Line 1: Line 1:
==Description==
Returns the type of keyboard in use. The hardware ID specifies the type of keyboard attached and is defined by the manufacturer.
Returns the type of keyboard in use. The hardware ID specifies the type of keyboard attached and is defined by the manufacturer.


==Syntax==
==Syntax==
<PRE>
  KbdGetHWID(pkbdhwid, hkbd)
#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);
</PRE>


==Parameters==
==Parameters==
;pkbdhwid (PKBDHWID) - output : Pointer to hardware ID.
;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.
;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
* 0  NO_ERROR
* 373 ERROR_KBD_PARAMETER
* 373 ERROR_KBD_PARAMETER

Latest revision as of 16:40, 3 January 2019

Returns the type of keyboard in use. The hardware ID specifies the type of keyboard attached and is defined by the manufacturer.

Syntax

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.