en:docs:fapi:kbdclose

Differences

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

Link to this comparison view

Next revision		Previous revision
en:docs:fapi:kbdclose [2021/10/06 11:58] – created prokusheven:docs:fapi:kbdclose [2021/11/04 13:26] (current) – prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== KbdClose ======
 +
 This call closes the existing logical keyboard identified by the keyboard handle. This call closes the existing logical keyboard identified by the keyboard handle.
  
-==Syntax==+===== Syntax ===== 
 +<code c>
  KbdClose (KbdHandle)  KbdClose (KbdHandle)
 +</code>
  
-==Parameters== +===== Parameters =====
-;KbdHandle ([[HKBD]]) - input: Default keyboard or the logical keyboard.+
  
-==Return Code== +  * KbdHandle ([[HKBD]]) - input: Default keyboard or the logical keyboard. 
-;rc (USHORT) - return:Return code descriptions are: + 
-*0 - NO_ERROR +===== Return Code ===== 
-*439 - ERROR_KBD_INVALID_HANDLE + 
-*464 - ERROR_KBD_DETACHED +rc (USHORT) - return:Return code descriptions are: 
-*504 - ERROR_KBD_EXTENDED_SG+ 
 +  *0 - NO_ERROR 
 +  *439 - ERROR_KBD_INVALID_HANDLE 
 +  *464 - ERROR_KBD_DETACHED 
 +  *504 - ERROR_KBD_EXTENDED_SG 
 + 
 +===== Remarks =====
  
-==Remarks== 
 KbdClose blocks while another thread has the keyboard focus (by way of [[KbdGetFocus]]) until the thread with the focus issues [[KbdFreeFocus]]. Therefore, to prevent KbdClose from blocking, it is recommended that KbdClose be issued only while the current thread has the focus. For example: KbdClose blocks while another thread has the keyboard focus (by way of [[KbdGetFocus]]) until the thread with the focus issues [[KbdFreeFocus]]. Therefore, to prevent KbdClose from blocking, it is recommended that KbdClose be issued only while the current thread has the focus. For example:
  
-;KbdGetFocus:Wait until focus available on handle 0. +  KbdGetFocus:Wait until focus available on handle 0. 
-;KbdClose:Close a logical keyboard handle. +  KbdClose:Close a logical keyboard handle. 
-;KbdClose:Close another logical keyboard handle. +  KbdClose:Close another logical keyboard handle. 
-;KbdClose:Close still another logical keyboard handle. +  KbdClose:Close still another logical keyboard handle. 
-;KbdFreeFocus:Give up the focus on handle 0.+  KbdFreeFocus:Give up the focus on handle 0.
  
-==Bindings== +===== Bindings ===== 
-===C=== + 
-<PRE>+====C==== 
 +<code cRE>
 #define INCL_KBD #define INCL_KBD
  
Line 31: Line 42:
 PHKBD   KbdHandle;     /* Keyboard handle */ PHKBD   KbdHandle;     /* Keyboard handle */
 USHORT  rc;            /* return code */ USHORT  rc;            /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 EXTRN  KbdOpen:FAR EXTRN  KbdOpen:FAR
 INCL_KBD            EQU 1 INCL_KBD            EQU 1
Line 42: Line 53:
  
 Returns WORD Returns WORD
-</PRE>+</code> 
 + 
 +{{page>en:templates:fapi}}
  
-[[Category:Kbd]]