API File.NVM.ReadArray: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
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"> | |||
===Class hierarchy=== | |||
:File | |||
::NVM | |||
:::ReadArray | |||
</div> | |||
__TOC__ | |||
==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== | |||
[[Variable types|ULONG]] | [[Variable types|ULONG]] | ||
Returns elements read | Returns elements read | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===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:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.ReadArray(filehandle, address, _arraybuffer, elements)</pre> | ||
Revision as of 21:14, 11 May 2013
<sidebar>API contents</sidebar> Reads an array from the NVM, returns elements read
Class hierarchy
- File
- NVM
- ReadArray
- NVM
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)