ares_version.3

   1 .\"
   2 .\" Copyright 2004 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_VERSION 3 "29 January 2004"
  17 .SH NAME
  18 ares_version \- Get the version number of the library
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <ares.h>
  22 .PP
  23 .B const char *ares_version(int *\fIversion\fP)
  24 .fi
  25 .SH DESCRIPTION
  26 The
  27 .B ares_version
  28 function gets the library version as a string and optionally as an integer
  29 stored in the
  30 .IR version ,
  31 argument. If you pass a NULL, no integer is attempted to be returned.
  32
  33 The integer is built up as 24bit number, with 8 separate bits used for major
  34 number, minor number and patch number. This makes a version string such as
  35 1.2.3 will be returned as the hexadecimal number 0x010203 (decimal 66051).
  36 .SH NOTES
  37 This function is not compatible with ares.
  38 .SH AUTHOR
  39 Daniel Stenberg
  40