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

From Flowcode Help
Jump to navigationJump to search
(XML import)
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]]
−
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteByte'''
−
====Class hierarchy====
+
|-
−
[[API File|File]]
+
| colspan="2" | Writes a single byte to the NVM multiple times&nbsp;
−
:[[API File.NVM|NVM]]
+
|-
−
::[[API File.NVM|WriteByte]]
+
|-
−
</div>
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
−
__TOC__
+
| width="90%" | FileHandle
−
 
+
|-
−
==Parameters==
+
| colspan="2" | The handle of an open file&nbsp;
−
[[Variable Types|HANDLE]] ''FileHandle''
+
|-
−
:The handle of an open file
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
−
 
+
| width="90%" | Address
−
[[Variable Types|ULONG]] ''Address''
+
|-
−
:Position in the file in bytes
+
| colspan="2" | Position in the file in bytes&nbsp;
−
 
+
|-
−
[[Variable Types|BYTE]] ''Data''
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
:Array of data to write to the file
+
| width="90%" | Data
−
 
+
|-
−
[[Variable Types|BYTE]] ''Count''
+
| colspan="2" | Array of data to write to the file&nbsp;
−
:Number of times to write the byte in sequence
+
|-
−
:''The default value for this parameter is: '''''1'''
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
 
+
| width="90%" | Count
−
 
+
|-
−
==Return value==
+
| colspan="2" | Number of times to write the byte in sequence&nbsp;
−
[[Variable Types|ULONG]]
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  

Revision as of 11:42, 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

No additional information


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)

No additional examples

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_File.NVM.WriteByte&oldid=30006"