2 * Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1998-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: rdatatype.h,v 1.26 2008/09/25 04:02:39 tbox Exp $ */
20 #ifndef DNS_RDATATYPE_H
21 #define DNS_RDATATYPE_H 1
23 /*! \file dns/rdatatype.h */
27 #include <dns/types.h>
32 dns_rdatatype_fromtext(dns_rdatatype_t *typep, isc_textregion_t *source);
34 * Convert the text 'source' refers to into a DNS rdata type.
37 *\li 'typep' is a valid pointer.
39 *\li 'source' is a valid text region.
42 *\li ISC_R_SUCCESS on success
43 *\li DNS_R_UNKNOWN type is unknown
47 dns_rdatatype_totext(dns_rdatatype_t type, isc_buffer_t *target);
49 * Put a textual representation of type 'type' into 'target'.
52 *\li 'type' is a valid type.
54 *\li 'target' is a valid text buffer.
57 * if the result is success:
58 *\li The used space in 'target' is updated.
61 *\li #ISC_R_SUCCESS on success
62 *\li #ISC_R_NOSPACE target buffer is too small
66 dns_rdatatype_format(dns_rdatatype_t rdtype,
67 char *array, unsigned int size);
69 * Format a human-readable representation of the type 'rdtype'
70 * into the character array 'array', which is of size 'size'.
71 * The resulting string is guaranteed to be null-terminated.
74 #define DNS_RDATATYPE_FORMATSIZE sizeof("NSEC3PARAM")
77 * Minimum size of array to pass to dns_rdatatype_format().
78 * May need to be adjusted if a new RR type with a very long
84 #endif /* DNS_RDATATYPE_H */