contrib/bind/lib/dns/include/dns/opcode.h

   1 /*
   2  * Copyright (C) 2004-2007  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 2002  Internet Software Consortium.
   4  *
   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.
   8  *
   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.
  16  */
  17
  18 /* $Id: opcode.h,v 1.8 2007/06/19 23:47:17 tbox Exp $ */
  19
  20 #ifndef DNS_OPCODE_H
  21 #define DNS_OPCODE_H 1
  22
  23 /*! \file dns/opcode.h */
  24
  25 #include <isc/lang.h>
  26
  27 #include <dns/types.h>
  28
  29 ISC_LANG_BEGINDECLS
  30
  31 isc_result_t dns_opcode_totext(dns_opcode_t opcode, isc_buffer_t *target);
  32 /*%<
  33  * Put a textual representation of error 'opcode' into 'target'.
  34  *
  35  * Requires:
  36  *\li   'opcode' is a valid opcode.
  37  *
  38  *\li   'target' is a valid text buffer.
  39  *
  40  * Ensures:
  41  *\li   If the result is success:
  42  *              The used space in 'target' is updated.
  43  *
  44  * Returns:
  45  *\li   #ISC_R_SUCCESS                  on success
  46  *\li   #ISC_R_NOSPACE                  target buffer is too small
  47  */
  48
  49 ISC_LANG_ENDDECLS
  50
  51 #endif /* DNS_OPCODE_H */