Jump to content

KbdSetLayout: Difference between revisions

From EDM2
Created page with "==Description== Allows the keyboard layout to be changed. This change affects only the current session. ==Syntax== <PRE> #define INCL_KBD #include <os2.h> PSZ pszName;..."
 
Ak120 (talk | contribs)
mNo edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Description==
Allows the keyboard layout to be changed. This change affects only the current session.
Allows the keyboard layout to be changed. This change affects only the current session.


==Syntax==
==Syntax==
<PRE>
KbdSetLayout(pszName, hkbd)
#define INCL_KBD
#include <os2.h>


PSZ      pszName;  /*  Keyboard layout name. */
HKBD      hkbd;    /*  Reserved.  Must be zero. */
APIRET    rc;      /*  Return code. */
rc = KbdSetLayout(pszName, hkbd);
</PRE>
==Parameters==  
==Parameters==  
; pszName (PSZ) - input : Keyboard layout name.
;pszName (PSZ) - input: Keyboard layout name.
 
:The name of the keyboard layout. The length of the name cannot exceed 8 characters.
The name of the keyboard layout. The length of the name cannot exceed 8 characters.  
;hkbd (HKBD) - input: Reserved. Must be zero.
 
; hkbd (HKBD) - input : Reserved. Must be zero.  


==Return Code==
==Return Code==
;rc (APIRET) - returns:KbdSetLayout returns one of the following values:
* 0 NO_ERROR
*373 ERROR_KBD_PARAMETER
*439 ERROR_KBD_INVALID_HANDLE


rc (APIRET) - returns
KbdSetLayout returns one of the following values:
* 0          NO_ERROR
* 373        ERROR_KBD_PARAMETER
* 439        ERROR_KBD_INVALID_HANDLE
==Remarks==
==Example Code==
<PRE>
</PRE>
==Related Functions==
==Related Functions==
*  
*[[KbdGetLayout]]
 


[[Category:The OS/2 API Project]]
[[Category:Kbd]]

Latest revision as of 20:14, 29 November 2019

Allows the keyboard layout to be changed. This change affects only the current session.

Syntax

KbdSetLayout(pszName, hkbd)

Parameters

pszName (PSZ) - input
Keyboard layout name.
The name of the keyboard layout. The length of the name cannot exceed 8 characters.
hkbd (HKBD) - input
Reserved. Must be zero.

Return Code

rc (APIRET) - returns
KbdSetLayout returns one of the following values:
  • 0 NO_ERROR
  • 373 ERROR_KBD_PARAMETER
  • 439 ERROR_KBD_INVALID_HANDLE

Related Functions