Difference between revisions of "API File.Buffer.ReadByte"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import of updated API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<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 34: Line 36:
 
* 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 information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Reads a single byte from the input stream, -1 if empty

Class hierarchy

File

Buffer
ReadByte

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

INT

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