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

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML import)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Writes a single byte to the input stream
 
Writes a single byte to the input stream
  
Line 11: Line 11:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''FileHandle''
+
[[Variable Types|HANDLE]] ''FileHandle''
 
:The handle of an open file
 
:The handle of an open file
  
[[Variable types|BYTE]] ''Data''
+
[[Variable Types|BYTE]] ''Data''
 
:A byte of data to write to the file
 
:A byte of data to write to the file
  
  
 
==Return value==
 
==Return value==
[[Variable types|BOOL]]
+
[[Variable Types|BOOL]]
  
 
Returns true if the operation is a success, else false
 
Returns true if the operation is a success, else false
Line 33: Line 33:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.WriteByte(filehandle, data)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.WriteByte(filehandle, data)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

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

Class hierarchy

File

Buffer
WriteByte

Parameters

HANDLE FileHandle

The handle of an open file

BYTE Data

A byte of data to write to the file


Return value

BOOL

Returns true if the operation is a success, else false


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::File.Buffer.WriteByte(filehandle, data)

No additional examples