Difference between revisions of "API Debug.PrintLn"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Prints out the string or value with a new-line in the debug window
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintLn'''
====Class hierarchy====
+
|-
[[API Debug|Debug]]
+
| colspan="2" | Prints out the string or value with a new-line in the debug window&nbsp;
:[[API Debug|PrintLn]]
+
|-
</div>
+
|-
__TOC__
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
+
| width="90%" | Output
==Parameters==
+
|-
[[Variable Types|STRING]] ''Output''
+
| colspan="2" | Text to display&nbsp;
:Text to display
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
==Return value==
+
|}
''This call does not return a value''
 
  
  
Line 33: Line 32:
 
This example shows simple usage of both Print and PrintLn:
 
This example shows simple usage of both Print and PrintLn:
  
[[file:SIM_Debug.Print.fcf]]
+
{{Fcfile|SIMAPI_Debug_Print.fcfx|SIMAPI_Debug_Print}}

Latest revision as of 11:42, 16 January 2023

Fc9-comp-macro.png PrintLn
Prints out the string or value with a new-line in the debug window 
Fc9-string-icon.png - STRING Output
Text to display 
Fc9-void-icon.png - NONE Return


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:

FC6 Icon.png SIMAPI_Debug_Print