Blame src/libpfm-3.y/docs/man3/pfm_get_version.3

Packit Service a1973e
.TH LIBPFM 3  "November, 2003" "" "Linux Programmer's Manual"
Packit Service a1973e
.SH NAME
Packit Service a1973e
pfm_get_version \- get performance monitoring library version
Packit Service a1973e
.SH SYNOPSIS
Packit Service a1973e
.nf
Packit Service a1973e
.B #include <perfmon/pfmlib.h>
Packit Service a1973e
.sp
Packit Service a1973e
.BI "int pfm_get_version(unsigned int *"version);
Packit Service a1973e
.sp
Packit Service a1973e
.SH DESCRIPTION
Packit Service a1973e
This function can be called at any time to get the revision
Packit Service a1973e
level of the library. The version is encoded into an
Packit Service a1973e
unsigned integer and returned in the \fBversion\fR argument.
Packit Service a1973e
A revision number is composed of two fields: a major number
Packit Service a1973e
and a minor number. Both can be extracted from the returned
Packit Service a1973e
argument using macros provided in the header file:
Packit Service a1973e
.TP
Packit Service a1973e
.B PFMLIB_MAJ_VERSION(v)
Packit Service a1973e
returns the major number encoded in v.
Packit Service a1973e
.TP
Packit Service a1973e
.B PFMLIB_MIN_VERSION(v)
Packit Service a1973e
returns the minor number encoded in v.
Packit Service a1973e
.SH RETURN
Packit Service a1973e
The function returns whether or not it was successful.
Packit Service a1973e
A return value of \fBPFMLIB_SUCCESS\fR indicates success, 
Packit Service a1973e
otherwise the value is the error code.
Packit Service a1973e
.SH ERRORS
Packit Service a1973e
.TP
Packit Service a1973e
.B PFMLIB_ERR_INVAL 
Packit Service a1973e
the argument is invalid, most likely a NULL pointer.
Packit Service a1973e
.SH AUTHOR
Packit Service a1973e
Stephane Eranian <eranian@hpl.hp.com>
Packit Service a1973e
.PP