UniResetShiftState: Difference between revisions

Latest revision as of 18:56, 26 July 2017

Reset the effective and actual shift state and LED status.

Syntax

UniResetShiftState(keyboardHndl, shiftState, type)

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.
type - ULONG - input: The type of reset of:

Constants

None

Returns

An integer with values of:

ULS_BADHANDLE
ULS_SUCCESS

Module

Define (C/C++)

Export name/Ordinal

Calling Convention

Cdecl32

Example Code

KHAND       keyboardHndl;
USHIFTSTATE shiftState;
ULONG       type;
integer     rc;
...
rc = UniResetShiftState(keyboardHndl, shiftState, type);
...

Related Functions

UniUpdateShiftState

Notes

UniResetShiftState is used to change the shift state not through the normal keying sequence. The LED status is maintained based on the shift state.

OS Version Introduced

OS/2 Warp

@@ Line 1: / Line 1: @@
-== UniResetShiftState ==
+Reset the effective and actual shift state and LED status.
-; UniResetShiftState(keyboardHndl, shiftState, type) : Reset the effective and actual shift state and LED status.
+=== Syntax ===
+ UniResetShiftState(keyboardHndl, shiftState, type)
 === 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.
-; type - [[OS2 API:DataType:ULONG|ULONG]] - input : The type of reset of:
+; type - [[ULONG]] - input : The type of reset of:
-* [[OS2 API:Constant:KEYEV#KEYEV_RELEASE|KEYEV_RELEASE]]
+*[[KEYEV#KEYEV_RELEASE|KEYEV_RELEASE]]
-* [[OS2 API:Constant:KEYEV#KEYEV_SET|KEYEV_SET]]
+*[[KEYEV#KEYEV_SET|KEYEV_SET]]
-* [[OS2 API:Constant:KEYEV#KEYEV_ZERO|KEYEV_ZERO]]
+*[[KEYEV#KEYEV_ZERO|KEYEV_ZERO]]
 === Constants ===
@@ Line 15: / Line 17: @@
 === Returns ===
 An integer with values of:
-* [[OS2 API:Unicode:error#ULS_BADHANDLE|ULS_BADHANDLE]]
+* [[Unicode Errors|ULS_BADHANDLE]]
-* [[OS2 API:Unicode:error#ULS_SUCCESS|ULS_SUCCESS]]
+* ULS_SUCCESS
 === Module ===
@@ Line 24: / Line 26: @@
 === Export name/Ordinal ===
-=== Calling conversion ===
+=== Calling Convention ===
 [[Cdecl32]]
 === Example Code ===
-  [[OS2 API:DataType:KHAND|KHAND]]       keyboardHndl;
+  KHAND       keyboardHndl;
-  [[OS2 API:DataType:USHIFTSTATE|USHIFTSTATE]] shiftState;
+  USHIFTSTATE shiftState;
-  [[OS2 API:DataType:ULONG|ULONG]]       type;
+  ULONG       type;
   integer     rc;
   ...
@@ Line 37: / Line 39: @@
 === Related Functions ===
-[[OS2 API:UniUpdateShiftState|UniUpdateShiftState]]
+*[[UniUpdateShiftState]]
 === Notes ===
-[[OS2_API:UniResetShiftState|UniResetShiftState]] is used to change the shift state not through the normal keying sequence. The LED status is maintained based on the shift state.
+'''UniResetShiftState''' is used to change the shift state not through the normal keying sequence. The LED status is maintained based on the shift state.
 === OS Version Introduced ===
 OS/2 Warp
-[[Category:The OS/2 API Project]]
+[[Category:Uni]]