UniUpdateShiftState: Difference between revisions

Latest revision as of 16:07, 12 March 2018

Update the effective and actual shift state and LED status.

Syntax

UniUpdateShiftState(keyboardHndl, shiftState, vScan, makeBreak);

Parameters

keyboardHndl - KHAND - input: The key board handle received from UniCreateKeyboard.
shiftState - USHIFTSTATE - input: The shift state consists of 3 32-bit values. These bit definitions define the actual, effective, and LED shift states.
vScan - VSCAN - input: Presentation Manager scan code.
makeBreak - BYTE - input: Key make, break, repeat indicator.

Constants

None

Returns

An integer with values of:

Calling Convention

Cdecl32

Bindings

KHAND       keyboardHndl;
USHIFTSTATE shiftState;
VSCAN       vScan;
BYTE        makeBreak;
integer     rc;
...
rc = UniUpdateShiftState(keyboardHndl, shiftState, vScan, makeBreak);
...

Related Functions

UniResetShiftState

Notes

UniUpdateShiftState modifies the shift state as dictated by the scan code, using the specified keyboard translation tables. The shift state consists of these three parts:

The actual shift state
The effective shift state
The LED status

The effective shift is equal to the 16 lower bits of the actual shift, but when a lock state modifies an actual shift (such as caps lock affecting shift), the effective shift is modified. This means that the effective shift is only correct for the specified scan code.

OS Version Introduced

OS/2 Warp

@@ Line 5: / Line 5: @@
 === Parameters ===
-; keyboardHndl - [[OS2 API:DataType:KHAND|KHAND]] - input : The key board handle received from [[OS2_API:UniCreateKeyboard|UniCreateKeyboard]].
+; keyboardHndl - [[KHAND]] - input : The key board handle received from [[UniCreateKeyboard]].
-; shiftState - [[OS2 API:DataType:USHIFTSTATE|USHIFTSTATE]] - input : The shift state consists of 3 32-bit values.  These bit definitions define the actual, effective, and LED shift states.
+; shiftState - [[USHIFTSTATE]] - input : The shift state consists of 3 32-bit values.  These bit definitions define the actual, effective, and LED shift states.
-; vScan - [[OS2 API:DataType:VSCAN|VSCAN]] - input : [[OS2 API:PMI|Presentation Manager]] scan code.
+; vScan - [[VSCAN]] - input : Presentation Manager scan code.
 ; makeBreak - [[BYTE]] - input : Key make, break, repeat indicator.
@@ Line 21: / Line 21: @@
 [[Cdecl32]]
-=== Example Code ===
+=== Bindings ===
-  [[OS2 API:DataType:KHAND|KHAND]]       keyboardHndl;
+  KHAND       keyboardHndl;
-  [[OS2 API:DataType:USHIFTSTATE|USHIFTSTATE]] shiftState;
+  USHIFTSTATE shiftState;
-  [[OS2 API:DataType:VSCAN|VSCAN]]       vScan;
+  VSCAN       vScan;
-  [[BYTE]]        makeBreak;
+  BYTE        makeBreak;
   integer     rc;
   ...
@@ Line 32: / Line 32: @@
 === Related Functions ===
-*[[OS2 API:UniResetShiftState|UniResetShiftState]]
+*[[UniResetShiftState]]
 === Notes ===
-[[UniUpdateShiftState]] modifies the shift state as dictated by the scan code, using the specified keyboard translation tables. The shift state consists of these three parts:
+'''UniUpdateShiftState''' modifies the shift state as dictated by the scan code, using the specified keyboard translation tables. The shift state consists of these three parts:
 * The actual shift state
 * The effective shift state
 * The LED status
 The effective shift is equal to the 16 lower bits of the actual shift, but when a lock state modifies an actual shift (such as caps lock affecting shift), the effective shift is modified. This means that the effective shift is only correct for the specified scan code.