xref: /netbsd-src/external/mpl/bind/dist/lib/dns/include/dns/opcode.h (revision bcda20f65a8566e103791ec395f7f499ef322704)
1 /*	$NetBSD: opcode.h,v 1.7 2025/01/26 16:25:28 christos Exp $	*/
2 
3 /*
4  * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
5  *
6  * SPDX-License-Identifier: MPL-2.0
7  *
8  * This Source Code Form is subject to the terms of the Mozilla Public
9  * License, v. 2.0. If a copy of the MPL was not distributed with this
10  * file, you can obtain one at https://mozilla.org/MPL/2.0/.
11  *
12  * See the COPYRIGHT file distributed with this work for additional
13  * information regarding copyright ownership.
14  */
15 
16 #pragma once
17 
18 /*! \file dns/opcode.h */
19 
20 #include <isc/lang.h>
21 
22 #include <dns/types.h>
23 
24 ISC_LANG_BEGINDECLS
25 
26 isc_result_t
27 dns_opcode_totext(dns_opcode_t opcode, isc_buffer_t *target);
28 /*%<
29  * Put a textual representation of error 'opcode' into 'target'.
30  *
31  * Requires:
32  *\li	'opcode' is a valid opcode.
33  *
34  *\li	'target' is a valid text buffer.
35  *
36  * Ensures:
37  *\li	If the result is success:
38  *		The used space in 'target' is updated.
39  *
40  * Returns:
41  *\li	#ISC_R_SUCCESS			on success
42  *\li	#ISC_R_NOSPACE			target buffer is too small
43  */
44 
45 ISC_LANG_ENDDECLS
46