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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Writes a single byte to the NVM multiple times
 
Writes a single byte to the NVM multiple times
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API File|File]]
 +
:[[API File.NVM|NVM]]
 +
::[[API File.NVM|WriteByte]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] FileHandle''
+
[[Variable Types|HANDLE]] ''FileHandle''
 
:The handle of an open file
 
:The handle of an open file
  
''[[Variable types|ULONG]] Address''
+
[[Variable Types|ULONG]] ''Address''
 
:Position in the file in bytes
 
:Position in the file in bytes
  
''[[Variable types|BYTE]] Data''
+
[[Variable Types|BYTE]] ''Data''
 
:Array of data to write to the file
 
:Array of data to write to the file
  
''[[Variable types|BYTE]] Count''
+
[[Variable Types|BYTE]] ''Count''
 
:Number of times to write the byte in sequence
 
:Number of times to write the byte in sequence
 
:''The default value for this parameter is: '''''1'''
 
:''The default value for this parameter is: '''''1'''
  
===Return value===
 
[[Variable types|ULONG]]
 
  
No additional information
+
==Return value==
 +
[[Variable Types|ULONG]]
  
===Detailed description===
+
''<span style="color:red;">No additional information</span>''
''No additional information''
 
  
===Examples===
+
 
====Calling in a calculation====
+
==Detailed description==
 +
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
* Add to a calculation icon: result = ::File.NVM.WriteByte(filehandle, address, data, count)
+
* 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 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Writes a single byte to the NVM multiple times

Class hierarchy

File

NVM
WriteByte

Parameters

HANDLE FileHandle

The handle of an open file

ULONG Address

Position in the file in bytes

BYTE Data

Array of data to write to the file

BYTE Count

Number of times to write the byte in sequence
The default value for this parameter is: 1


Return value

ULONG

No additional information


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