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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import API changes)
Line 21: Line 21:
 
==Return value==
 
==Return value==
 
[[Variable types|INT]]
 
[[Variable types|INT]]
 +
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
  

Revision as of 13:17, 14 May 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 information