Difference between revisions of "API File.Buffer.ReadByte"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(11 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 | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ====Class hierarchy==== | ||
+ | [[API File|File]] | ||
+ | :[[API File.Buffer|Buffer]] | ||
+ | ::[[API File.Buffer|ReadByte]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''FileHandle'' | |
:The handle of an open file | :The handle of an open file | ||
− | + | [[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''' | ||
− | |||
− | |||
− | + | ==Return value== | |
+ | [[Variable Types|INT]] | ||
− | + | ''<span style="color:red;">No additional information</span>'' | |
− | ''No additional information'' | ||
− | ===Examples | + | |
− | + | ==Detailed description== | |
+ | ''<span style="color:red;">No additional information</span>'' | ||
+ | |||
+ | |||
+ | ==Examples== | ||
+ | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type INT | * Declare a variable 'result' of type INT | ||
− | * Add to a calculation icon: result = ::File.Buffer.ReadByte(filehandle, timeout) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadByte(filehandle, timeout)</pre> |
+ | |||
+ | ''<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