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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import API auto-gen)
Line 1: Line 1:
 
wiki page name
 
wiki page name
==File.BufferReadByte==
+
Reads a single byte from the input stream, -1 if empty
  
Reads a single byte from the input stream, -1 if empty
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 22: Line 20:
  
 
===Examples===
 
===Examples===
====Calling in a calculation:====
+
====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: result = ::File.Buffer.ReadByte(filehandle, timeout)

Revision as of 15:34, 10 May 2013

wiki page name 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)