Difference between revisions of "API File.NVM.ReadArray"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Reads an array from the NVM, returns elements read | Reads an array from the NVM, returns elements read | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API | | + | ====Class hierarchy==== |
| − | :[[API File| | + | [[API File|File]] |
| − | ::[[API File.NVM| | + | :[[API File.NVM|NVM]] |
| − | + | ::[[API File.NVM|ReadArray]] | |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==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 | ||
| − | + | [[Variable Types|ARRAY]] ''Buffer'' | |
:An array of some type to read from the file | :An array of some type to read from the file | ||
| − | + | [[Variable Types|ULONG]] ''Elements'' | |
:Maximum number of elements to read | :Maximum number of elements to read | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|ULONG]] |
Returns elements read | Returns elements read | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 36: | Line 39: | ||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.ReadArray(filehandle, address, _arraybuffer, elements)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.ReadArray(filehandle, address, _arraybuffer, elements)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Reads an array from the NVM, returns elements read
Contents
Parameters
HANDLE FileHandle
- The handle of an open file
ULONG Address
- Position in the file in bytes
ARRAY Buffer
- An array of some type to read from the file
ULONG Elements
- Maximum number of elements to read
- The default value for this parameter is: -1
Return value
Returns elements read
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.ReadArray(filehandle, address, _arraybuffer, elements)
No additional examples
