Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- ClipOn 3.0 Reference - c_err() http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 C_ERR()

 DESCRIPTION

 C_ERR() is used to display an error message to the user.  The
 message can remain on the screen a specified number of seconds,
 until the user presses a key, or permanently.  Up to five lines of
 text can be displayed.  The message text and optional box are
 automatically centered.

 SYNTAX

 C_ERR(row [,time] [,box] [,shadow] [,color] [,savescrn] [,str1]
 [,str2] [,str3] [,str4] [,str5] [,stuff_key])

 PARAMETERS

 row (N) is the screen row to display the error message.

 time (N) is the amount of time, in seconds, to display the message.
 If zero (0) is specified, the message will stay on the screen until
 a key is pressed.  If time is not specified, the default of 0 (wait
 for keystroke) is used.

 box (N) is the type of box (0-5) to display.  The box types are as
 follows:  0=no box, 1=single box, 2=double box, 3=double top/single
 sides, 4=single top/double sides, and 5=Solid graphics.  If box is
 not specified, box type 2 (double) is used.

 shadow (N) is the type of shadow to display around the box.  The
 shadow types are as follows:
 0 = no shadow, 1 = left side/bottom shadow, 2 = right side/bottom
 shadow.  If shadow is not specified, no shadow is displayed.

 color (C) is the color to display.  If color is not specified, the
 current Clipper color is used.

 savescrn (L) indicates whether or not the screen should be saved
 when C_ERR() is called and restored when exited.  Specify true
 (.T.) to save and restore the screen, or false (.F.) to overwrite
 the previous screen and leave the error message on the screen when
 C_ERR() exits.  If savescrn is not specified, the default of true
 (.T.) is used.

 str1 (C), str2 (C), str3 (C), str4 (C), and str5 (C) are the
 character strings to display.

 stuff_key (L) indicates whether or not the key to exit C_ERR()
 should be removed from the keyboard buffer.  If stuff_key is true
 (.T.), the key is not removed from the keyboard buffer and is still
 available when C_ERR() returns.  If stuff_key is false (.F.), the
 key is removed from the buffer, which is the default if stuff_key
 is not specified.

 RETURNS

 C_ERR() returns the key that was pressed to exit C_ERR(), or zero
 (0) if no key was pressed.

 EXAMPLES

 && Wait 2 seconds
 c_err(10,2,1,2,"W/B",.T.,"Error, Record Not Found, Please Reenter")

 && Wait until a key is pressed
 c_err(10,"","","","","","Error Message With All Defaults Parameters")


See Also: C_MSG() C_TEXT() C_PROMPT()

Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson