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.5  shel_put                                                   TOS

 Name:         »Shell put« - Writes to the GEM environment buffer.

 Opcode:       123

 Syntax:       int16_t shel_put ( int8_t *sh_paddr, uint16_t sh_plen 
               );

 Description:  The call shel_put copies information to the environment 
               shell buffer of the AES. The following apply:

                Parameter  Meaning

                sh_paddr   Address of source buffer (in user memory)
                sh_plen    Number of characters to be written

               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.

               The permissible length of the buffer lies since MagiC 3 
               between 4192 and 65534 bytes, while in very old TOS 
               versions it was restricted to 1024 bytes.

               Prior to AES version 4.0 this function would only copy 
               as many bytes as would fit into the current buffer. As 
               of version 4.0, the AES will dynamically allocate more 
               memory as needed (up to 32767 bytes) for the shell 
               buffer.

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

 Availability: All AES versions.

 Group:        Shell library

 See Also:     Binding   shel_get   shel_envrn   shel_find