User`s guide

xliv Contents
Get Key—Function 51
This function allows your Windows HLLAPI application to intercept keystrokes from Host sessions
that have keystroke intercept enabled, and to process those keystrokes.
Prerequisite Functions
Start Keystroke Intercept (function 50).
WinHLLAPI(GETKEY,lpbyString,lpwLength,lpwReturnnCode)
Parameter Description
Data String An 8-byte string in the following format:
Byte 1 Short name session ID of the desired Host
session, or space or null for the current Host
session.
Bytes 2-8 Reserved for return data.
Data Length NA (length of 8 is implied).
PS Position NA.
Parameter Description
Data String An 8-byte string in the following format:
Byte 1 Short name session ID of the desired Host
session, or space or null for the current Host
session.
Byte 2 Keystroke code. “A” indicates an ASCII
character; “M” indicates a 3270 function
key code; “S” indicates a special key
modifier (SHIFT, CTRL, or ALT) state.
Bytes 3-8 Keystroke(s). Unused bytes are set to null
(00h). See “Remarks” section for details.
Data Length Number of characters in the returned mnemonic.
Code Description
WHLLOK Keystroke(s) successfully returned.
WHLLNOTCONNECTED The Host session presentation space is invalid.
WHLLINHIBITED
Start Keystroke Intercept (function 50) was called with the
“D” option (intercept AID keys only). Non-AID keys are
not returned.
WHLLNOTAVAILABLE Start Keystroke Intercept (function 50) was not called
prior to this function call.
WHLLSYSERROR The function failed due to a system error.
Function Call
Call Parameters
Return Parameters
Return Codes