KbdGetCp: Difference between revisions
m Martini moved page OS2 API:KbdGetCp to OS2 API:CPI:KbdGetCp |
mNo edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This function supports the code page switching for the keyboard. | This function supports the code page switching for the keyboard. It gets the current in-use code page. | ||
It gets the current in-use code page. | |||
[[Category: | ==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. | |||
[[Category:Kbd]] | |||
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.