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