Difference between revisions of "API File.SetPos"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 18: Line 18:
 
[[Variable types|BYTE]] ''From''
 
[[Variable types|BYTE]] ''From''
 
:A location in the file to offset Address from
 
:A location in the file to offset Address from
''Typical values for this parameter:''
+
:''Typical values for this parameter:''
{| class="wikitable" width="75%"
+
::{| class="wikitable" width="65%"
 
|-
 
|-
! width="20%" |Type
 
 
! width="30%" |Name
 
! width="30%" |Name
! width="50%" |Description
+
! width="55%" |Description
 
|-
 
|-
|LONG
 
 
|Seek_Begin
 
|Seek_Begin
 
|Position offset is an absolute value
 
|Position offset is an absolute value
 
|-
 
|-
|LONG
 
 
|Seek_Curr
 
|Seek_Curr
 
|Position offset is relative to the current read/write position
 
|Position offset is relative to the current read/write position
 
|-
 
|-
|LONG
 
 
|Seek_End
 
|Seek_End
 
|Position offset is relative to the end of the file
 
|Position offset is relative to the end of the file

Revision as of 21:29, 12 May 2013

<sidebar>API contents</sidebar> Sets the position of the next read or write in the file

Class hierarchy

File

SetPos

Parameters

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
Typical values for this parameter:
Name Description
Seek_Begin Position offset is an absolute value
Seek_Curr Position offset is relative to the current read/write position
Seek_End Position offset is relative to the end of the file

Return value

This call does not return a value


Detailed description

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::File.SetPos(filehandle, address, ::File.Seek_Begin)

No additional information