KbdSetLayout: Difference between revisions

Revision as of 05:08, 6 January 2017

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

Syntax

#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);

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

KbdGetLayout

@@ Line 1: / Line 1: @@
-==Description==
 Allows the keyboard layout to be changed. This change affects only the current session.
@@ Line 12: / Line 11: @@
 rc = KbdSetLayout(pszName, hkbd);
+</PRE>
-</PRE>
 ==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==
   rc (APIRET) - returns
 KbdSetLayout returns one of the following values:
+* 0 NO_ERROR
+* 373 ERROR_KBD_PARAMETER
+* 439 ERROR_KBD_INVALID_HANDLE
-* 0          NO_ERROR
-* 373        ERROR_KBD_PARAMETER
-* 439        ERROR_KBD_INVALID_HANDLE
-==Remarks==
-==Example Code==
-<PRE>
-</PRE>
 ==Related Functions==
-*
+*[[KbdGetLayout]]
-[[Category:The OS/2 API Project]]
+[[Category:Kbd]]