en:docs:fapi:kbdsetcustxt

Differences

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

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:kbdsetcustxt [2021/10/06 12:02] – created prokusheven:docs:fapi:kbdsetcustxt [2021/12/01 13:29] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== KbdSetCustXt ======
 +
 This call installs, on the specified handle, the translate table which this call points to. This translate table affects only this handle. This call installs, on the specified handle, the translate table which this call points to. This translate table affects only this handle.
  
-==Syntax==+====== Syntax ====== 
 +<code c>
  KbdSetCustXt (Xlatetable, KbdHandle)  KbdSetCustXt (Xlatetable, KbdHandle)
 +</code>
  
-==Parameters== +====== Parameters ======
-;Xlatetable (PUSHORT) - input : A pointer to the translation table used to translate scan code to ASCII code for a specified handle. The format of the translate table is documented in the Set Code Page IOCTL 50H. Refer to ''IBM Operating System/2 Version 1.2 I/O Subsystems and Device Support Volume 1'' for a complete discussion of Set Code Page IOCTL 50H. +
-;KbdHandle (HKBD) - input : Default keyboard or the logical keyboard.+
  
-==Return Code== +  * Xlatetable (PUSHORT) - input : A pointer to the translation table used to translate scan code to ASCII code for a specified handle. The format of the translate table is documented in the Set Code Page IOCTL 50H. Refer to [[http://www.os2museum.com/files/docs/os212pti/64F3959_OS2_V1_2_PTI_IO_Subsystems_and_Device_Support_Vol_1_Device_Drivers.pdf|IBM Operating System/2 Version 1.2 I/O Subsystems and Device Support Volume 1]] for a complete discussion of Set Code Page IOCTL 50H. 
-;rc (USHORT) - return:Return code descriptions are: +  * KbdHandle (HKBD) - input : Default keyboard or the logical keyboard. 
-* 0 NO_ERROR + 
-* 377 ERROR_KBD_INVALID_ECHO_MASK +====== Return Code ====== 
-* 378 ERROR_KBD_INVALID_INPUT_MASK + 
-* 439 ERROR_KBD_INVALID_HANDLE +rc (USHORT) - return:Return code descriptions are: 
-* 445 ERROR_KBD_FOCUS_REQUIRED + 
-* 447 ERROR_KBD_KEYBOARD_BUSY +  * 0 NO_ERROR 
-* 464 ERROR_KBD_DETACHED +  * 377 ERROR_KBD_INVALID_ECHO_MASK 
-* 504 ERROR_KBD_EXTENDED_SG+  * 378 ERROR_KBD_INVALID_INPUT_MASK 
 +  * 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 translate table must be maintained in the caller's memory. No copy of the translate table is made by KbdSetCustXt. The translate table must be maintained in the caller's memory. No copy of the translate table is made by KbdSetCustXt.
  
 [[KbdSetCp]] reverses the action of KbdSetCustXt and sets the handle equal to one of the system translate tables. If memory is dynamically allocated by the caller for the translate table and is freed before the KbdSetCp is performed, KbdSetCp and future translations may fail. [[KbdSetCp]] reverses the action of KbdSetCustXt and sets the handle equal to one of the system translate tables. If memory is dynamically allocated by the caller for the translate table and is freed before the KbdSetCp is performed, KbdSetCp and future translations may fail.
  
-==Bindings== +====== Bindings ====== 
-=== C === + 
-<PRE>+==== C ==== 
 +<code c>
 #define INCL_KBD #define INCL_KBD
  
Line 35: Line 46:
  
 USHORT  rc;            /* return code */ USHORT  rc;            /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 EXTRN  KbdSetCustXt:FAR EXTRN  KbdSetCustXt:FAR
 INCL_KBD            EQU 1 INCL_KBD            EQU 1
Line 47: Line 58:
  
 Returns WORD Returns WORD
-</PRE>+</code>
  
-[[Category:Kbd]]+{{page>en:templates:fapi}}