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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
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===
 +
: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
Line 17: Line 24:
 
:''The default value for this parameter is: '''''1'''
 
:''The default value for this parameter is: '''''1'''
  
===Return value===
+
==Return value==
 
[[Variable types|ULONG]]
 
[[Variable types|ULONG]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
* Add to a calculation icon: <pre class="brush:[C]">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>

Revision as of 21:14, 11 May 2013

<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)