config-win32.h: comments adjustments - followup
[platform/upstream/c-ares.git] / ares_dup.3
1 .\"
2 .\" Copyright (C) 2004-2009 by Daniel Stenberg
3 .\"
4 .\" Permission to use, copy, modify, and distribute this
5 .\" software and its documentation for any purpose and without
6 .\" fee is hereby granted, provided that the above copyright
7 .\" notice appear in all copies and that both that copyright
8 .\" notice and this permission notice appear in supporting
9 .\" documentation, and that the name of M.I.T. not be used in
10 .\" advertising or publicity pertaining to distribution of the
11 .\" software without specific, written prior permission.
12 .\" M.I.T. makes no representations about the suitability of
13 .\" this software for any purpose.  It is provided "as is"
14 .\" without express or implied warranty.
15 .\"
16 .TH ARES_DUP 3 "26 May 2009"
17 .SH NAME
18 ares_dup \- Duplicate a resolver channel
19 .SH SYNOPSIS
20 .nf
21 .B #include <ares.h>
22 .PP
23 .B int ares_dup(ares_channel *\fIdest\fP, ares_channel \fIsource\fP)
24 .fi
25 .SH DESCRIPTION
26 The \fBares_dup(3)\fP function duplicates an existing communications channel
27 for name service lookups.  If it returns successfully, \fBares_dup(3)\fP will
28 set the variable pointed to by \fIdest\fP to a handle used to identify the
29 name service channel.  The caller should invoke \fIares_destroy(3)\fP on the
30 handle when the channel is no longer needed.
31
32 The \fBares_dup_options\fP function also initializes a name service channel,
33 with additional options set exactly as the \fIsource\fP channel has them
34 configured.
35 .SH SEE ALSO
36 .BR ares_destroy(3),
37 .BR ares_init(3),
38 .BR ares_library_init(3)
39 .SH AVAILABILITY
40 ares_dup(3) was added in c-ares 1.6.0
41 .SH AUTHOR
42 Daniel Stenberg
43