1.\" $NetBSD: efun.3,v 1.11 2015/01/18 18:09:36 christos Exp $ 2.\" 3.\" Copyright (c) 2006 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Christos Zoulas. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd May 3, 2010 31.Dt EFUN 3 32.Os 33.Sh NAME 34.Nm esetfunc , 35.Nm easprintf , 36.Nm efopen , 37.Nm emalloc , 38.Nm ecalloc , 39.Nm erealloc , 40.Nm estrdup , 41.Nm estrndup , 42.Nm estrlcat , 43.Nm estrlcpy , 44.Nm estrtoi , 45.Nm estrtou , 46.Nm evasprintf 47.Nd error-checked utility functions 48.Sh LIBRARY 49.Lb libutil 50.Sh SYNOPSIS 51.In util.h 52.Ft void (*)(int, const char *, ...) 53.Fn esetfunc "void (*)(int, const char *, ...)" 54.Ft int 55.Fn easprintf "char ** restrict str" "const char * restrict fmt" "..." 56.Ft FILE * 57.Fn efopen "const char *p" "const char *m" 58.Ft void * 59.Fn ecalloc "size_t n" "size_t c" 60.Ft void * 61.Fn emalloc "size_t n" 62.Ft void * 63.Fn erealloc "void *p" "size_t n" 64.Ft char * 65.Fn estrdup "const char *s" 66.Ft char * 67.Fn estrndup "const char *s" "size_t len" 68.Ft size_t 69.Fn estrlcat "char *dst" "const char *src" "size_t len" 70.Ft size_t 71.Fn estrlcpy "char *dst" "const char *src" "size_t len" 72.Ft intmax_t 73.Fn estrtoi "const char * nptr" "int base" "intmax_t lo" "intmax_t hi" 74.Ft uintmax_t 75.Fn estrtou "const char * nptr" "int base" "uintmax_t lo" "uintmax_t hi" 76.Ft int 77.Fn evasprintf "char ** restrict str" "const char * restrict fmt" "..." 78.Sh DESCRIPTION 79The 80.Fn easprintf , 81.Fn efopen , 82.Fn ecalloc , 83.Fn emalloc , 84.Fn erealloc , 85.Fn estrdup , 86.Fn estrndup , 87.Fn estrlcat , 88.Fn estrlcpy , 89.Fn estrtoi , 90.Fn estrtou , 91and 92.Fn evasprintf 93functions 94operate exactly as the corresponding functions that do not start with an 95.Sq e 96except that in case of an error, they call 97the installed error handler that can be configured with 98.Fn esetfunc . 99.Pp 100For the string handling functions, it is an error when the destination 101buffer is not large enough to hold the complete string. 102For functions that allocate memory or open a file, it is an error when 103they would return a null pointer. 104The default error handler is 105.Xr err 3 . 106The function 107.Fn esetfunc 108returns the previous error handler function. 109A 110.Dv NULL 111error handler will just call 112.Xr exit 3 . 113.Sh SEE ALSO 114.Xr asprintf 3 , 115.Xr calloc 3 , 116.Xr err 3 , 117.Xr exit 3 , 118.Xr fopen 3 , 119.Xr malloc 3 , 120.Xr realloc 3 , 121.Xr strdup 3 , 122.Xr strlcat 3 , 123.Xr strlcpy 3 , 124.Xr strndup 3 , 125.Xr strtoi 3 , 126.Xr strtou 3 , 127.Xr vasprintf 3 128.Sh HISTORY 129The 130.Fn estrtoi 131and 132.Fn estrtou 133functions were added in 134.Nx 8 . 135