Function Reference

FileGetPos

Retrieves the current file position.

FileGetPos ( "filehandle" )

Parameters

filehandle The handle of a file, as returned by a previous call to FileOpen.

Return Value

Success: Returns the position offset from the beginning of the file (First index is 0).
Failure: Returns 0 and sets @error.

Remarks

Failure returns 0 but 0 is also a valid file position so check @error to determine error conditions.

Related

FileSetPos, FileRead, FileReadLine, FileWrite, FileWriteLine, FileOpen

Example


#include <Constants.au3>

Local Const $sFile = "test.txt"
Local $hFile = FileOpen($sFile, 2)

; Check if file opened for writing OK
If $hFile = -1 Then
    MsgBox(0, "Error", "Unable to open file.")
    Exit
EndIf

; Write something to the file.
FileWriteLine($hFile, "Line1")
FileWriteLine($hFile, "Line2")
FileWriteLine($hFile, "Line3")

; Flush the file to disk.
FileFlush($hFile)

; Check file position and try to read contents for current position.
MsgBox(0, "", "Position: " & FileGetPos($hFile) & @CRLF & "Data: " & @CRLF & FileRead($hFile))

; Now, adjust the position to the beginning.
Local $n = FileSetPos($hFile, 0, $FILE_BEGIN)

; Check file position and try to read contents for current position.
MsgBox(0, "", "Position: " & FileGetPos($hFile) & @CRLF & "Data: " & @CRLF & FileRead($hFile))

; Close the handle.
FileClose($hFile)

; Clean up the temporary file.
FileDelete($sFile)