1135446Strhodes/*
2193149Sdougb * Copyright (C) 2004-2007  Internet Systems Consortium, Inc. ("ISC")
3135446Strhodes * Copyright (C) 2002  Internet Software Consortium.
4135446Strhodes *
5193149Sdougb * Permission to use, copy, modify, and/or distribute this software for any
6135446Strhodes * purpose with or without fee is hereby granted, provided that the above
7135446Strhodes * copyright notice and this permission notice appear in all copies.
8135446Strhodes *
9135446Strhodes * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10135446Strhodes * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11135446Strhodes * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12135446Strhodes * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13135446Strhodes * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14135446Strhodes * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15135446Strhodes * PERFORMANCE OF THIS SOFTWARE.
16135446Strhodes */
17135446Strhodes
18234010Sdougb/* $Id: opcode.h,v 1.8 2007/06/19 23:47:17 tbox Exp $ */
19135446Strhodes
20135446Strhodes#ifndef DNS_OPCODE_H
21135446Strhodes#define DNS_OPCODE_H 1
22135446Strhodes
23193149Sdougb/*! \file dns/opcode.h */
24170222Sdougb
25135446Strhodes#include <isc/lang.h>
26135446Strhodes
27135446Strhodes#include <dns/types.h>
28135446Strhodes
29135446StrhodesISC_LANG_BEGINDECLS
30135446Strhodes
31135446Strhodesisc_result_t dns_opcode_totext(dns_opcode_t opcode, isc_buffer_t *target);
32170222Sdougb/*%<
33135446Strhodes * Put a textual representation of error 'opcode' into 'target'.
34135446Strhodes *
35135446Strhodes * Requires:
36170222Sdougb *\li	'opcode' is a valid opcode.
37135446Strhodes *
38170222Sdougb *\li	'target' is a valid text buffer.
39135446Strhodes *
40135446Strhodes * Ensures:
41170222Sdougb *\li	If the result is success:
42135446Strhodes *		The used space in 'target' is updated.
43135446Strhodes *
44135446Strhodes * Returns:
45170222Sdougb *\li	#ISC_R_SUCCESS			on success
46170222Sdougb *\li	#ISC_R_NOSPACE			target buffer is too small
47135446Strhodes */
48135446Strhodes
49135446StrhodesISC_LANG_ENDDECLS
50135446Strhodes
51135446Strhodes#endif /* DNS_OPCODE_H */
52