bind9/lib/isc/include/isc/parseint.h
2016-06-27 14:56:38 +10:00

55 lines
1.5 KiB
C

/*
* Copyright (C) 2001, 2002, 2004-2007, 2016 Internet Systems Consortium, Inc. ("ISC")
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
/* $Id: parseint.h,v 1.9 2007/06/19 23:47:18 tbox Exp $ */
#ifndef ISC_PARSEINT_H
#define ISC_PARSEINT_H 1
#include <isc/lang.h>
#include <isc/types.h>
/*! \file isc/parseint.h
* \brief Parse integers, in a saner way than atoi() or strtoul() do.
*/
/***
*** Functions
***/
ISC_LANG_BEGINDECLS
isc_result_t
isc_parse_uint32(isc_uint32_t *uip, const char *string, int base);
isc_result_t
isc_parse_uint16(isc_uint16_t *uip, const char *string, int base);
isc_result_t
isc_parse_uint8(isc_uint8_t *uip, const char *string, int base);
/*%<
* Parse the null-terminated string 'string' containing a base 'base'
* integer, storing the result in '*uip'.
* The base is interpreted
* as in strtoul(). Unlike strtoul(), leading whitespace, minus or
* plus signs are not accepted, and all errors (including overflow)
* are reported uniformly through the return value.
*
* Requires:
*\li 'string' points to a null-terminated string
*\li 0 <= 'base' <= 36
*
* Returns:
*\li #ISC_R_SUCCESS
*\li #ISC_R_BADNUMBER The string is not numeric (in the given base)
*\li #ISC_R_RANGE The number is not representable as the requested type.
*/
ISC_LANG_ENDDECLS
#endif /* ISC_PARSEINT_H */