Difference between revisions of "API Console"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
Line 1: Line 1:
 
 
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
Text console additions
 
Text console additions

Revision as of 11:08, 10 June 2013

<sidebar>API contents</sidebar> Text console additions


Functions provided for this class

AddText Adds a window to the list of consoles available
AddMemory Adds a window to the list of consoles available
GetDefault Gets the default (read-only) console window
SetMemMode Sets whether to show address and bytes for the console
SetInputRGB Sets the colour of text inserted by the user from now on
SetOutputRGB Sets the colour of text inserted by the component from now on
WriteText Adds a block of text to the console window
GetLineText Reads a line of text from the given console, pass -1 for final line
SetLineText Writes a line of text from the given console, pass -1 for final line
GetLineBytes Reads a line of bytes from the given console extending the array if needed
SetLineBytes Writes a line of bytes from the given console, pass -1 for final line
CountLines Counts the number of lines in the console
ClearText Clears all the text in the console


Examples

This demonstration creates two console windows, one is a memory window and one is a text window.

When the pin A.0 goes high the view of each switches - the text window displays as memory and vice versa. Though the view changes, the type of console stays the same - one is fixed memory, the other is a stream that is always added to.

File:SIMAPI Console.fcf

See also

API Debug.Print

API Scope