OS2 API:UniUpdateShiftState

From EDM2

Contents 1 UniUpdateShiftState 1.1 Parameters 1.2 Constants 1.3 Returns 1.4 Module 1.5 Define (C/C++) 1.6 Export name/Ordinal 1.7 Calling conversion 1.8 Example Code 1.9 Related Functions 1.10 Notes 1.11 OS Version Introduced

[edit] UniUpdateShiftState

UniUpdateShiftState(keyboardHndl, shiftState, vScan, makeBreak) 

Update the effective and actual shift state and LED status.

[edit] 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.

[edit] Constants

None

[edit] Returns

An integer with values of:

• ULS_BADHANDLE
• ULS_SUCCESS

[edit] Module

[edit] Define (C/C++)

[edit] Export name/Ordinal

[edit] Calling conversion

Cdecl32

[edit] Example Code

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

[edit] Related Functions

UniResetShiftState

[edit] 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.

[edit] OS Version Introduced

OS/2 Warp