KbdGetCp: Difference between revisions

Latest revision as of 04:25, 22 December 2017

This function supports the code page switching for the keyboard. It gets the current in-use code page.

Syntax

KbdGetCp(ulReserved, pidCP, hkbd)

Parameters

ulReserved (ULONG) - input: Reserved. Must be 0.
pidCP (PUSHORT) - output: Pointer to Code-page ID.; A pointer to a USHORT in which the code-page ID is returned.
hkbd (HKBD) - input: Reserved. Must be 0.

Return Code

return (APIRET) - returns: KbdGetCp returns one of the following values:

0 NO_ERROR
373 ERROR_KBD_PARAMETER
439 ERROR_KBD_INVALID_HANDLE
445 ERROR_KBD_FOCUS_REQUIRED
447 ERROR_KBD_KEYBOARD_BUSY
504 ERROR_KBD_EXTENDED_SG

Remarks

The code-page ID is the currently active keyboard code page. A value of 0 indicates the default code-page translation table.

@@ Line 1: / Line 1: @@
-==Description==
+This function supports the code page switching for the keyboard. It gets the current in-use code page.
-This function supports the code page switching for the keyboard.
-It gets the current in-use code page.
 ==Syntax==
-<PRE>
+  KbdGetCp(ulReserved, pidCP, hkbd)
-#define INCL_KBD
-#include <os2.h>
-ULONG      ulReserved;  /*  Reserved.  Must be 0. */
-PUSHORT    pidCP;       /*  Pointer to Code-page ID. */
-HKBD       hkbd;        /*  Reserved.  Must be 0. */
-APIRET     return;      /*  Return code. */
-return = KbdGetCp(ulReserved, pidCP, hkbd);
-</PRE>
 ==Parameters==
- ulReserved (ULONG) - input
+;ulReserved (ULONG) - input:Reserved. Must be 0.
+;pidCP (PUSHORT) - output:Pointer to Code-page ID.
-    Reserved. Must be 0.
+:A pointer to a USHORT in which the code-page ID is returned.
+;hkbd (HKBD) - input:Reserved. Must be 0.
-pidCP (PUSHORT) - output
-    Pointer to Code-page ID.
-    A pointer to a USHORT in which the code-page ID is returned.
-hkbd (HKBD) - input
-    Reserved. Must be 0.
 ==Return Code==
- return (APIRET) - returns
+;return (APIRET) - returns:KbdGetCp returns one of the following values:
+* 0 NO_ERROR
-KbdGetCp returns one of the following values:
+* 373 ERROR_KBD_PARAMETER
+* 439 ERROR_KBD_INVALID_HANDLE
-* 0     NO_ERROR.
+* 445 ERROR_KBD_FOCUS_REQUIRED
-* 373   ERROR_KBD_PARAMETER
+* 447 ERROR_KBD_KEYBOARD_BUSY
-* 439   ERROR_KBD_INVALID_HANDLE
+* 504 ERROR_KBD_EXTENDED_SG
-* 445   ERROR_KBD_FOCUS_REQUIRED
-* 447   ERROR_KBD_KEYBOARD_BUSY
-* 504   ERROR_KBD_EXTENDED_SG
 ==Remarks==
 The code-page ID is the currently active keyboard code page. A value of 0 indicates the default code-page translation table.
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]
+[[Category:Kbd]]