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

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> 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

The default value for this parameter is: 0

No additional information

No additional information

Add to a calculation icon:

result = ::File.Buffer.ReadByte(filehandle, timeout)

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
-==File.BufferReadByte==
+Reads a single byte from the input stream, -1 if empty
-Reads a single byte from the input stream, -1 if empty
+<div style="width:25%; float:right" class="toc">
-----
+====Class hierarchy====
+[[API File|File]]
+:[[API File.Buffer|Buffer]]
+::[[API File.Buffer|ReadByte]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] FileHandle''
+[[Variable Types|HANDLE]] ''FileHandle''
 :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
 :''The default value for this parameter is: '''''0'''
-===Return value===
-[[Variable types|INT]]
-No additional information
+==Return value==
+[[Variable Types|INT]]
+''<span style="color:red;">No additional information</span>''
-===Detailed description===
+==Detailed description==
-''No additional information''
+''<span style="color:red;">No additional information</span>''
-===Examples===
-====Calling in a calculation:====
+==Examples==
+===Calling in a calculation===
 * Declare a variable 'result' of type INT
-* Add to a calculation icon: result = ::File.Buffer.ReadByte(filehandle, timeout)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadByte(filehandle, timeout)</pre>
+''<span style="color:red;">No additional examples</span>''