UniUntranslateKey: Difference between revisions
No edit summary |
|||
| Line 1: | Line 1: | ||
Translates a Unicode character and virtual/dead key to a scan code to create the effective shift state. | |||
=== Syntax === | |||
UniUntranslateKey(keyHndl, uc, vdkey, pmscan, efshift) ; | |||
=== Parameters === | === Parameters === | ||
| Line 14: | Line 16: | ||
=== Returns === | === Returns === | ||
An integer with values of: | An integer with values of: | ||
* [[ | * [[Unicode Errors#ULS_BADHANDLE|ULS_BADHANDLE]] | ||
* [[ | * [[Unicode Errors#ULS_NOSCAN|ULS_NOSCAN]] | ||
* [[ | * [[Unicode Errors#ULS_SUCCESS|ULS_SUCCESS]] | ||
=== Calling Convention === | === Calling Convention === | ||
Revision as of 19:03, 26 July 2017
Translates a Unicode character and virtual/dead key to a scan code to create the effective shift state.
Syntax
UniUntranslateKey(keyHndl, uc, vdkey, pmscan, efshift) ;
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
Constants
None
Returns
An integer with values of:
Calling Convention
Example Code
KHAND keyHndl; UniChar uc; VDKEY vdkey; VSCAN pmscan; ULONG efshift; integer rc; ... rc = UniUntranslateKey(keyHndl, uc, vdkey, pmscan, efshift); ...
Related Functions
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.
OS Version Introduced
- OS/2 Warp