pmierrstr(3) — Linux manual page

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

PMIERRSTR(3)            Library Functions Manual            PMIERRSTR(3)

NAME         top

       pmiErrStr, pmiErrStr_r - convert a LOGIMPORT error code into a
       string

C SYNOPSIS         top

       #include <pcp/pmapi.h>
       #include <pcp/import.h>

       const char *pmiErrStr(int code);
       char *pmiErrStr_r(int code, char buf, int buflen);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS         top

       use PCP::LogImport;

       pmiErrStr($code);

DESCRIPTION         top

       As part of the Performance Co-Pilot Log Import API (see
       LOGIMPORT(3)), pmiErrStr translates error codes returned from the
       other routines in the Log Import library into printable error
       messages.

       code would normally have a negative value.  As a special case, if
       code is -1 then the error code returned from the last routine
       called in the LOGIMPORT library for this context will be used.

       The pmiErrStr_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 PMI_MAXERRMSGLEN bytes.

       The set of possible error codes and messages is all those defined
       by pmErrStr(3) and PCPIntro(3), plus the additional ones defined
       in <pcp/import.h> with error code names of the form PMI_ERR_....

SEE ALSO         top

       LOGIMPORT(3), PCPIntro(3) and pmErrStr(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 [email protected].  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2024-06-14.
       (At that time, the date of the most recent commit that was found
       in the repository was 2024-06-14.)  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
       [email protected]

Performance Co-Pilot               PCP                      PMIERRSTR(3)

Pages that refer to this page: logimport(3)pmiaddinstance(3)pmiaddmetric(3)pmiend(3)pmigethandle(3)pmiputlabel(3)pmiputmark(3)pmiputresult(3)pmiputtext(3)pmiputvalue(3)pmiputvaluehandle(3)pmisethostname(3)pmisettimezone(3)pmisetversion(3)pmistart(3)pmiusecontext(3)pmiwrite(3)