Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

                                                      ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
 :caution [text='text'].
 
The :caution tag starts a caution message. A caution message is the word
"CAUTION:" (or the text specified by the text option) followed by one or
more lines of text. In the help source file, the last line of text must be
followed by the :ecaution tag. When the caution message is displayed, the
message is preceded immediately by a blank line and the last line of text in
the message is followed by a blank line. Caution messages are typically used
to alert the user to a potential risk.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
text       Specifies the text used to start the caution message. The text
           value can be any string of characters but must be enclosed in
           single quotation marks ('). If text is not given, the default
           text is "CAUTION:".
 
Example
 
This example uses the :caution tag to create a caution about shutting down
the system:
 
    :caution.
    Shutting down the system without ending your program may result
    in data loss.
    :ecaution.
 
When displayed in the help panel, the caution looks like this:
 
    CAUTION:
    Shutting down the system without ending your
    program may result in data loss.
 
See Also
 
 :ecaution
 
                                      ♦