====== fseek ======

===== Description =====

Reposition a file file handle within a file stream.

===== Function prototype =====

<code>
bool fseek <voidptr:hFile> <int64:Offset> <int:Origin>
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hFile//  |  voidptr  | A handle to an open file. |
|  //Offset//  |  int64  | Number of bytes to offset from //Origin//. |
|  //Origin//  |  int  | Position from where //Offset// is added. Supported values are 0 (SEEK_SET), 1 (SEEK_CUR) and 2 (SEEK_END). Please refer to [[http://www.cplusplus.com/reference/clibrary/cstdio/fseek/|C++ fseek documentation]] for more information.  |

===== Return value =====

True if success, false otherwise.

===== Example =====

<code>
// open a file, fseek forward, then ftell position

// open file
voidptr fp
assert <zs:fopen_s fp "C:\\test.txt" "r"> "Could not open file!"

// fseek to 10
assert <zs:fseek fp 10 0> "Fseek failed!"
echo <zs:ftell fp> // should be at 10 now

// close
fclose fp
</code>

... the output of which is written to the event log by [[plugins:general:zeoscript:reference:functions:echo]] as:

<file>
10
</file>

===== Comments =====

None.


===== See also =====

  * [[plugins:general:zeoscript:reference:functions:fopen]]
  * [[plugins:general:zeoscript:reference:functions:fopen_s]]
  * [[plugins:general:zeoscript:reference:functions:fclose]]
  * [[plugins:general:zeoscript:reference:functions:fread]]
  * [[plugins:general:zeoscript:reference:functions:fwrite]]
  * [[plugins:general:zeoscript:reference:functions:fgetc]]
  * [[plugins:general:zeoscript:reference:functions:fputc]]
  * [[plugins:general:zeoscript:reference:functions:rewind]]
  * [[plugins:general:zeoscript:reference:functions:ftell]]