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-File8.18.3  shel_get                                                   TOS

 Name:         »Shell get« - Read from the GEM environment buffer.

 Opcode:       122

 Syntax:       int16_t shel_get ( int8_t *sh_gaddr, uint16_t sh_glen 
               );

 Description:  The call shel_get serves for reading characters from 
               the internal environment storage buffer of the AES. The 
               following apply:

                Parameter  Meaning

                sh_gaddr   Address of the destination memory store
                sh_glen    Number of bytes to be read, or the value -1 
                           to obtain the length of the memory store

               Note: The desktop uses this buffer to store the 
               DESKTOP.INF or NEWDESK.INF file. Although the format of 
               these files is not officially documented, a current 
               description can be found in newdesk.hyp.

               Under MagiC, at the start of the AES all data are 
               copied into the buffer that lies after the line '#_CTR' 
               in MAGX.INF. Since MagiC 3, the permissible length of 
               the buffer lies between 4192 and 65534 bytes. The 
               presence of the additional features can be ascertained 
               with a call of appl_getinfo (opcode 6).

 Return value: An error has arisen only if the value 0 is returned.

 Availability: All AES versions.

 Group:        Shell library

 See Also:     Binding   shel_put