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.16  x_form_error                                              TOS

 Name:         »XForm error« - Display an error box for TOS errors 
               (Geneva).

 Opcode:       28945

 Syntax:       int16_t x_form_error ( uint8_t *fmt, int16_t errnum );

 Description:  The function x_form_error takes the error-code 
               specified by errnum and finds an appropriate error- 
               message string. It then inserts this text into a 
               program-defined alert string and displays an alert.

               The fmt should be in standard form_alert format, with a 
               '%s' to indicate the location where the error-message 
               should be inserted. Since an alert can contain no more 
               than five lines of 30 characters each, and the pre- 
               defined error-messages can take up to three lines, 
               there should be no more than two lines of text 
               surrounding the inserted error text.

               Example:

               if( x_form_error( "[1][Error!|%s][Continue|Quit]", -33 ) == 1 )
                 continue...
               else quit...

 Return value: This will be the index (1-3) of the selected exit 
               button.

 Availability: The function is only available under Geneva.

 Group:        Form library

 See Also:     Binding   form_error   form_xerr   form_err in N.AES