Difference between revisions of "API File.WriteArray"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Writes an array to the file | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API File|File]] | ||
| + | :[[API File|WriteArray]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''FileHandle'' | |
:The handle of a file to write to | :The handle of a file to write to | ||
| − | + | [[Variable Types|ARRAY]] ''Data'' | |
:An array of some type to write to the file | :An array of some type to write to the file | ||
| − | + | [[Variable Types|ULONG]] ''Elements'' | |
:Maximum number of array elements to write | :Maximum number of array elements to write | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| − | |||
| − | |||
| − | No additional information | + | ==Return value== |
| + | [[Variable Types|ULONG]] | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
| + | |||
| − | + | ==Detailed description== | |
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| − | + | ||
| − | + | ==Examples== | |
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
| − | * Add to a calculation icon: result = ::File.WriteArray(filehandle, _arraydata, elements) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.WriteArray(filehandle, _arraydata, elements)</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Writes an array to the file
Contents
Parameters
HANDLE FileHandle
- The handle of a file to write to
ARRAY Data
- An array of some type to write to the file
ULONG Elements
- Maximum number of array 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.WriteArray(filehandle, _arraydata, elements)
No additional examples
