API File.WriteArray: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Writes an array to the file | Writes an array to the file | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:File | |||
::WriteArray | |||
</div> | |||
__TOC__ | |||
==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 | ||
| Line 14: | Line 20: | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
==Return value== | |||
[[Variable types|ULONG]] | [[Variable types|ULONG]] | ||
No additional information | No additional information | ||
==Detailed description== | |||
''No additional information'' | ''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:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.WriteArray(filehandle, _arraydata, elements)</pre> | ||
Revision as of 21:14, 11 May 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
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)