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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import API auto-gen)
Line 1: Line 1:
API contents
+
<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
  

Revision as of 15:35, 10 May 2013

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


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)