Jump to content

KbdGetCp: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
Ak120 (talk | contribs)
mNo edit summary
 
(One intermediate revision by the same user not shown)
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==
==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==
==Parameters==
;ulReserved (ULONG) - input:Reserved. Must be 0.  
;ulReserved (ULONG) - input:Reserved. Must be 0.
;pidCP (PUSHORT) - output:Pointer to Code-page ID.
;pidCP (PUSHORT) - output:Pointer to Code-page ID.
:A pointer to a USHORT in which the code-page ID is returned.
:A pointer to a USHORT in which the code-page ID is returned.
Line 22: Line 11:


==Return Code==
==Return Code==
return (APIRET) - returns
;return (APIRET) - returns:KbdGetCp returns one of the following values:
KbdGetCp returns one of the following values:
* 0 NO_ERROR
* 0 NO_ERROR
* 373 ERROR_KBD_PARAMETER
* 373 ERROR_KBD_PARAMETER
Line 32: Line 20:


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


[[Category:Kbd]]
[[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.