Difference between revisions of "API File.Buffer.WriteByte"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Writes a single byte to the input stream | Writes a single byte to the input stream | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
− | ===Class hierarchy===[[API File|File]] | + | ====Class hierarchy==== |
+ | [[API File|File]] | ||
:[[API File.Buffer|Buffer]] | :[[API File.Buffer|Buffer]] | ||
::[[API File.Buffer|WriteByte]] | ::[[API File.Buffer|WriteByte]] | ||
Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
− | + | [[Variable Types|HANDLE]] ''FileHandle'' | |
:The handle of an open file | :The handle of an open file | ||
− | + | [[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 | + | [[Variable Types|BOOL]] |
+ | |||
+ | Returns true if the operation is a success, else false | ||
− | |||
==Detailed description== | ==Detailed description== | ||
− | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
+ | |||
==Examples== | ==Examples== | ||
Line 28: | Line 32: | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* 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 examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Writes a single byte to the input stream
Contents
Parameters
HANDLE FileHandle
- The handle of an open file
BYTE Data
- A byte of data to write to the file
Return value
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