KbdSetStatus: Difference between revisions

Latest revision as of 04:29, 2 January 2020

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.

@@ Line 1: / Line 1: @@
-==Description==
 Sets the characteristics of the keyboard.
 ==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==
-;  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==
- rc (APIRET) - returns
+;rc (APIRET) - returns:KbdSetStatus returns one of the following values:
+::0 NO_ERROR
-KbdSetStatus returns one of the following values:
+::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
-* 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.
+In the KBDINFO structure, the upper byte of ''fsInterim'' is the NLS shift state, and can be modified by KbdSetStatus.
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-[[Category:The OS/2 API Project]]
+[[Category:Kbd]]