API File.SetPos: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetPos
Sets the position of the next read or write in the file
- HANDLE	FileHandle
The handle of an open file
- ULONG	Address
The position in the file, relative to the From position
- BYTE	From
A location in the file to offset Address from
- NONE	Return

Detailed description

Examples

Calling in a calculation

Add to a calculation icon:

::File.SetPos(filehandle, address, ::File.Seek_Begin)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets 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" | '''SetPos'''
+|-
+| colspan="2" | Sets 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" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Address
+|-
+| colspan="2" | The position in the file, relative to the From position&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | From
+|-
+| colspan="2" | A location in the file to offset Address from&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API File|File]]
-:[[API File|SetPos]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] FileHandle''
-:The handle of an open file
-''[[Variable types|ULONG]] Address''
-:The position in the file, relative to the From position
-''[[Variable types|BYTE]] From''
-:A location in the file to offset Address from
-''Typical values for this parameter:''
-{| class="wikitable" |+width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Seek_Begin|0
-|-LONG|Seek_Curr|1
-|-LONG|Seek_End|2
-|}
-==Return value==
-''This call does not return a value''
-==Detailed description==
-''No additional information''
 ==Examples==
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::File.SetPos(filehandle, address, ::File.Seek_Begin)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation