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

Packit 577717
.TH LIBPFM 3  "November, 2003" "" "Linux Programmer's Manual"
Packit 577717
.SH NAME
Packit 577717
pfm_strerror \- return string describing error code
Packit 577717
.SH SYNOPSIS
Packit 577717
.nf
Packit 577717
.B #include <perfmon/pfmlib.h>
Packit 577717
.sp
Packit 577717
.BI "char *pfm_strerror(int "code);
Packit 577717
.sp
Packit 577717
.SH DESCRIPTION
Packit 577717
This function returns a string which describes the libpfm error
Packit 577717
value in \fBcode\fR. The string returned by the call must
Packit 577717
be considered as read only.
Packit 577717
Packit 577717
The function must \fBonly\fR be used on libpfm calls. It is not
Packit 577717
designed to handle OS system call errors.
Packit 577717
Packit 577717
.SH RETURN
Packit 577717
The function returns a pointer to the string describing
Packit 577717
the error code. If code is invalid then the default
Packit 577717
error message is returned.
Packit 577717
.SH ERRORS
Packit 577717
If the error code is invalid, then the function returns
Packit 577717
a pointer to a string which says "unknown error code".
Packit 577717
.SH AUTHOR
Packit 577717
Stephane Eranian <eranian@hpl.hp.com>
Packit 577717
.PP