home *** CD-ROM | disk | FTP | other *** search
/ HomeWare 14 / HOMEWARE14.bin / prog / ks94an.arj / ACK.HDR < prev    next >
Text File  |  1994-04-24  |  2KB  |  62 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _Ack( cAckMsg, cAckColor, nBoxType ) --> cAckMsg
  8.  
  9. PARAMETERS:
  10.  
  11. cStatement : Acknowledge statement
  12.  
  13.  
  14. SHORT:
  15.  
  16. Present a boxed message and wait for user acknowledgement.
  17.  
  18. DESCRIPTION:
  19.  
  20. _Ack() presents a message on the screen and prompts for an
  21. acknowledgement from the user via either ENTER or ESC.
  22.  
  23. Unlike _Msg(), _Ack() pauses program execution until the proper key
  24. is pressed.  That key can be tested with "lastkey()"
  25.  
  26. Note that when nBoxType = BOXNONE (no border) the Box Message ("Message
  27. - Press Enter") does not appear either.  In all cases, the _KeyList()
  28. line always contains instructions in the color of the _Ack() box.
  29.  
  30. _Ack() returns whatever string was passed to it.  This lets you "stack" one
  31. or more commands at once without having to specify the string again.
  32.  
  33. Example: Instead of two strings:
  34.  
  35. _Ack('Big Time Error: Something Died')
  36. _Terminate('Big Time Error: Something Died')
  37.  
  38. Try: One String Declaration, used twice:
  39.  
  40. _Terminate(_Ack('Big Time Error: Something Died'))
  41.  
  42. In this case, _Ack() returns to _Terminate() what it was given.  _Terminate()
  43. then receives the same message, but the string is only defined once.
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50. NOTE:
  51.  
  52. See _Box() for a list of valid box border types.
  53.  
  54. EXAMPLE:
  55.  
  56. _Ack('Something Horrible Happened!!')
  57.  
  58. Result: The message is presented in a red box, and program execution
  59. stops until either ESC or ENTER is pressed.
  60.  
  61. ******************************************************************************/
  62.