GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
explain_fgetpos_or_die(3) FreeBSD Library Functions Manual explain_fgetpos_or_die(3)

explain_fgetpos_or_die - reposition a stream and report errors

#include <libexplain/fgetpos.h>

void explain_fgetpos_or_die(FILE *fp, fpos_t *pos);
int explain_fgetpos_on_error(FILE *fp, fpos_t *pos);

The explain_fgetpos_or_die function is used to call the fgetpos(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fgetpos(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

The explain_fgetpos_on_error function is used to call the fgetpos(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fgetpos(3) function, but still returns to the caller.

fp
The fp, exactly as to be passed to the fgetpos(3) system call.
pos
The pos, exactly as to be passed to the fgetpos(3) system call.

The explain_fgetpos_or_die function only returns on success, see fgetpos(3) for more information. On failure, prints an explanation and exits, it does not return.

The explain_fgetpos_on_error function always returns the value return by the wrapped fgetpos(3) system call.

The explain_fgetpos_or_die function is intended to be used in a fashion similar to the following example:
explain_fgetpos_or_die(fp, pos);

fgetpos(3)
reposition a stream
explain_fgetpos(3)
explain fgetpos(3) errors
exit(2)
terminate the calling process

libexplain version 1.3
Copyright (C) 2010 Peter Miller

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.