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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Writes an array 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;" | '''WriteArray'''
 +
|-
 +
| colspan="2" | Writes an array to the input stream&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | FileHandle
 +
|-
 +
| colspan="2" | The handle of an open file&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-void-icon.png]] - ARRAY
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | An array of data to write to the file&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Elements
 +
|-
 +
| colspan="2" | Maximum number of elements to write&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
===Parameters===
+
==Detailed description==
''[[Variable types|HANDLE]] FileHandle''
 
:The handle of an open file
 
  
''[[Variable types|ARRAY]] Data''
 
:An array of data to write to the file
 
  
''[[Variable types|ULONG]] Elements''
 
:Maximum number of elements to write
 
:''The default value for this parameter is: '''''-1'''
 
  
===Return value===
+
==Examples==
[[Variable types|ULONG]]
+
===Calling in a calculation===
 
 
No additional information
 
 
 
===Detailed description===
 
''No additional information''
 
 
 
===Examples===
 
====Calling in a calculation====
 
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
* Add to a calculation icon: <pre class="brush:[C]">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>

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png WriteArray
Writes an array to the input stream 
Fc9-h32-icon.png - HANDLE FileHandle
The handle of an open file 
Fc9-void-icon.png - ARRAY Data
An array of data to write to the file 
Fc9-u32-icon.png - ULONG Elements
Maximum number of elements to write 
Fc9-u32-icon.png - ULONG Return


Detailed description

Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon:
    result = ::File.Buffer.WriteArray(filehandle, _arraydata, elements)