en:docs:fapi:kbdsetcp

Differences

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

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:kbdsetcp [2021/10/06 12:01] – created prokusheven:docs:fapi:kbdsetcp [2021/11/04 13:25] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== KbdSetCp ======
 +
 This call allows the process to set the code page used to translate key strokes received from the keyboard. This call allows the process to set the code page used to translate key strokes received from the keyboard.
  
-==Syntax== +===== Syntax ===== 
- KbdSetCp (Reserved, CodePageID, KbdHandle)+<code c> 
 +KbdSetCp (Reserved, CodePageID, KbdHandle) 
 +</code>
  
-==Parameters== +===== Parameters =====
-;Reserved (USHORT) - input: Reserved and must be set to zero. +
-;CodePageID (USHORT) - input: CodePageID represents a code-page ID in the application's data area. The code-page ID must be equivalent to one of the code-page IDs specified on the CONFIG.SYS CODEPAGE statement or 0000. If the code-page ID does not match one of the IDs on the CODEPAGE statement, an error results. +
-:The code-page word must have one of these code-page identifiers: +
-::{|class="wikitable" +
-!Identifier||Description +
-|- +
-|0||Resident code page +
-|- +
-|437||IBM PC US 437 +
-|- +
-|850||Multilingual +
-|- +
-|860||Portuguese +
-|- +
-|863||Canadian-French +
-|- +
-|865||Nordic +
-|} +
-;KbdHandle (HKBD) - input : Default keyboard or the logical keyboard.+
  
-==Return Code== +  * Reserved (USHORT) - input: Reserved and must be set to zero. 
-;rc (USHORT) - return:Return code descriptions are: +  * CodePageID (USHORT) - input: CodePageID represents a code-page ID in the application's data area. The code-page ID must be equivalent to one of the code-page IDs specified on the CONFIG.SYS CODEPAGE = statement or 0000. If the code-page ID does not match one of the IDs on the CODEPAGE = statement, an error results. 
-*0 NO_ERROR +  * The code-page word must have one of these code-page identifiers: 
-*439 ERROR_KBD_INVALID_HANDLE + 
-*445 ERROR_KBD_FOCUS_REQUIRED +^ Identifier ^ Description ^ 
-*447 ERROR_KBD_KEYBOARD_BUSY +| 0 | Resident code page | 
-*448 ERROR_KBD_INVALID_CODEPAGE +|437| IBM PC US 437 | 
-*464 ERROR_KBD_DETACHED +|850| Multilingual | 
-*504 ERROR_KBD_EXTENDED_SG+|860| Portuguese | 
 +|863| Canadian-French | 
 +|865| Nordic | 
 + 
 +  * KbdHandle (HKBD) - input : Default keyboard or the logical keyboard. 
 + 
 +===== Return Code ===== 
 + 
 +rc (USHORT) - return:Return code descriptions are: 
 + 
 +  *0 NO_ERROR 
 +  *439 ERROR_KBD_INVALID_HANDLE 
 +  *445 ERROR_KBD_FOCUS_REQUIRED 
 +  *447 ERROR_KBD_KEYBOARD_BUSY 
 +  *448 ERROR_KBD_INVALID_CODEPAGE 
 +  *464 ERROR_KBD_DETACHED 
 +  *504 ERROR_KBD_EXTENDED_SG 
 + 
 +===== Remarks =====
  
-==Remarks== 
 Keyboard code page support is not available without the DEVINFO=KBD statement in the CONFIG.SYS file. Refer to IBM Operating System/2 Standard Edition Version 1.2 Using Advanced Features for a complete description of CODEPAGE and DEVINFO.  Keyboard code page support is not available without the DEVINFO=KBD statement in the CONFIG.SYS file. Refer to IBM Operating System/2 Standard Edition Version 1.2 Using Advanced Features for a complete description of CODEPAGE and DEVINFO. 
  
-==Bindings== +===== Bindings ===== 
-===C=== + 
-<PRE>+====C==== 
 +<code c>
 #define INCL_KBD #define INCL_KBD
  
Line 50: Line 55:
  
 USHORT  rc;            /* return code */ USHORT  rc;            /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 EXTRN  KbdSetCp:FAR EXTRN  KbdSetCp:FAR
 INCL_KBD            EQU 1 INCL_KBD            EQU 1
Line 63: Line 68:
  
 Returns WORD Returns WORD
-</PRE>+</code>
  
-[[Category:Kbd]]+{{page>en:templates:fapi}}