API Reference / File IO / fileSeekFile

fileSeekFile

Sets the file position to a specific byte offset. Takes a file handle and byte position (0-based). Returns nothing (void).

File IO

Parameters & Returns

Parameters

fileHandle Int
pos Int

Returns

Void

Quick Summary

Sets the file position to a specific byte offset. Takes a file handle and byte position (0-based). Returns nothing (void).

Technical Exegesis...

Sets the current file position to the specified byte offset from the beginning of the file. Does nothing if the handle is invalid.

The position is 0-based (position 0 is the first byte). Use this to jump to specific locations in a file for reading or writing. Seeking beyond the end of the file is allowed and may extend the file when writing.

Example

Example.bam 
; No example implemented yet
Since: 1.0 Status: Stable
← Back to File IO