API File.SetPos: Difference between revisions

Revision as of 11:41, 16 January 2023

	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

No additional information

Examples

Calling in a calculation

Add to a calculation icon:

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

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Sets the position of the next read or write in the file
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API File|File]]
-:[[API File|SetPos]]
-</div>
-__TOC__
-==Parameters==
-[[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="65%"
 |-
-! width="30%" |Name
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-! width="55%" |Description
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPos'''
 |-
-|Seek_Begin
+| colspan="2" | Sets the position of the next read or write in the file&nbsp;
-|Position offset is an absolute value
 |-
-|Seek_Curr
-|Position offset is relative to the current read/write position
 |-
-|Seek_End
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-|Position offset is relative to the end of the file
+| 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''
 |}
-==Return value==
-''This call does not return a value''

Wiki bot (talk | contribs)

Revision as of 11:41, 16 January 2023

Detailed description

Examples

Calling in a calculation