Blame ares_version.3

Packit 514978
.\"
Packit 514978
.\" Copyright 2004 by Daniel Stenberg
Packit 514978
.\"
Packit 514978
.\" Permission to use, copy, modify, and distribute this
Packit 514978
.\" software and its documentation for any purpose and without
Packit 514978
.\" fee is hereby granted, provided that the above copyright
Packit 514978
.\" notice appear in all copies and that both that copyright
Packit 514978
.\" notice and this permission notice appear in supporting
Packit 514978
.\" documentation, and that the name of M.I.T. not be used in
Packit 514978
.\" advertising or publicity pertaining to distribution of the
Packit 514978
.\" software without specific, written prior permission.
Packit 514978
.\" M.I.T. makes no representations about the suitability of
Packit 514978
.\" this software for any purpose.  It is provided "as is"
Packit 514978
.\" without express or implied warranty.
Packit 514978
.\"
Packit 514978
.TH ARES_VERSION 3 "29 January 2004"
Packit 514978
.SH NAME
Packit 514978
ares_version \- Get the version number of the library
Packit 514978
.SH SYNOPSIS
Packit 514978
.nf
Packit 514978
#include <ares.h>
Packit 514978
Packit 514978
const char *ares_version(int *\fIversion\fP)
Packit 514978
.fi
Packit 514978
.SH DESCRIPTION
Packit 514978
The \fBares_version(3)\fP function gets the library version as a string and
Packit 514978
optionally as an integer stored in the \fIversion\fP argument. If you pass a
Packit 514978
NULL, no integer is attempted to be returned.
Packit 514978
Packit 514978
The integer is built up as 24bit number, with 8 separate bits used for major
Packit 514978
number, minor number and patch number. This makes a version string such as
Packit 514978
1.2.3 will be returned as the hexadecimal number 0x010203 (decimal 66051).
Packit 514978
.SH "SEE ALSO"
Packit 514978
.BR ares_init (3),
Packit 514978
.BR ares_library_init (3)