Topic       : TOS - The Operating System
Author      : 
Version     : tos.hyp (December 19, 2008)
Subject     : Programmieren/Atari
Nodes       : 3010
Index Size  : 93790
HCP-Version : 5
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Title
@help       : 
@options    : +g -i -s +x +zz -t4
@width      : 70
View Ref-File7.7.11  vq_key_s                                                   TOS

 Name:         »Sample keyboard state information« - Obtain the status 
               of the Shift etc. keys.

 Opcode:       128

 Syntax:       void vq_key_s ( int16_t handle, int16_t *pstatus );

 Description:  The call vq_key_s checks the status of the 'special' 
               keys (L & R Shift, Control, Alternate) of the keyboard. 
               The following apply:

                Parameter  Meaning

                handle     Workstation identifier
                pstatus    Keyboard state:
                            Right Shift    = 0x0001
                            Left Shift     = 0x0002
                            Control key    = 0x0004
                            Alternate key  = 0x0008

               In GEM programs one should use the AES event functions 
               to ensure that only the keyboard status information 
               intended for one's own application is obtained.

               Note: The input functions of the VDI work only on the 
               physical workstation, which is normally used by the 
               AES. Therefore it is better to fall back to using 
               graf_mkstate or the event functions instead.

 Return value: The function does not return a result.

 Availability: Supported by all Atari computers.

 Group:        Input functions

 See Also:     Binding   evnt_button