OS2 API:UniUntranslateKey

From EDM2

Contents 1 UniUntranslateKey 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] 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.

[edit] Parameters

keyHndl - KHAND - input 

The keyboard handle as created by UniCreateKeyboard.

uc - UniChar - input 

Unicode character to be untranslated.

vdkey - VDKEY - input 

Virtual/dead key.

pmscan - VSCAN - output 

The Presentation Manager scan code.

efshift - ULONG - output 

Effective shift state to generate this character.

[edit] Constants

None

[edit] Returns

An integer with values of:

• ULS_BADHANDLE
• ULS_NOSCAN
• ULS_SUCCESS

[edit] Module

[edit] Define (C/C++)

[edit] Export name/Ordinal

[edit] Calling conversion

Cdecl32

[edit] Example Code

KHAND   keyHndl;
UniChar uc;
VDKEY   vdkey;
VSCAN   pmscan;
ULONG   efshift;
integer rc;
...
rc = UniUntranslateKey(keyHndl, uc, vdkey, pmscan, efshift);
...

[edit] Related Functions

UniTranslateDeadKey UniTranslateKey

[edit] Notes

UniUntranslateKey reverses the translation performed by 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, UniUntranslateKey processes the virtual/dead key before the Unicode character.

[edit] OS Version Introduced

OS/2 Warp