RFIO.RFPrint

boolean RFPrint(short nCol, short nRow, BSTR pszMessage, short nMode)

Function RFPrint(nCol As Integer, nRow As Integer, pszMessage As String, nMode As Integer) As Boolean

Displays text to user.

Return value
True=successful, False=error, RF link lost.

Parameters

nCol
    Column in the display (0 based).

nRow
    Row in the display (0 based).

pszMessage
    Text to display.

nMode
    One or more (adding) of this constants :

Constant Description
WLNORMAL Normal display.
WLREVERSE Reverse video display.
WLCLREOLN Clear end of line (after displayed line).
WLCLREOS Clear end of screen (after displayed line).
WLCLEAR Clears the entire screen before display.
WLFLUSHOUTPUT Forces the display lines to be sent to the RF terminal.

Optional constants for foreground color text (select one) with optional light colors.
Only for Windows based WS clients.

Constant Foreground Color text
WFGCOLORBLACK Foreground color text black (default)
WFGCOLORBLUE Foreground color text BLUE
WFGCOLORCYAN Foreground color text CYAN
WFGCOLORGREEN Foreground color text GREEN
WFGCOLORMAGENTA Foreground color text MAGENTA
WFGCOLORRED Foreground color text RED
WFGCOLORWHITE Foreground color text WHITE
WFGCOLORYELLOW Foreground color text YELLOW
WFGLORLIGHT Add this constant to obtain light colors

Optional constants for background color text (select one)  with optional light colors.
Only for Windows based WS clients.

Constant Background Color text
WBGCOLORBLACK Background color text black (default)
WBGCOLORBLUE Background color text BLUE
WBGCOLORCYAN Background color text CYAN
WBGCOLORGREEN Background color text GREEN
WBGCOLORMAGENTA Background color text MAGENTA
WBGCOLORRED Background color text RED
WBGCOLORWHITE Background color text WHITE
WBGCOLORYELLOW Background color text YELLOW
WBGLORLIGHT Add this constant to obtain light colors

Optional constants to use the TTS engine.

Constant Foreground Color text
WLSPELL The TTS engine will spell the line.
WLSPEECH The TTS engine will say the phrase.

Remarks
The displayed lines are temporarily stored in the server, then sent at once when needed : by an any input function, or forced by RFFlushOutput function or by WLFLUSHOUTPUT constant in the RFPrint function.
If the row or column exceed the terminal display size, the function is ignored and no error is returned.
The client must be configured to use the TTS engine in order to use the constants WLSPEECH and WLSPELL. The field '_VOICE/UseTts' must be set to 'Yes' in the configuration file, to enable the TTS engine.

Example
wsRfIo.RFPrint 0, 0, " Display attributes ", WLCLEAR + WLREVERSE +  ' Clears the screen
wsRfIo.RFPrint 0, 2, " Normal Display ", WLNORMAL
wsRfIo.RFPrint 0, 3, " Reverse Display ", WLREVERSE
wsRfIo.RFPrint 0, 7, " Press <ENTER> ", WLNORMAL + WLFLUSHOUTPUT ' Sends to terminal

Color options
wsRfIo.RFPrint 0, 0, " Display attributes ", WLCLEAR + WLREVERSE + WFGCOLORBLUE + WBGCOLORYELLOW
wsRfIo.RFPrint 0, 2, " Normal Display ", WLNORMAL + WFGCOLORGREEN + WFGLORLIGHT + WBGCOLORRED
wsRfIo.RFPrint 0, 3, " Reverse Display ", WLREVERSE + WFGCOLORBLACK + WBGCOLORMAGENTA + WBGLORLIGHT
wsRfIo.RFPrint 0, 7, " Press <ENTER> ", WLNORMAL + WLFLUSHOUTPUT ' Sends to terminal

See also    RFIO, RFFlushOutput