Difference between revisions of "API Debug.PrintLn"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Prints out the string or value with a new-line in the debug window | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API Debug|Debug]] | ||
| + | :[[API Debug|PrintLn]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|STRING]] ''Output'' | |
:Text to display | :Text to display | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | This is a debug diagnostic call to allow text to easily be outputted during events to trace what a program is doing. | |
| − | * Add to a calculation icon: ::Debug.PrintLn("output") | + | |
| + | During an event, breakpoints can not be used. Calls like this help establish if a flowcharts logic is sound. | ||
| + | |||
| + | Unlike [[API Debug.Print|Print]], the PrintLn will automatically add a new-line after the text is printed. This is useful for more compact flowcharts. | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Debug.PrintLn("output")</pre> | ||
| + | |||
| + | ===Example flowchart=== | ||
| + | This example shows simple usage of both Print and PrintLn: | ||
| + | |||
| + | {{Fcfile|SIMAPI_Debug_Print.fcfx|SIMAPI_Debug_Print}} | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Prints out the string or value with a new-line in the debug window
Contents
Parameters
STRING Output
- Text to display
Return value
This call does not return a value
Detailed description
This is a debug diagnostic call to allow text to easily be outputted during events to trace what a program is doing.
During an event, breakpoints can not be used. Calls like this help establish if a flowcharts logic is sound.
Unlike Print, the PrintLn will automatically add a new-line after the text is printed. This is useful for more compact flowcharts.
Examples
Calling in a calculation
- Add to a calculation icon:
::Debug.PrintLn("output")
Example flowchart
This example shows simple usage of both Print and PrintLn:
