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