Difference between revisions of "API File.Buffer.ReadByte"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Reads a single byte from the input stream, -1 if empty | Reads a single byte from the input stream, -1 if empty | ||
| Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''FileHandle'' |
:The handle of an open file | :The handle of an open file | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''Timeout'' |
:A number of milliseconds to wait for the byte to be available | :A number of milliseconds to wait for the byte to be available | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| Line 20: | Line 20: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|INT]] |
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' | ||
| Line 34: | Line 34: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadByte(filehandle, timeout)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadByte(filehandle, timeout)</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Reads a single byte from the input stream, -1 if empty
Contents
Parameters
HANDLE FileHandle
- The handle of an open file
ULONG Timeout
- A number of milliseconds to wait for the byte to be available
- The default value for this parameter is: 0
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type INT
- Add to a calculation icon:
result = ::File.Buffer.ReadByte(filehandle, timeout)
No additional examples
