2 * Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2001 Internet Software Consortium.
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: rcode.h,v 1.21 2008/09/25 04:02:39 tbox Exp $ */
23 /*! \file dns/rcode.h */
27 #include <dns/types.h>
31 isc_result_t dns_rcode_fromtext(dns_rcode_t *rcodep, isc_textregion_t *source);
33 * Convert the text 'source' refers to into a DNS error value.
36 *\li 'rcodep' is a valid pointer.
38 *\li 'source' is a valid text region.
41 *\li #ISC_R_SUCCESS on success
42 *\li #DNS_R_UNKNOWN type is unknown
45 isc_result_t dns_rcode_totext(dns_rcode_t rcode, isc_buffer_t *target);
47 * Put a textual representation of error 'rcode' into 'target'.
50 *\li 'rcode' is a valid rcode.
52 *\li 'target' is a valid text buffer.
55 *\li If the result is success:
56 * The used space in 'target' is updated.
59 *\li #ISC_R_SUCCESS on success
60 *\li #ISC_R_NOSPACE target buffer is too small
63 isc_result_t dns_tsigrcode_fromtext(dns_rcode_t *rcodep,
64 isc_textregion_t *source);
66 * Convert the text 'source' refers to into a TSIG/TKEY error value.
69 *\li 'rcodep' is a valid pointer.
71 *\li 'source' is a valid text region.
74 *\li #ISC_R_SUCCESS on success
75 *\li #DNS_R_UNKNOWN type is unknown
78 isc_result_t dns_tsigrcode_totext(dns_rcode_t rcode, isc_buffer_t *target);
80 * Put a textual representation of TSIG/TKEY error 'rcode' into 'target'.
83 *\li 'rcode' is a valid TSIG/TKEY error code.
85 *\li 'target' is a valid text buffer.
88 *\li If the result is success:
89 * The used space in 'target' is updated.
92 *\li #ISC_R_SUCCESS on success
93 *\li #ISC_R_NOSPACE target buffer is too small
97 dns_hashalg_fromtext(unsigned char *hashalg, isc_textregion_t *source);
99 * Convert the text 'source' refers to into a has algorithm value.
102 *\li 'hashalg' is a valid pointer.
104 *\li 'source' is a valid text region.
107 *\li #ISC_R_SUCCESS on success
108 *\li #DNS_R_UNKNOWN type is unknown
113 #endif /* DNS_RCODE_H */