Jump to content

API Console.SetLineText: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import of API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
Writes a line of text from the given console, pass -1 for final line
Writes a line of text from the given console, pass -1 for final line


<div style="width:25%; float:right" class="toc">
===Class hierarchy===
:Console
::SetLineText
</div>
__TOC__


===Parameters===
==Parameters==
''[[Variable types|HANDLE]] ConsoleHandle''
''[[Variable types|HANDLE]] ConsoleHandle''
:A valid console windows handle
:A valid console windows handle
Line 13: Line 19:
:A single line of text to add to the console
:A single line of text to add to the console


===Return value===
==Return value==
''This call does not return a value''
''This call does not return a value''


===Detailed description===
==Detailed description==
''No additional information''
''No additional information''


===Examples===
==Examples==
====Calling in a calculation====
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::Console.SetLineText(consolehandle, line, "text")</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetLineText(consolehandle, line, "text")</pre>

Revision as of 17:00, 11 May 2013

<sidebar>API contents</sidebar> Writes a line of text from the given console, pass -1 for final line

Class hierarchy

Console
SetLineText

Parameters

HANDLE ConsoleHandle

A valid console windows handle

ULONG Line

The zero-based index of the line to write the text to

STRING Text

A single line of text to add to the console

Return value

This call does not return a value

Detailed description

No additional information

Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Console.SetLineText(consolehandle, line, "text")