Difference between revisions of "API Console.AddText"
(XML import of API auto-gen) |
(XML import) |
||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Adds a window to the list of consoles available | Adds a window to the list of consoles available | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Console|Console]] | ||
| + | :[[API Console|AddText]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|STRING]] ''Name'' | |
:The name to appear as the consoles title | :The name to appear as the consoles title | ||
| − | + | [[Variable Types|BOOL]] ''UserWrite'' | |
:Set true to allow input from the User | :Set true to allow input from the User | ||
| − | |||
| − | |||
| − | + | ==Return value== | |
| + | [[Variable Types|HANDLE]] | ||
| − | + | A handle to the text console that can be used to change its style and content. | |
| − | |||
| − | ===Examples | + | |
| − | + | ==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 [[API Console.AddMemory|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 | * Declare a variable 'result' of type HANDLE | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.AddText("name", true)</pre> |
| + | |||
| + | ===Flowchart example=== | ||
| + | The example {{Fcfile|SIMAPI Console.fcfx|SIMAPI Console}} illustrates basic creation of a console window. | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Adds a window to the list of consoles available
Contents
Parameters
STRING Name
- The name to appear as the consoles title
BOOL UserWrite
- Set true to allow input from the User
Return value
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 
SIMAPI Console illustrates basic creation of a console window.
