API File.NVM.WriteArray: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	WriteArray
Writes an array to the NVM
- HANDLE	FileHandle
The handle of an open file
- ULONG	Address
Position in the file in bytes
- ARRAY	Data
Array of data to write to the file
- ULONG	Elements
Maximum number of elements to write
- ULONG	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type ULONG

Add to a calculation icon:

result = ::File.NVM.WriteArray(filehandle, address, _arraydata, elements)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Writes an array to the NVM
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''WriteArray'''
+|-
+| colspan="2" | Writes an array to the NVM&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-u32-icon.png]] - ULONG
+| width="90%" | Address
+|-
+| colspan="2" | Position in the file in bytes&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-void-icon.png]] - ARRAY
+| width="90%" | Data
+|-
+| colspan="2" | 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|ULONG]] Address''
-:Position in the file in bytes
-''[[Variable types|ARRAY]] Data''
-:Array of data to write to the file
-''[[Variable types|ULONG]] Elements''
+==Examples==
-:Maximum number of elements to write
+===Calling in a calculation===
-:''The default value for this parameter is: '''''-1'''
-===Return value===
-[[Variable types|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.NVM.WriteArray(filehandle, address, _arraydata, elements)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.WriteArray(filehandle, address, _arraydata, elements)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation