Jump to content

KbdSetStatus: Difference between revisions

From EDM2
No edit summary
Ak120 (talk | contribs)
m at least a link to relevant struct
Line 1: Line 1:
{{Legacy
|RepFunc=
|Remarks=This page list the older version of the function for reference.
}}
Sets the characteristics of the keyboard.
Sets the characteristics of the keyboard.


==Syntax==
==Syntax==
<PRE>
  KbdSetStatus(pkbdinfo, hkbd)
#define INCL_KBD
#include <os2.h>
 
PKBDINFO    pkbdinfo;  /*  Pointer to keyboard status. */
HKBD        hkbd;      /*  Reserved.  Must be 0. */
APIRET      rc;        /* Return code. */
 
rc = KbdSetStatus(pkbdinfo, hkbd);
</PRE>


==Parameters==
==Parameters==
;pkbdinfo (PKBDINFO) - output : Pointer to keyboard status.
;pkbdinfo (P[[KBDINFO]]) - output : Pointer to keyboard status.
A pointer to a KBDINFO structure in which the keyboard status is returned.
A pointer to a KBDINFO structure in which the keyboard status is returned.
; hkbd (HKBD) - input : Reserved. Must be 0.
;hkbd (HKBD) - input : Reserved. Must be 0.


==Return Code==
==Return Code==
rc (APIRET) - returns
;rc (APIRET) - returns:KbdSetStatus returns one of the following values:
KbdSetStatus returns one of the following values:
* 0 NO_ERROR
* 0 NO_ERROR
* 376 ERROR_KDB_INVALID_LENGTH  
* 376 ERROR_KDB_INVALID_LENGTH
* 377 ERROR_KBD_INVALID_ECHO_MASK  
* 377 ERROR_KBD_INVALID_ECHO_MASK
* 378 ERROR_KBD_INVALID_INPUT_MASK  
* 378 ERROR_KBD_INVALID_INPUT_MASK
* 439 ERROR_KBD_INVALID_HANDLE  
* 439 ERROR_KBD_INVALID_HANDLE
* 445 ERROR_KBD_FOCUS_REQUIRED  
* 445 ERROR_KBD_FOCUS_REQUIRED
* 447 ERROR_KBD_KEYBOARD_BUSY  
* 447 ERROR_KBD_KEYBOARD_BUSY
* 504 ERROR_KBD_EXTENDED_SG
* 504 ERROR_KBD_EXTENDED_SG



Revision as of 16:37, 3 January 2019

Sets the characteristics of the keyboard.

Syntax

KbdSetStatus(pkbdinfo, hkbd)

Parameters

pkbdinfo (PKBDINFO) - output
Pointer to keyboard status.

A pointer to a KBDINFO structure in which the keyboard status is returned.

hkbd (HKBD) - input
Reserved. Must be 0.

Return Code

rc (APIRET) - returns
KbdSetStatus returns one of the following values:
  • 0 NO_ERROR
  • 376 ERROR_KDB_INVALID_LENGTH
  • 377 ERROR_KBD_INVALID_ECHO_MASK
  • 378 ERROR_KBD_INVALID_INPUT_MASK
  • 439 ERROR_KBD_INVALID_HANDLE
  • 445 ERROR_KBD_FOCUS_REQUIRED
  • 447 ERROR_KBD_KEYBOARD_BUSY
  • 504 ERROR_KBD_EXTENDED_SG

Remarks

In the KBDINFO structure, the upper byte of fsInterim is the NLS shift state, and can be modified by KbdSetStatus.