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►
────────────────────────────────────────────────────────────────────────────
 
 <warning [text='text']>
 
The warning tag starts a warning message. A warning message is the word
"Warning:" (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 /warning tag. When the warning message is displayed, it is
preceded immediately by a blank line and the last line of text in the
message is followed by a blank line. Warning messages are typically used to
alert the user to a potential risk.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
text       Specifies the text used to start the warning. The text value can
           be any string of characters but must be enclosed in single
           quotation marks ('). If this parameter is not given, the default
           text is "Warning:".
 
Example
 
This example uses the warning tag to create a warning about shutting down
the system:
 
    <warning>
    Shutting down the system without ending your program may result
    in data loss.
    </warning>
 
When displayed in the help panel, the warning looks like this:
 
    Warning: Shutting down the system without ending your
    program may result in data loss.
 
See Also
 
 /warning
 
                                      ♦