GetKey

Obtains the next available keystroke from the specified screen.

Library:LibC
Classification:NetWare OS
Service:Screen Support

Syntax

  #include <screen.h> 
   
  void GetKey (
     scr_t      scrID,
     uint8_t   *type,
     uint8_t   *value,
     uint8_t   *status,
     uint8_t   *scancode,
     size_t     linesToProtect);
  

Parameters

scrID

(IN) Specifies the screen from which to retrieve a keystroke.

type

(OUT) Points to the key type. See Section 23.2, Key Types.

value

(OUT) Points to the ASCII value of the key that was pressed.

status

(OUT) Indicates whether a modifier key was pressed, for example the Shift Key. For a list of possible values, see Section 23.3, Key Status

scancode

(OUT) Points to the codes emitted by the keyboard when a key is pressed.

linesToProtect

(IN) Specifies the number of lines that have to be protected from the current input row upwards. Thus, if linesToProtect is 2 and the current input row number is 4, rows 3 and 4 have to protected.

Remarks

For sample code, see Scroll.c.

See Also

UngetKey