Difference between revisions of "Component: Time Stamp (Runtime Tools)"

From Flowcode Help
Jump to navigationJump to search
 
(2 intermediate revisions by the same user not shown)
Line 77: Line 77:
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
 +
 +
 +
 +
 +
 +
  
  
Line 85: Line 91:
 
==Macro reference==
 
==Macro reference==
  
===GetValue===
+
===GetDate===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDate'''
 
|-
 
|-
| colspan="2" | Allows a single time or date value to be returned.&nbsp;
+
| colspan="2" | Returns the current system date as a string in the selected format.&nbsp;
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Index
 
|-
 
| colspan="2" | 0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year, 6: Millisecs&nbsp;
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
===GetTimeStamp===
+
===GetStr===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTimeStamp'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStr'''
 +
|-
 +
| colspan="2" | Allows a single time or date value to be returned as a two character string.&nbsp;
 +
|-
 
|-
 
|-
| colspan="2" | Returns the current system date and  time combined into a single string.&nbsp;
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 
|-
 
|-
 +
| colspan="2" | 0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year&nbsp;
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
Line 132: Line 138:
  
  
===GetDate===
+
===GetTimeStamp===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDate'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTimeStamp'''
 
|-
 
|-
| colspan="2" | Returns the current system date as a string in the selected format.&nbsp;
+
| colspan="2" | Returns the current system date and  time combined into a single string.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 146: Line 152:
  
  
===GetStr===
+
===GetValue===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStr'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
 
|-
 
|-
| colspan="2" | Allows a single time or date value to be returned as a two character string.&nbsp;
+
| colspan="2" | Allows a single time or date value to be returned.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 158: Line 164:
 
| width="90%" | Index
 
| width="90%" | Index
 
|-
 
|-
| colspan="2" | 0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year&nbsp;
+
| colspan="2" | 0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year, 6: Millisecs&nbsp;
 
|-
 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
 
 
  
  

Latest revision as of 13:13, 7 February 2023

Author Matrix TSL
Version 1.2
Category Runtime Tools


Time Stamp component

A simple simulation component to collect the current system timestamp as a string.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_TimeStamp.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_TimeStamp.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

GetDate

Fc9-comp-macro.png GetDate
Returns the current system date as a string in the selected format. 
Fc9-string-icon.png - STRING Return


GetStr

Fc9-comp-macro.png GetStr
Allows a single time or date value to be returned as a two character string. 
Fc9-u8-icon.png - BYTE Index
0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year 
Fc9-string-icon.png - STRING Return


GetTime

Fc9-comp-macro.png GetTime
Returns the current system time as a string in the format of "HH MM SS" 
Fc9-string-icon.png - STRING Return


GetTimeStamp

Fc9-comp-macro.png GetTimeStamp
Returns the current system date and time combined into a single string. 
Fc9-string-icon.png - STRING Return


GetValue

Fc9-comp-macro.png GetValue
Allows a single time or date value to be returned. 
Fc9-u8-icon.png - BYTE Index
0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year, 6: Millisecs 
Fc9-u16-icon.png - UINT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Date Format
Specifies the format of the date string. No - "DD/MM/YY" Yes - "MM/DD/YY"  
Fc9-type-10-icon.png Time Separator
Characters that are used in between the time digits 
Fc9-type-10-icon.png Date Separator
Characters that are used in between the date digits 
Fc9-type-10-icon.png TimeStamp Separator
Characters that are used between the time and date strings when returning a full time stamp. 
Fc9-type-7-icon.png Include Milliseconds
Allows milliseconds to be included in the timestamp