ares_cancel.3

   1 .\" $Id$
   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_CANCEL 3 "31 March 2004"
  18 .SH NAME
  19 ares_cancel \- Cancel a resolve
  20 .SH SYNOPSIS
  21 .nf
  22 .B #include <ares.h>
  23 .PP
  24 .B int ares_cancel(ares_channel \fIchannel\fP)
  25 .fi
  26 .SH DESCRIPTION
  27 The \fBares_cancel\fP function cancels all lookups/requests made on the the
  28 name service channel identified by \fIchannel\fP.  \fBares_cancel\fP invokes
  29 the callbacks for each pending query on the channel, passing a status of
  30 .BR ARES_ETIMEOUT .
  31 These calls give the callbacks a chance to clean up any state which
  32 might have been stored in their arguments.
  33 .SH SEE ALSO
  34 .BR ares_init (3)
  35 .BR ares_destroy (3)
  36 .SH AUTHOR
  37 Dirk Manske