Jump to content

API File.Buffer.WriteByte: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import of API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
Writes a single byte to the input stream
Writes a single byte to the input stream


<div style="width:25%; float:right" class="toc">
===Class hierarchy===
:File
::Buffer
:::WriteByte
</div>
__TOC__


===Parameters===
==Parameters==
''[[Variable types|HANDLE]] FileHandle''
''[[Variable types|HANDLE]] FileHandle''
:The handle of an open file
:The handle of an open file
Line 10: Line 17:
: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]]


No additional information
No additional information


===Detailed description===
==Detailed description==
''No additional information''
''No additional information''


===Examples===
==Examples==
====Calling in a calculation====
===Calling in a calculation===
* Declare a variable 'result' of type BOOL
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: <pre class="brush:[C]">result = ::File.Buffer.WriteByte(filehandle, data)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.WriteByte(filehandle, data)</pre>

Revision as of 21:14, 11 May 2013

<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

No additional information

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)