fsetpos
Sets the stream-position indicator.
Syntax
int fsetpos(
FILE *stream,
const fpos_t *pos
);
Parameters
stream
Pointer to FILE
structure.
pos
Position-indicator storage.
Return value
If successful, fsetpos
returns 0. On failure, the function returns a nonzero value and sets errno
to one of the following manifest constants (defined in ERRNO.H): EBADF
, which means the file isn't accessible or the object that stream
points to isn't a valid file structure; or EINVAL
, which means an invalid value for stream
or pos
was passed. If an invalid parameter is passed in, these functions invoke the invalid parameter handler, as described in Parameter validation.
For more information about return codes, see errno
, _doserrno
, _sys_errlist
, and _sys_nerr
.
Remarks
The fsetpos
function sets the file-position indicator for stream
to the value of pos
, which is obtained in a prior call to fgetpos
against stream
. The function clears the end-of-file indicator and undoes any effects of ungetc
on stream
. After a call to fsetpos
, the next operation on stream
may be either input or output.
By default, this function's global state is scoped to the application. To change this behavior, see Global state in the CRT.
Requirements
Function | Required header |
---|---|
fsetpos |
<stdio.h> |
For more compatibility information, see Compatibility.
Example
See the example for fgetpos
.