1explain_ftell_or_die(3) Library Functions Manual explain_ftell_or_die(3)
2
3
4
6 explain_ftell_or_die - get stream position and report errors
7
9 #include <libexplain/ftell.h>
10 long explain_ftell_or_die(FILE *fp);
11 long explain_ftell_on_error(FILE *fp);
12
14 The explain_ftell_or_die function is used to call the ftell(3) system
15 call. On failure an explanation will be printed to stderr, obtained
16 from the explain_ftell(3) function, and then the process terminates by
17 calling exit(EXIT_FAILURE).
18
19 The explain_ftell_on_error function is used to call the ftell(3) system
20 call. On failure an explanation will be printed to stderr, obtained
21 from the explain_ftell(3) function, but still returns to the caller.
22
23 fp The fp, exactly as to be passed to the ftell(3) system call.
24
26 The explain_ftell_or_die function only returns on success, see ftell(3)
27 for more information. On failure, prints an explanation and exits, it
28 does not return.
29
30 The explain_ftell_on_error function always returns the value return by
31 the wrapped ftell(3) system call.
32
34 The explain_ftell_or_die function is intended to be used in a fashion
35 similar to the following example:
36 long result = explain_ftell_or_die(fp);
37
39 ftell(3)
40 get stream position
41
42 explain_ftell(3)
43 explain ftell(3) errors
44
45 exit(2) terminate the calling process
46
48 libexplain version 1.4
49 Copyright (C) 2010 Peter Miller
50
51
52
53 explain_ftell_or_die(3)