Difference between revisions of "API File.WriteArray"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''FileHandle''
+
[[Variable Types|HANDLE]] ''FileHandle''
 
:The handle of a file to write to
 
:The handle of a file to write to
  
[[Variable types|ARRAY]] ''Data''
+
[[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''
+
[[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'''
Line 22: Line 22:
  
 
==Return value==
 
==Return value==
[[Variable types|ULONG]]
+
[[Variable Types|ULONG]]
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''

Revision as of 11:09, 10 June 2013

<sidebar>API contents</sidebar> Writes an array to the file

Class hierarchy

File

WriteArray

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

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.WriteArray(filehandle, _arraydata, elements)

No additional information