Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- di_Library v. 0.1 - <b>di_box()</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
di_BOX()
Replacement for @..BOX command to output to multiple device types
------------------------------------------------------------------------------
Syntax

    di_BOX(<nTop>, <nLeft>, <nBottom>, <nRight>, <cBoxString>,
             [<cColor>]) --> nSuccessList

Arguments

    <nTop>, <nLeft>, <nBottom>, and <nRight> define the coordinates
    of the box.  di_BOX() draws a box using row values from zero to
    MAXROW(), and column values from zero to MAXCOL() for output to the
    screen.  For HTML output, values must simply be zero or greater.
    Output fails for those devices for which values are out of range
    (devices with sucssessful output are listed in the return value).

    <cnBoxString> is a numeric or character expression that defines the
    border characters of the box.  If specified as a numeric expression, a
    value of 1 displays a single-line box and a value of 2 displays a
    double-line box.  All other numeric values display a single-line box.

    If <cnBoxString> is a character expression, it specifies the characters
    to be used in drawing the box.  This is a string of eight border
    characters and a fill character.  If <cnBoxString> is specified as a
    single character, that character is used to draw the whole box.

    <cColorString> defines the display color of the box that is drawn.
    If not specified, the box is drawn using the standard color setting of
    the current system color as defined by SETCOLOR().

Returns

    nSuccessList is the sum of the devices handles successfully
    written to.  Only devices currently set to output are addressed;
    therefore, nSuccessList is always less than or equal to the current
    return value from di_setOutput().

Description

    Attemps to draws a representation of a box to all devices whose
    output is currently enabled.  The representation of a box on the
    screen device is identical to that created with @..BOX.  The
    representation of a box on HTML devices is <HR>'s placed at the top
    and bottom row positions.  Other devices, if supported, will use a
    device-specific representation of a box.  Returns a value indicating
    the list of devices which successfully receive output.

Examples

    See the examples listed under the Examples menu heading

See Also: di_SAY() di_GET() di_READ() di_setOutput()

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