pmerrstr(3) — Linux manual page

PMERRSTR(3)              Library Functions Manual             PMERRSTR(3)

NAME         top

       pmErrStr, pmErrStr_r - convert a PMAPI error code into a string

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       const char *pmErrStr(int code);
       char *pmErrStr_r(int code, char *buf, int buflen);

       cc ... -lpcp

DESCRIPTION         top

       Translate  an error code into a text string, suitable for generat‐
       ing a diagnostic message.  The pmErrStr_r function does the  same,
       but  stores the result in a user-supplied buffer buf of length bu‐
       flen, which should have room for at least PM_MAXERRMSGLEN bytes.

       By convention, all error codes are negative.  The small values are
       assumed to be negated versions of the Unix error codes as  defined
       in <errno.h> and the strings returned are as per strerror(3).  The
       larger,  negative  error codes are Performance Metrics Application
       Programming Interface (PMAPI) error conditions and pmErrStr(3) re‐
       turns an appropriate PMAPI error string, as determined by code.

NOTES         top

       pmErrStr returns a pointer to a static  buffer,  so  the  returned
       value  is  only valid until the next call to pmErrStr and hence is
       not   thread-safe.    Multi-threaded   applications   should   use
       pmErrStr_r instead.

SEE ALSO         top

       pmerr(1), PMAPI(3) and perror(3).

COLOPHON         top

       This  page is part of the PCP (Performance Co-Pilot) project.  In‐
       formation about the project can be found at  ⟨http://www.pcp.io/⟩.
       If  you  have  a  bug  report  for  this  manual  page, send it to
       pcp@groups.io.  This page was obtained from the project's upstream
       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩  on
       2025-08-11.   (At  that  time,  the date of the most recent commit
       that was found in the repository was 2025-08-11.)  If you discover
       any rendering problems in this HTML version of the  page,  or  you
       believe  there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page),  send  a
       mail to man-pages@man7.org

Performance Co-Pilot               PCP                        PMERRSTR(3)

Pages that refer to this page: pmerr(1),  pmprobe(1),  pcpintro(3),  __pmaf(3),  pmapi(3),  __pmcheckattribute(3),  __pmcleanmapdir(3),  pmdacache(3),  pmdaeventqueue(3),  pmdahelp(3),  pmdarootconnect(3),  pmdiscoversetup(3),  pmerrstr(3),  pmfetch(3),  pmgetcontexthostname(3),  pmgetderivedcontrol(3),  pmhash(3),  pmierrstr(3),  pmjsonget(3),  pmloadderivedconfig(3),  __pmlogwritemark(3),  pmlookuplabels(3),  pmprintf(3),  __pmprocessexec(3),  __pmprocesspipe(3),  pmrecord(3),  pmsetprocessidentity(3),  pmunpackeventrecords(3),  pmns(5)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.