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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Reads a single byte from the input stream, -1 if empty
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadByte'''
 +
|-
 +
| colspan="2" | Reads a single byte from the input stream, -1 if empty&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | FileHandle
 +
|-
 +
| colspan="2" | The handle of an open file&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Timeout
 +
|-
 +
| colspan="2" | A number of milliseconds to wait for the byte to be available&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API File|File]]
 
:[[API File.Buffer|Buffer]]
 
::[[API File.Buffer|ReadByte]]
 
</div>
 
__TOC__
 
 
==Parameters==
 
[[Variable types|HANDLE]] ''FileHandle''
 
:The handle of an open file
 
 
[[Variable types|ULONG]] ''Timeout''
 
:A number of milliseconds to wait for the byte to be available
 
:''The default value for this parameter is: '''''0'''
 
 
 
==Return value==
 
[[Variable types|INT]]
 
 
''<span style="color:red;">No additional information</span>''
 
  
 +
==Detailed description==
  
==Detailed description==
 
''<span style="color:red;">No additional information</span>''
 
  
  
Line 33: Line 30:
 
* Declare a variable 'result' of type INT
 
* Declare a variable 'result' of type INT
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadByte(filehandle, timeout)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadByte(filehandle, timeout)</pre>
 
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png ReadByte
Reads a single byte from the input stream, -1 if empty 
Fc9-h32-icon.png - HANDLE FileHandle
The handle of an open file 
Fc9-u32-icon.png - ULONG Timeout
A number of milliseconds to wait for the byte to be available 
Fc9-s16-icon.png - INT Return


Detailed description

Examples

Calling in a calculation

  • Declare a variable 'result' of type INT
  • Add to a calculation icon:
    result = ::File.Buffer.ReadByte(filehandle, timeout)