Difference between revisions of "API File.Buffer.WriteArray"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
Line 3: | Line 3: | ||
<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|WriteArray]] | ::[[API File.Buffer|WriteArray]] | ||
Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
− | + | [[Variable types|HANDLE]] ''FileHandle'' | |
:The handle of an open file | :The handle of an open file | ||
− | + | [[Variable types|ARRAY]] ''Data'' | |
:An array of data to write to the file | :An array of data to write to the file | ||
− | + | [[Variable types|ULONG]] ''Elements'' | |
:Maximum number of elements to write | :Maximum number of elements to write | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
Line 23: | Line 24: | ||
[[Variable types|ULONG]] | [[Variable types|ULONG]] | ||
− | No additional information | + | ''<span style="color:red;">No additional information</span>'' |
+ | |||
+ | |||
==Detailed description== | ==Detailed description== | ||
− | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
+ | |||
==Examples== | ==Examples== | ||
Line 32: | Line 36: | ||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.WriteArray(filehandle, _arraydata, elements)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.WriteArray(filehandle, _arraydata, elements)</pre> | ||
+ | |||
+ | ''<span style="color:red;">No additional information</span>'' |
Revision as of 22:11, 11 May 2013
<sidebar>API contents</sidebar> Writes an array to the input stream
Contents
Parameters
HANDLE FileHandle
- The handle of an open file
ARRAY Data
- An array of data to write to the file
ULONG Elements
- Maximum number of elements to write
- The default value for this parameter is: -1
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::File.Buffer.WriteArray(filehandle, _arraydata, elements)
No additional information