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

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]]
+| width="90%" class="mtx-class-macrohead" | '''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==
+==Detailed description==
-''[[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]]
-No additional information
-==Detailed description==
-''No additional information''
 ==Examples==