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

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 11: Line 11:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''FileHandle''
+
[[Variable Types|HANDLE]] ''FileHandle''
 
:The handle of an open file
 
:The handle of an open file
  
[[Variable types|ULONG]] ''Timeout''
+
[[Variable Types|ULONG]] ''Timeout''
 
: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'''
Line 20: Line 20:
  
 
==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 11:08, 10 June 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