====== rewind ======

===== Description =====

Rewind a file handle to the start of the file stream.

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

<code>
void rewind <voidptr:hFile>
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hFile//  |  voidptr  | A file handle, as created by [[plugins:general:zeoscript:reference:functions:fopen]] or [[plugins:general:zeoscript:reference:functions:fopen_s]].  |

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

None.

===== Example =====

<code>
// open a file, fseek forward, then rewind

// 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

// rewind
rewind fp
echo <zs:ftell fp> // should be back at 0

// close
fclose fp
</code>

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

<file>
10
0
</file>

===== Comments =====

This function is equivalent to calling '[[plugins:general:zeoscript:reference:functions:fseek]] 0 0'.


===== 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:fseek]]
  * [[plugins:general:zeoscript:reference:functions:ftell]]