1 | .\" Copyright (c) 2001, 2003 Kungliga Tekniska Högskolan
|
---|
2 | .\" (Royal Institute of Technology, Stockholm, Sweden).
|
---|
3 | .\" All rights reserved.
|
---|
4 | .\"
|
---|
5 | .\" Redistribution and use in source and binary forms, with or without
|
---|
6 | .\" modification, are permitted provided that the following conditions
|
---|
7 | .\" are met:
|
---|
8 | .\"
|
---|
9 | .\" 1. Redistributions of source code must retain the above copyright
|
---|
10 | .\" notice, this list of conditions and the following disclaimer.
|
---|
11 | .\"
|
---|
12 | .\" 2. Redistributions in binary form must reproduce the above copyright
|
---|
13 | .\" notice, this list of conditions and the following disclaimer in the
|
---|
14 | .\" documentation and/or other materials provided with the distribution.
|
---|
15 | .\"
|
---|
16 | .\" 3. Neither the name of the Institute nor the names of its contributors
|
---|
17 | .\" may be used to endorse or promote products derived from this software
|
---|
18 | .\" without specific prior written permission.
|
---|
19 | .\"
|
---|
20 | .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
---|
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
---|
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
---|
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
---|
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
---|
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
---|
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
---|
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
---|
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
---|
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
---|
30 | .\" SUCH DAMAGE.
|
---|
31 | .\" $Id$
|
---|
32 | .\"
|
---|
33 | .Dd August 14, 2003
|
---|
34 | .Dt ECALLOC 3
|
---|
35 | .Os HEIMDAL
|
---|
36 | .Sh NAME
|
---|
37 | .Nm ecalloc ,
|
---|
38 | .Nm emalloc ,
|
---|
39 | .Nm eread ,
|
---|
40 | .Nm erealloc ,
|
---|
41 | .Nm esetenv ,
|
---|
42 | .Nm estrdup ,
|
---|
43 | .Nm ewrite
|
---|
44 | .Nd exit-on-failure wrapper functions
|
---|
45 | .Sh LIBRARY
|
---|
46 | The roken library (libroken, -lroken)
|
---|
47 | .Sh SYNOPSIS
|
---|
48 | .Fd #include <roken.h>
|
---|
49 | .Ft "void *"
|
---|
50 | .Fn ecalloc "size_t number" "size_t size"
|
---|
51 | .Ft "void *"
|
---|
52 | .Fn emalloc "size_t sz"
|
---|
53 | .Ft ssize_t
|
---|
54 | .Fn eread "int fd" "void *buf" "size_t nbytes"
|
---|
55 | .Ft "void *"
|
---|
56 | .Fn erealloc "void *ptr" "size_t sz"
|
---|
57 | .Ft void
|
---|
58 | .Fn esetenv "const char *var" "const char *val" "int rewrite"
|
---|
59 | .Ft "char *"
|
---|
60 | .Fn estrdup "const char *str"
|
---|
61 | .Ft ssize_t
|
---|
62 | .Fn ewrite "int fd" "const void *buf" "size_t nbytes"
|
---|
63 | .Sh DESCRIPTION
|
---|
64 | These functions do the same as the ones without the
|
---|
65 | .Dq e
|
---|
66 | prefix, but if there is an error they will print a message with
|
---|
67 | .Xr errx 3 ,
|
---|
68 | and exit. For
|
---|
69 | .Nm eread
|
---|
70 | and
|
---|
71 | .Nm ewrite
|
---|
72 | this is also true for partial data.
|
---|
73 | .Pp
|
---|
74 | This is useful in applications when there is no need for a more
|
---|
75 | advanced failure mode.
|
---|
76 | .Sh SEE ALSO
|
---|
77 | .Xr read 2 ,
|
---|
78 | .Xr write 2 ,
|
---|
79 | .Xr calloc 3 ,
|
---|
80 | .Xr errx 3 ,
|
---|
81 | .Xr malloc 3 ,
|
---|
82 | .Xr realloc 3 ,
|
---|
83 | .Xr setenv 3 ,
|
---|
84 | .Xr strdup 3
|
---|