API File.Buffer.ReadArray: Difference between revisions
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.Buffer|Buffer]] | :[[API File.Buffer|Buffer]] | ||
::[[API File.Buffer|ReadArray]] | ::[[API File.Buffer|ReadArray]] | ||
| Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|HANDLE]] ''FileHandle'' | |||
:The handle of an open file | :The handle of an open file | ||
[[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''' | ||
[[Variable types|ULONG]] ''Timeout'' | |||
:A number of milliseconds to wait for the data to be available | :A number of milliseconds to wait for the data to be available | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| Line 30: | Line 31: | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 36: | Line 38: | ||
* 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.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:11, 11 May 2013
<sidebar>API contents</sidebar> Reads an array from the input stream, returns elements read
Parameters
HANDLE FileHandle
- The handle of an open file
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
ULONG Timeout
- A number of milliseconds to wait for the data to be available
- The default value for this parameter is: 0
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.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)
No additional information