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

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Writes a single byte to the input stream

HANDLE FileHandle

The handle of an open file

BYTE Data

A byte of data to write to the file

Returns true if the operation is a success, else false

No additional information

Add to a calculation icon:

result = ::File.Buffer.WriteByte(filehandle, data)

No additional examples

@@ Line 1: / Line 1: @@
-API contents
+<sidebar>API Contents</sidebar>
 Writes a single byte to the input stream
+<div style="width:25%; float:right" class="toc">
+====Class hierarchy====
+[[API File|File]]
+:[[API File.Buffer|Buffer]]
+::[[API File.Buffer|WriteByte]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] FileHandle''
+[[Variable Types|HANDLE]] ''FileHandle''
 :The handle of an open file
-''[[Variable types|BYTE]] Data''
+[[Variable Types|BYTE]] ''Data''
 :A byte of data to write to the file
-===Return value===
-[[Variable types|BOOL]]
-No additional information
+==Return value==
+[[Variable Types|BOOL]]
-===Detailed description===
+Returns true if the operation is a success, else false
-''No additional information''
-===Examples===
-====Calling in a calculation====
+==Detailed description==
+''<span style="color:red;">No additional information</span>''
+==Examples==
+===Calling in a calculation===
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: result = ::File.Buffer.WriteByte(filehandle, data)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.WriteByte(filehandle, data)</pre>
+''<span style="color:red;">No additional examples</span>''