C
WORD OutText( XCHAR * textString );
Overview
This function outputs a string of characters starting at the current graphic cursor position. The string must be terminated by a line feed or zero. For Non-Blocking configuration, OutText() may return control to the program due to display device busy status. When this happens zero is returned and OutText() must be called again to continue the outputting of the string. For Blocking configuration, this function always returns a 1. OutText() uses the current active font set with SetFont().
Input Parameters
|
Input Parameters |
Description |
|
XCHAR * textString |
Pointer to the string to be displayed. |
Returns
For NON-Blocking configuration:
- Returns 0 when string is not yet outputted completely.
- Returns 1 when string is outputted completely.
- Always return 1.
Side Effects
Current horizontal graphic cursor position will be moved to the end of the text. The vertical graphic cursor position will not be changed.
Example
SetFont(pMyFont);
SetColor(WHITE);
// place the string at the upper left corner of the screen
MoveTo(0, 0);
OutText("Test String!");