- stream
- FILE stream to retreive the current file position for.
- pos
- Where to store the current file position.
Returns 0 if successful; otherwise -1 is returned and Stdlib.GetLastError indicates the error.
Usage
The following errors are specified:
Error Details Errno.EBADF The stream argument is not not a seekable stream Errno.EINVAL The whence argument is invalid or the resulting file-position indicator would be set to a negative value. Errno.EOVERFLOW The resulting file offset would be a value which cannot be represented correctly in an object of type stem.Int64 for Stdlib.fseek() and Stdlib.ftell(). Errno.ESPIPE The file descriptor underlying stream is associated with a pipe or FIFO or file-position indicator value is unspecified (see Stdlib.ungetc(3)). fgetpos may also fail for any of the error specified for the routines Stdlib.fflush(3), Syscall.fstat(2), Syscall.lseek(2), and Stdlib.malloc(3)
The fgetpos() is an alternate interfaces for retrieving the current position in the file, similar to Stdlib.ftell(), except that the current position is stored in an opaque object of type Mono.Unix.Native.FilePosition pointed to by pos. This provides a portable way to seek to offsets larger than those that can be represented by a long int. They may also store additional state information in the Mono.Unix.Native.FilePosition object to facilitate seeking within files containing multibyte characters with state-dependent encodings.