libares/ares_destroy.3

   1 .\" $Id: ares_destroy.3,v 1.1 1998/08/13 18:07:28 ghudson Exp $
   2 .\"
   3 .\" Copyright 1998 by the Massachusetts Institute of Technology.
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this
   6 .\" software and its documentation for any purpose and without
   7 .\" fee is hereby granted, provided that the above copyright
   8 .\" notice appear in all copies and that both that copyright
   9 .\" notice and this permission notice appear in supporting
  10 .\" documentation, and that the name of M.I.T. not be used in
  11 .\" advertising or publicity pertaining to distribution of the
  12 .\" software without specific, written prior permission.
  13 .\" M.I.T. makes no representations about the suitability of
  14 .\" this software for any purpose.  It is provided "as is"
  15 .\" without express or implied warranty.
  16 .\"
  17 .TH ARES_DESTROY 3 "23 July 1998"
  18 .SH NAME
  19 ares_destroy \- Destroy a resolver channel
  20 .SH SYNOPSIS
  21 .nf
  22 .B #include <ares.h>
  23 .PP
  24 .B int ares_destroy(ares_channel \fIchannel\fP)
  25 .fi
  26 .SH DESCRIPTION
  27 The
  28 .B ares_destroy
  29 function destroys the name service channel identified by
  30 .IR channel ,
  31 freeing all memory and closing all sockets used by the channel.
  32 .B ares_destroy
  33 invokes the callbacks for each pending query on the channel, passing a
  34 status of
  35 .BR ARES_EDESTRUCTION .
  36 These calls give the callbacks a chance to clean up any state which
  37 might have been stored in their arguments.
  38 .SH SEE ALSO
  39 .BR ares_init (3)
  40 .SH AUTHOR
  41 Greg Hudson, MIT Information Systems
  42 .br
  43 Copyright 1998 by the Massachusetts Institute of Technology.