malloc-h: New module.
[gnulib.git] / lib / c-xvasprintf.h
blob238bcf3c8bf57829b2d5781433a2ecd224fc1a54
1 /* vasprintf and asprintf, with out-of-memory checking, in C locale.
2 Copyright (C) 2002-2004, 2006-2020 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <https://www.gnu.org/licenses/>. */
17 #ifndef _C_XVASPRINTF_H
18 #define _C_XVASPRINTF_H
20 /* Get va_list. */
21 #include <stdarg.h>
23 /* Get _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD. */
24 #include <stdio.h>
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
30 /* Write formatted output to a string dynamically allocated with malloc(),
31 and return it. Upon [ENOMEM] memory allocation error, call xalloc_die.
32 On some other error
33 - [EOVERFLOW] resulting string length is > INT_MAX,
34 - [EINVAL] invalid format string,
35 - [EILSEQ] error during conversion between wide and multibyte characters,
36 return NULL.
38 Formatting takes place in the C locale, that is, the decimal point
39 used in floating-point formatting directives is always '.'. */
40 extern char *c_xasprintf (const char *format, ...)
41 _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 1, 2));
42 extern char *c_xvasprintf (const char *format, va_list args)
43 _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 1, 0));
45 #ifdef __cplusplus
47 #endif
49 #endif /* _C_XVASPRINTF_H */