Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-Fileshel_put()
Shell Library
shel_get()                                                              AES

Syntax

WORD shel_get( buf, length )
char *buf;
WORD length;

Function       shel_get() copies the contents of the AES's shell buffer
               (normally the 'DESKTOP.INF' or 'NEWDESK.INF' file) into the
               specified buffer.

Opcode         122 (0x7A)

Availability   All AES versions.

Parameters     buf points to a buffer at least length bytes long into
               which the AES should copy the shell buffer into.

Binding        intin[0] = length;

               addrin[0] = buf;

               return crys_if(0x7A);

Return Value   shel_get() returns 0 if an error occurred or non-zero
               otherwise.

Version Notes  AES versions prior to version 1.4 had a shell buffer size
               of 1024 bytes. Versions 1.4 to 3.0 had a shell buffer size
               of 4192 bytes.
               In AES versions 4.0 or greater the shell buffer is no
               longer of a fixed size. When appl_getinfo() indicates that
               this feature is supported, length can be specified as
               SHEL_BUFSIZE (-1) to return the size of the current shell
               buffer.

See Also       shel_put()

Group          Shell Library