Jump to content

KbdGetLayout: Difference between revisions

From EDM2
Created page with "==Description== Returns the name of the keyboard layout in use. ==Syntax== <PRE> #define INCL_KBD #include <os2.h> PSZ pszName; Keyboard layout name.: HKBD ..."
 
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
==Description==
Returns the name of the keyboard layout in use.
Returns the name of the keyboard layout in use.


Line 12: Line 11:


rc = KbdGetLayout(pszName, hkbd);
rc = KbdGetLayout(pszName, hkbd);
</PRE>


</PRE>
==Parameters==
==Parameters==
; pszName (PSZ) - output : Keyboard layout name.
;pszName (PSZ) - output : Keyboard layout name.
 
:A pointer to the location to return the keyboard layout name. This must be at least 9 bytes long.
A pointer to the location to return the keyboard layout name. This must be at least 9 bytes long.  
;hkbd (HKBD) - input : Reserved. Must be 0.
 
; hkbd (HKBD) - input : Reserved. Must be 0.


==Return Code==
==Return Code==
  rc (APIRET) - returns
  rc (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


* 0          NO_ERROR
[[Category:Kbd]]
* 373        ERROR_KBD_PARAMETER
* 439        ERROR_KBD_INVALID_HANDLE
 
==Remarks==
 
 
==Example Code==
<PRE>
 
</PRE>
==Related Functions==
*
 
 
[[Category:The OS/2 API Project]]

Revision as of 05:03, 6 January 2017

Returns the name of the keyboard layout in use.

Syntax

#define INCL_KBD
#include <os2.h>

PSZ       pszName;  /*  Keyboard layout name. */
HKBD      hkbd;     /*  Reserved.  Must be 0. */
APIRET    rc;       /*  Return code. */

rc = KbdGetLayout(pszName, hkbd);

Parameters

pszName (PSZ) - output
Keyboard layout name.
A pointer to the location to return the keyboard layout name. This must be at least 9 bytes long.
hkbd (HKBD) - input
Reserved. Must be 0.

Return Code

rc (APIRET) - returns

KbdGetHWID returns one of the following values:

  • 0 NO_ERROR
  • 373 ERROR_KBD_PARAMETER
  • 439 ERROR_KBD_INVALID_HANDLE