Jump to content

API File.Buffer.ReadByte: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
Admin (talk | contribs)
XML import
Line 17: Line 17:
:A number of milliseconds to wait for the byte to be available
:A number of milliseconds to wait for the byte to be available
:''The default value for this parameter is: '''''0'''
:''The default value for this parameter is: '''''0'''


==Return value==
==Return value==
Line 22: Line 23:


''<span style="color:red;">No additional information</span>''
''<span style="color:red;">No additional information</span>''





Revision as of 01:56, 12 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