Difference between revisions of "API File.NVM.WriteByte"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Writes a single byte to the NVM multiple times
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteByte'''
 +
|-
 +
| colspan="2" | Writes a single byte to the NVM multiple times&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | FileHandle
 +
|-
 +
| colspan="2" | The handle of an open file&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Position in the file in bytes&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Array of data to write to the file&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" | Number of times to write the byte in sequence&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API File|File]]
 
:[[API File.NVM|NVM]]
 
::[[API File.NVM|WriteByte]]
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
[[Variable Types|HANDLE]] ''FileHandle''
 
:The handle of an open file
 
 
 
[[Variable Types|ULONG]] ''Address''
 
:Position in the file in bytes
 
 
 
[[Variable Types|BYTE]] ''Data''
 
:Array of data to write to the file
 
 
 
[[Variable Types|BYTE]] ''Count''
 
:Number of times to write the byte in sequence
 
:''The default value for this parameter is: '''''1'''
 
 
 
 
 
==Return value==
 
[[Variable Types|ULONG]]
 
  
''<span style="color:red;">No additional information</span>''
 
 
 
==Detailed description==
 
''<span style="color:red;">No additional information</span>''
 
  
  
Line 39: Line 40:
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.WriteByte(filehandle, address, data, count)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.WriteByte(filehandle, address, data, count)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png WriteByte
Writes a single byte to the NVM multiple times 
Fc9-h32-icon.png - HANDLE FileHandle
The handle of an open file 
Fc9-u32-icon.png - ULONG Address
Position in the file in bytes 
Fc9-u8-icon.png - BYTE Data
Array of data to write to the file 
Fc9-u8-icon.png - BYTE Count
Number of times to write the byte in sequence 
Fc9-u32-icon.png - ULONG Return


Detailed description

Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon:
    result = ::File.NVM.WriteByte(filehandle, address, data, count)