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

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Writes a single byte to the input stream
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteByte'''
====Class hierarchy====
+
|-
[[API File|File]]
+
| colspan="2" | Writes a single byte to the input stream&nbsp;
:[[API File.Buffer|Buffer]]
+
|-
::[[API File.Buffer|WriteByte]]
+
|-
</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-u8-icon.png]] - BYTE
 
+
| width="90%" | Data
[[Variable Types|BYTE]] ''Data''
+
|-
:A byte of data to write to the file
+
| colspan="2" | A byte of data to write to the file&nbsp;
 
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
==Return value==
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
[[Variable Types|BOOL]]
+
|}
 
 
Returns true if the operation is a success, else false
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png WriteByte
Writes a single byte to the input stream 
Fc9-h32-icon.png - HANDLE FileHandle
The handle of an open file 
Fc9-u8-icon.png - BYTE Data
A byte of data to write to the file 
Fc9-bool-icon.png - BOOL Return


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