en:docs:fapi:kbdgetcp

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:kbdgetcp [2021/10/06 12:00] – created prokusheven:docs:fapi:kbdgetcp [2021/11/04 13:26] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +====== KbdGetCp ======
 +
 This call allows a process to query the code page being used to translate scan codes to ASCII characters. This call allows a process to query the code page being used to translate scan codes to ASCII characters.
  
-==Syntax==+===== Syntax ===== 
 +<code c>
  KbdGetCp (Reserved, CodePageID, KbdHandle)  KbdGetCp (Reserved, CodePageID, KbdHandle)
 +</code>
  
-==Parameters== +===== Parameters =====
-;Reserved (ULONG) - input: Reserved and must be set to zero. +
-;CodePageID (PUSHORT) - output: Address of the code page ID located in the application's data area. The keyboard support copies the current code page ID for a specified keyboard handle into this word. The code page ID is equivalent to one of the code page IDs specified in the CONFIG.SYS CODEPAGE statement or 0000. +
-;KbdHandle (HKBD) - input: Default keyboard or the logical keyboard.+
  
-==Return Code== +  * Reserved (ULONG) - input: Reserved and must be set to zero. 
-;rc (USHORT) - return:Return code descriptions are: +  * CodePageID (PUSHORT) - output: Address of the code page ID located in the application's data area. The keyboard support copies the current code page ID for a specified keyboard handle into this word. The code page ID is equivalent to one of the code page IDs specified in the CONFIG.SYS CODEPAGE = statement or 0000. 
-::0 NO_ERROR +  * KbdHandle (HKBD) - input: Default keyboard or the logical keyboard. 
-::373 ERROR_KBD_PARAMETER + 
-::439 ERROR_KBD_INVALID_HANDLE +===== Return Code ===== 
-::445 ERROR_KBD_FOCUS_REQUIRED + 
-::447 ERROR_KBD_KEYBOARD_BUSY +rc (USHORT) - return:Return code descriptions are: 
-::464 ERROR_KBD_DETACHED + 
-::504 ERROR_KBD_EXTENDED_SG+  * 0 NO_ERROR 
 +  373 ERROR_KBD_PARAMETER 
 +  439 ERROR_KBD_INVALID_HANDLE 
 +  445 ERROR_KBD_FOCUS_REQUIRED 
 +  447 ERROR_KBD_KEYBOARD_BUSY 
 +  464 ERROR_KBD_DETACHED 
 +  504 ERROR_KBD_EXTENDED_SG 
 + 
 +===== Remarks =====
  
-==Remarks== 
 The CodePageID is the currently active keyboard code page. A value of 0 indicates the code page translation table in use is the ROM code page translation table provided by the hardware. The CodePageID is the currently active keyboard code page. A value of 0 indicates the code page translation table in use is the ROM code page translation table provided by the hardware.
  
-==Bindings== +===== Bindings ===== 
-===C=== + 
-<PRE>+====C==== 
 +<code c>
 #define INCL_KBD #define INCL_KBD
  
Line 34: Line 44:
  
 USHORT  rc;           /* return code */ USHORT  rc;           /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 EXTRN  KbdGetCp:FAR EXTRN  KbdGetCp:FAR
 INCL_KBD    EQU 1 INCL_KBD    EQU 1
Line 47: Line 57:
  
 Returns WORD Returns WORD
-</PRE>+</code>
  
-[[Category:Kbd]]+{{page>en:templates:fapi}}