API File.GetPos: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetPos
Gets the position of the next read or write in the file
- HANDLE	FileHandle
The handle of an open file
- ULONG	Return

@@ Line 1: / Line 1: @@
-API contents
+{| class="mtx-class-macrotable wikitable"
-Gets the position of the next read or write in the file
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetPos'''
+|-
+| colspan="2" | Gets the position of the next read or write in the file&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" 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
-===Return value===
-[[Variable types|ULONG]]
-Returns the position of the next read or write in the file
-===Detailed description===
+==Examples==
-''No additional information''
+===Calling in a calculation===
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type ULONG
-* Add to a calculation icon: result = ::File.GetPos(filehandle)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.GetPos(filehandle)</pre>