NAME | C SYNOPSIS | DESCRIPTION | NOTES | SEE ALSO | COLOPHON

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 generating a
       diagnostic message.  The pmErrStr_r function does the same, but
       stores the result in a user-supplied buffer buf of length buflen,
       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)
       returns 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.
       Information 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@oss.sgi.com.  This page was obtained from the project's upstream
       Git repository ⟨git://git.pcp.io/pcp⟩ on 2017-04-25.  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)pmafm(3)pmapi(3)pmdacache(3)pmdaeventqueue(3)pmdahelp(3)pmdarootconnect(3)pmerrstr(3)pmfetch(3)pmierrstr(3)pmjsonget(3)pmloadderivedconfig(3)pmprintf(3)pmunpackeventrecords(3)pmns(5)