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

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
(XML import)
 
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

Latest revision as of 15:57, 16 January 2014

<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