KbdGetLayoutUni: Difference between revisions

Latest revision as of 20:22, 29 November 2019

Returns the name of the keyboard layout in use.

KbdGetLayoutUni(name, hkbd);

name (USHORT *) - output: Keyboard layout name.; A pointer to the location to return the keyboard layout name in unicode. This must be at least 9 UniChars long.
hkbd (HKBD) - input: Reserved. Must be 0.

@@ Line 1: / Line 1: @@
-==Description==
 Returns the name of the keyboard layout in use.
 ==Syntax==
-<PRE>
+ KbdGetLayoutUni(name, hkbd);
-#define INCL_KBD
-#include <os2.h>
-USHORT     *name;  /*  Keyboard layout name. */
-HKBD        hkbd;  /*  Reserved.  Must be 0. */
-APIRET      rc;    /*  Return code. */
-rc = KbdGetLayoutUni(name, hkbd);
-</PRE>
 ==Parameters==
-;   name (USHORT *) - output : Keyboard layout name.
+;name (USHORT *) - output : Keyboard layout name.
-A pointer to the location to return the keyboard layout name in unicode. This must be at least 9 UniChars long.
+:A pointer to the location to return the keyboard layout name in unicode. This must be at least 9 UniChars long.
+;hkbd (HKBD) - input : Reserved. Must be 0.
-; hkbd (HKBD) - input : Reserved. Must be 0.
 ==Return Code==
- rc (APIRET) - returns
+;rc (APIRET) - returns:KbdGetHWID returns one of the following values:
+* 0 NO_ERROR
+* 373 ERROR_KBD_PARAMETER
+* 439 ERROR_KBD_INVALID_HANDLE
-KbdGetHWID 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==
-*
+*[[KbdSetLayoutUni]]
-[[Category:The OS/2 API Project]]
+[[Category:Kbd]]