opcode.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2004-2007  Internet Systems Consortium, Inc. ("ISC")
00003  * Copyright (C) 2002  Internet Software Consortium.
00004  *
00005  * Permission to use, copy, modify, and/or distribute this software for any
00006  * purpose with or without fee is hereby granted, provided that the above
00007  * copyright notice and this permission notice appear in all copies.
00008  *
00009  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
00010  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
00011  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
00012  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
00013  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
00014  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
00015  * PERFORMANCE OF THIS SOFTWARE.
00016  */
00017 
00018 /* $Id: opcode.h,v 1.8 2007/06/19 23:47:17 tbox Exp $ */
00019 
00020 #ifndef DNS_OPCODE_H
00021 #define DNS_OPCODE_H 1
00022 
00023 /*! \file dns/opcode.h */
00024 
00025 #include <isc/lang.h>
00026 
00027 #include <dns/types.h>
00028 
00029 ISC_LANG_BEGINDECLS
00030 
00031 isc_result_t dns_opcode_totext(dns_opcode_t opcode, isc_buffer_t *target);
00032 /*%<
00033  * Put a textual representation of error 'opcode' into 'target'.
00034  *
00035  * Requires:
00036  *\li   'opcode' is a valid opcode.
00037  *
00038  *\li   'target' is a valid text buffer.
00039  *
00040  * Ensures:
00041  *\li   If the result is success:
00042  *              The used space in 'target' is updated.
00043  *
00044  * Returns:
00045  *\li   #ISC_R_SUCCESS                  on success
00046  *\li   #ISC_R_NOSPACE                  target buffer is too small
00047  */
00048 
00049 ISC_LANG_ENDDECLS
00050 
00051 #endif /* DNS_OPCODE_H */

Generated on Tue Apr 28 17:40:57 2015 by Doxygen 1.5.4 for BIND9 Internals 9.11.0pre-alpha