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]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''SetPos'''
-====Class hierarchy====
+|-
-[[API File|File]]
+| colspan="2" | Sets the position of the next read or write in the file&nbsp;
-:[[API File|SetPos]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | FileHandle
-==Parameters==
+|-
-[[Variable types|HANDLE]] ''FileHandle''
+| colspan="2" | The handle of an open file&nbsp;
-:The handle of an open file
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-[[Variable types|ULONG]] ''Address''
+| width="90%" | 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="65%"
 |-
-! width="30%" |Name
+| colspan="2" | The position in the file, relative to the From position&nbsp;
-! width="55%" |Description
 |-
-|Seek_Begin
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-|Position offset is an absolute value
+| width="90%" | From
 |-
-|Seek_Curr
+| colspan="2" | A location in the file to offset Address from&nbsp;
-|Position offset is relative to the current read/write position
 |-
-|Seek_End
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
-|Position offset is relative to the end of the file
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-==Return value==
+==Detailed description==
-''This call does not return a value''
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 46: / Line 34: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::File.SetPos(filehandle, address, ::File.Seek_Begin)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation