Doxygen file headers for most files
[disorder] / lib / basen.h
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2005, 2007, 2008 Richard Kettlewell
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18 /** @file lib/basen.h @brief Arbitrary base conversion */
19 #ifndef BASEN_H
20 #define BASEN_H
21
22 int basen(unsigned long *v,
23 int nwords,
24 char buffer[],
25 size_t bufsize,
26 unsigned base);
27 /* convert the big-endian value at @v@ composed of @nwords@ 32-bit words
28 * into a base-@base@ string and store in @buffer@.
29 * Returns 0 on success or -1 on overflow.
30 */
31
32 #endif /* BASEN_H */
33
34 /*
35 Local Variables:
36 c-basic-offset:2
37 comment-column:40
38 End:
39 */