Return Parameters

This function returns a data string and a return code.
Data String:
See the following table:
Byte Definition
Standard Enhanced  
1 1 One of the following values:
  • A 1-character presentation space short name (PSID)
  • A blank or null indicating a function call for the host-connected presentation
2–4 Reserved
2 5 An option code character, one of the following characters:
  • A for ASCII returned
  • M for keystroke mnemonic
  • S for special mnemonic
3–8 6–11 These 6 bytes of the preallocated buffer space are used internally to enqueue and dequeue keystrokes. Possible combinations include:
  • Byte 3 contains an ASCII character and byte 4 contains X'00'
  • Byte 3 contains the escape character (either @ or another character specified using the ESC=c option of function 9) and byte 4 contains a 1-byte abbreviation for a function. (See ASCII Mnemonics)
  • Bytes 5 through 8 might be similar to bytes 3 and 4 if the returned ASCII mnemonic is longer than 2 bytes (for example, if the ASCII mnemonic represents Attn @A@Q, byte 5 contains @ and byte 6 contains Q). If not used, bytes 5 through 8 are set to zero (X'00').
For clarification, some examples of returned data strings are provided below:
Note: The @ symbol is the default escape character. The value of the escape character can be set to any keystroke represented in ASCII by using the ESC=c option of the Set Session Parameters (9) function. If the escape character has been changed to another character using this option, the @ symbol in the following examples is replaced by the other character.