acedGrText

C++

int acedGrText(
    int box, 
    const ACHAR * text, 
    int hl
);

File

acedads.h

Description

Displays the specified text in the menu, mode, or status area of the graphics screen.

If box equals the number of a screen menu box and hl is less than 0, acedGrText() displays text in that box. The menu boxes are numbered beginning at 0. If the value of box is greater than the number of menu boxes minus one, the call to acedGrText() usually has no effect.

If box specifies a screen menu box and hl is greater than 0, the text displayed by acedGrText() is highlighted. If hl equals 0 and the box is highlighted, acedGrText() turns highlighting off. (Remember that AutoCAD allows only one menu box to be highlighted at a time. A call that highlights a different box automatically turns off any previous highlighting.) When hl is greater than or equal to 0, the text argument is ignored.

If box equals -1, acedGrText() writes the text into the mode status line (the hl argument is ignored). The length of the mode status line differs from display to display; most allow at least 40 characters. If text contains more characters than the mode status line allows, it is truncated; if it contains fewer characters, it is padded with blanks.

If box equals -2, acedGrText() writes the text into the coordinate status line (the hl argument is ignored). If coordinate tracking is turned on, any value written into this field is overwritten as soon as the pointer sends another set of coordinates.

Finally, if box is less than -2 (for example: box equals -5), acedGrText() restores all the text areas on the screen to their standard values.

If it succeeds, acedGrText() returns RTNORM. It returns RTERROR if the box number is out of range.

Parameters