API File.Buffer.ReadByte: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	ReadByte
Reads a single byte from the input stream, -1 if empty
- HANDLE	FileHandle
The handle of an open file
- ULONG	Timeout
A number of milliseconds to wait for the byte to be available
- 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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Reads a single byte from the input stream, -1 if empty
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''ReadByte'''
-====Class hierarchy====
+|-
-[[API File|File]]
+| colspan="2" | Reads a single byte from the input stream, -1 if empty&nbsp;
-:[[API File.Buffer|Buffer]]
+|-
-::[[API File.Buffer|ReadByte]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | FileHandle
+|-
-==Parameters==
+| colspan="2" | The handle of an open file&nbsp;
-[[Variable types|HANDLE]] ''FileHandle''
+|-
-:The handle of an open file
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Timeout
-[[Variable types|ULONG]] ''Timeout''
+|-
-:A number of milliseconds to wait for the byte to be available
+| colspan="2" | A number of milliseconds to wait for the byte to be available&nbsp;
-:''The default value for this parameter is: '''''0'''
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-[[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
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadByte(filehandle, timeout)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation