Difference between revisions of "API File.SetPos"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(8 intermediate revisions by 3 users not shown)
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
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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
+
|-
−
 
+
| colspan="2" | The position in the file, relative to the From position&nbsp;
−
[[Variable types|BYTE]] ''From''
+
|-
−
:A location in the file to offset Address from
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
''Typical values for this parameter:''
+
| width="90%" | From
−
{| class="wikitable" |-width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Seek_Begin|0
+
|-
−
|-LONG|Seek_Curr|1
+
| colspan="2" | A location in the file to offset Address from&nbsp;
−
|-LONG|Seek_End|2
+
|-
 +
| 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''
 
  
 +
==Detailed description==
  
−
==Detailed description==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 35: Line 34:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::File.SetPos(filehandle, address, ::File.Seek_Begin)</pre>
 
* 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>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png SetPos
Sets the position of the next read or write in the file 
Fc9-h32-icon.png - HANDLE FileHandle
The handle of an open file 
Fc9-u32-icon.png - ULONG Address
The position in the file, relative to the From position 
Fc9-u8-icon.png - BYTE From
A location in the file to offset Address from 
Fc9-void-icon.png - NONE Return


Detailed description

Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::File.SetPos(filehandle, address, ::File.Seek_Begin)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_File.SetPos&oldid=30304"