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.11.13  form_xerr                                                 TOS

 Name:         »Form Xerror« - Display an error box for TOS errors 
               (MagiC).

 Opcode:       136

 Syntax:       int16_t form_xerr ( int32_t errcode, int8_t *errfile );

 Description:  The call form_xerror outputs an error number as a plain 
               text description (i.e. in an alert box form that 
               contains a stop sign icon at the left side of the box, 
               a text string holding an explanatory error message or 
               just 'TOS error #X' and a 'Cancel' button). In contrast 
               to form_error, there is no need for translation from 
               the TOS to the MS-DOS format.

                Parameter  Meaning

                errcode    Normal, negative GEMDOS or BIOS error-code; 
                           if this is EBREAK (program termination with 
                           [Control]-[C]) or E_OK (no error) then no 
                           alert box will be displayed
                errfile    Path of the file in which the error arose. 
                           With a NULL-pointer this parameter will be 
                           ignored; -1 means that the message will be 
                           prefaced with 'The program returned:'

 Return value: This will be the index (1-3) of the selected exit 
               button. However, with current GEM versions only one 
               button is available in error alerts.

 Availability: The function is available only under MagiC (as of 
               Version 2.0).

 Group:        Form library

 See Also:     Binding   form_error