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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
wiki page name
+
{| 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]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteByte'''
 +
|-
 +
| colspan="2" | Writes a single byte to the input stream 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | FileHandle
 +
|-
 +
| colspan="2" | The handle of an open file 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | A byte of data to write to the file 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
===Parameters===
+
==Detailed description==
''[[Variable types|HANDLE]] FileHandle''
 
:The handle of an open file
 
  
''[[Variable types|BYTE]] Data''
 
:A byte of data to write to the file
 
  
===Return value===
 
[[Variable types|BOOL]]
 
  
No additional information
+
==Examples==
 
+
===Calling in a calculation===
===Detailed description===
 
''No additional information''
 
 
 
===Examples===
 
====Calling in a calculation====
 
 
* Declare a variable 'result' of type BOOL
 
* 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>

Latest revision as of 11:55, 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

Examples

Calling in a calculation

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