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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Reads a single byte from the NVM, -1 if empty
 
Reads a single byte from the NVM, -1 if empty
  
Line 11: Line 11:
  
 
==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
  
  
 
==Return value==
 
==Return value==
[[Variable types|INT]]
+
[[Variable Types|INT]]
 +
 
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
  
Line 32: Line 33:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.ReadByte(filehandle, address)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.ReadByte(filehandle, address)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Reads a single byte from the NVM, -1 if empty

Class hierarchy

File

NVM
ReadByte

Parameters

HANDLE FileHandle

The handle of an open file

ULONG Address

Position in the file in bytes


Return value

INT

No additional information


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type INT
  • Add to a calculation icon:
    result = ::File.NVM.ReadByte(filehandle, address)

No additional examples