Difference between revisions of "API File.NVM.ReadByte"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API File|File]] | + | ====Class hierarchy==== |
| + | [[API File|File]] | ||
:[[API File.NVM|NVM]] | :[[API File.NVM|NVM]] | ||
::[[API File.NVM|ReadByte]] | ::[[API File.NVM|ReadByte]] | ||
| Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable types|HANDLE]] ''FileHandle'' | |
:The handle of an open file | :The handle of an open file | ||
| − | + | [[Variable types|ULONG]] ''Address'' | |
:Position in the file in bytes | :Position in the file in bytes | ||
| Line 19: | Line 20: | ||
[[Variable types|INT]] | [[Variable types|INT]] | ||
| − | No additional information | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 28: | Line 32: | ||
* Declare a variable 'result' of type INT | * Declare a variable 'result' of type INT | ||
* 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>'' | ||
Revision as of 22:11, 11 May 2013
<sidebar>API contents</sidebar> Reads a single byte from the NVM, -1 if empty
Contents
Parameters
HANDLE FileHandle
- The handle of an open file
ULONG Address
- Position in the file in bytes
Return value
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 information
