API File.Buffer.ReadByte: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| 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>'' | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Reads a single byte from the input stream, -1 if empty
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 information