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

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===
+
===Class hierarchy===[[API |API ]]
:File
+
:[[API File|File]]
::NVM
+
::[[API File.NVM|NVM]]
 
:::ReadArray
 
:::ReadArray
 
</div>
 
</div>

Revision as of 21:19, 11 May 2013

<sidebar>API contents</sidebar> Reads an array from the NVM, returns elements read

===Class hierarchy===API

File
NVM
ReadArray

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

ULONG

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)