OS2 API:UniTranslateDeadKey

From EDM2

Contents 1 UniTranslateDeadKey 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] UniTranslateDeadKey

UniTranslateDeadKey(kbHndl, vdKey, ucInChar, ucOutChar, newVDKey) 

Translates a Unicode character and virtual/dead key into a composite character.

[edit] Parameters

kbHndl - KHAND - input 

The keyboard handle created from UniCreateKeyboard.

vdKey - VDKEY - output 

The virtual/dead key.

ucInChar - UniChar - input 

The second character in the sequence.

ucOutChar - UniChar - output 

The composite character.

newVDKey - VDKEY - output 

The dead key value. For a non-zero value, the dead key is chained. OS/2 does not support chained dead keys.

[edit] Constants

None

[edit] Returns

An integer with values of:

• ULS_BADHANDLE
• ULS_NODEAD
• ULS_SUCCESS

[edit] Module

[edit] Define (C/C++)

[edit] Export name/Ordinal

[edit] Calling conversion

Cdecl32

[edit] Example Code

KHAND   kbHndl;
VDKEY   vdKey;
UniChar ucInChar;
UniChar ucOutChar;
VDKEY   newVDKey;
integer rc;
...
rc = UniTranslateDeadKey(kbHndl, vdKey, ucInChar, ucOutChar, newVDKey);
...

[edit] Related Functions

UniTranslateKey UniUntranslateKey

[edit] Notes

The calling program is expected to maintain the dead key state so that when the next dead key is found to form the full character. After the dead key translate, the dead key state needs to be reset.

There is a provision in the table for chained dead keys, which is used in Japanese logic. It shouldn't be used as OS/2 doesn't support chained dead keys.

[edit] OS Version Introduced

OS/2 Warp