KbdGetCp

Description

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

Syntax

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

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.