API Console.AddText

From Flowcode Help
Jump to: navigation, search

Adds a window to the list of consoles available

Class hierarchy

Console

AddText

Contents


Parameters

STRING Name

The name to appear as the consoles title

BOOL UserWrite

Set true to allow input from the User


Return value

HANDLE

A handle to the text console that can be used to change its style and content.


Detailed description

A text console is a stream of text suitable for use as a terminal to display, for example RS232 data or a remote connection. When text is added, this is always appended to the end of the stream so the text contents will get larger. This differs from the AddMemory call which has a fixed size and operates in 'overwrite' mode to change the text.


Once a handle is created it must be retained, as Flowcode will remove any handles from the system that are not referenced.


The style and content of the console can be changed at any time. The only thing that is fixed is the type of console - a text console always has a variable size and a variable number of characters per line.


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Console.AddText("name", true)

Flowchart example

The example FC6 Icon.png SIMAPI Console illustrates basic creation of a console window.

Personal tools