FC_DisplayMessageWrite

 

FC_DisplayMessageWrite - General Information

Overview

Type:

Function

Available as of:

SystemInterface_1.32.6.0

Versions:

Current version

Task

Output of text in the display (at any position).

Description

Use this function to output a i_sDisplayString text at any position within the controller display (PacDrive LMC Pro, PacDrive LMC Eco). In contrary to the function FC_DisplayLineWrite(), the text is continued in the next line; so it can be written across several lines. Use i_uiLine to specify the line in which the first character is to be written. Use i_uiPosition to specify the start position for text in the line.

Use flag i_xClearDisplay to select whether the display is first deleted or whether the text is overwritten.

If the text is longer than the number of characters available on the display, the text is shortened to the length that can be displayed.

Interface

Input

Data type

Description

i_uiLine

UINT

Line, in which the first character is to be written

i_uiPosition

UINT

Start position of the text within the line

i_sDisplayString

STRING[200]

Text that has to be written

i_xClearDisplay

BOOL

Delete the display first or the text is overwritten

Return Value

Data type

Description

DINT

0: OK

-1: Function for controller is not available

-2: Internal error detected

-3: The display is not in the IEC-Mode

-10: The string that has to be written is outside the available range

Examples

sDisplayString:='FC_DisplayMessageWrite -> ->';
lResult:=FC_DisplayMessageWrite(uiLine+1, uiPosition, sDisplayString, bClearDisplay);
IF lResult < 0 THEN
   sResult := 'Error: FC_DisplayMessageWrite';
END_IF;