View source for UniUntranslateKey

== UniUntranslateKey ==
; UniUntranslateKey(keyHndl, uc, vdkey, pmscan, efshift) : Translates a Unicode character and virtual/dead key to a scan code to create the effective shift state.

=== Parameters ===
; keyHndl - [[OS2 API:DataType:KHAND|KHAND]] - input : The keyboard handle as created by [[OS2_API:UniCreateKeyboard|UniCreateKeyboard]].
; uc - [[OS2 API:DataType:UniChar|UniChar]] - input : Unicode character to be untranslated.
; vdkey - [[OS2 API:DataType:VDKEY|VDKEY]] - input : Virtual/dead key.
; pmscan - [[OS2 API:DataType:VSCAN|VSCAN]] - output : The [[OS2 API:PMI|Presentation Manager]] scan code.
; efshift - [[OS2 API:DataType:ULONG|ULONG]] - output : Effective shift state to generate this character.

=== Constants ===
None

=== Returns ===
An integer with values of:
* [[OS2 API:Unicode:error#ULS_BADHANDLE|ULS_BADHANDLE]]
* [[OS2 API:Unicode:error#ULS_NOSCAN|ULS_NOSCAN]]
* [[OS2 API:Unicode:error#ULS_SUCCESS|ULS_SUCCESS]]

=== Module ===

=== Define (C/C++) ===

=== Export name/Ordinal ===

=== Calling conversion ===
[[Cdecl32]]

=== Example Code ===
 [[OS2 API:DataType:KHAND|KHAND]]   keyHndl;
 [[OS2 API:DataType:UniChar|UniChar]] uc;
 [[OS2 API:DataType:VDKEY|VDKEY]]   vdkey;
 [[OS2 API:DataType:VSCAN|VSCAN]]   pmscan;
 [[OS2 API:DataType:ULONG|ULONG]]   efshift;
 integer rc;
 ...
 rc = UniUntranslateKey(keyHndl, uc, vdkey, pmscan, efshift);
 ...

=== Related Functions ===
[[OS2 API:UniTranslateDeadKey|UniTranslateDeadKey]]
[[OS2 API:UniTranslateKey|UniTranslateKey]]

=== Notes ===
[[OS2 API:UniUntranslateKey|UniUntranslateKey]] reverses the translation performed by [[OS2 API:UniTranslateKey|UniTranslateKey]].  This is used to create a complete keyboard packet when an already translated character is entered.  This is used when the input to the event is the translated character.

Typically, the Unicode character or virtual/dead key is given.  If both are given, [[OS2 API:UniUntranslateKey|UniUntranslateKey]] processes the virtual/dead key before the Unicode character.

=== OS Version Introduced ===
OS/2 Warp