Difference between revisions of "API File.Buffer.ReadArray"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import API auto-gen) |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
| − | + | Reads an array from the input stream, returns elements read | |
| − | |||
| − | |||
===Parameters=== | ===Parameters=== | ||
| Line 29: | Line 27: | ||
===Examples=== | ===Examples=== | ||
| − | ====Calling in a calculation | + | ====Calling in a calculation==== |
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
* Add to a calculation icon: result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout) | * Add to a calculation icon: result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout) | ||
Revision as of 15:34, 10 May 2013
wiki page name 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)
