Difference between revisions of "API File.Buffer.ReadByte"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Reads a single byte from the input stream, -1 if empty | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadByte''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a single byte from the input stream, -1 if empty | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | FileHandle | ||
| + | |- | ||
| + | | colspan="2" | The handle of an open file | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Timeout | ||
| + | |- | ||
| + | | colspan="2" | A number of milliseconds to wait for the byte to be available | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | ==Detailed description== | ||
| − | |||
| − | |||
| Line 33: | Line 30: | ||
* Declare a variable 'result' of type INT | * Declare a variable 'result' of type INT | ||
* 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> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
ReadByte |
| Reads a single byte from the input stream, -1 if empty | |
 - HANDLE
|
FileHandle |
| The handle of an open file | |
 - ULONG
|
Timeout |
| A number of milliseconds to wait for the byte to be available | |
 - INT
|
Return |
Detailed description
Examples
Calling in a calculation
- Declare a variable 'result' of type INT
- Add to a calculation icon:
result = ::File.Buffer.ReadByte(filehandle, timeout)
