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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
 
Writes an array to the input stream
 
Writes an array to the input stream
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API File|File]]
 +
:[[API File.Buffer|Buffer]]
 +
::[[API File.Buffer|WriteArray]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] FileHandle''
+
[[Variable Types|HANDLE]] ''FileHandle''
 
:The handle of an open file
 
:The handle of an open file
  
''[[Variable types|ARRAY]] Data''
+
[[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''
+
[[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'''
  
===Return value===
 
[[Variable types|ULONG]]
 
  
No additional information
+
==Return value==
 +
[[Variable Types|ULONG]]
  
===Detailed description===
+
''<span style="color:red;">No additional information</span>''
''No additional information''
 
  
===Examples===
+
 
====Calling in a calculation====
+
==Detailed description==
 +
''<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.Buffer.WriteArray(filehandle, _arraydata, elements)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.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 input stream

Class hierarchy

File

Buffer
WriteArray

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

ULONG

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 examples