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

PMEVENTFLAGSSTR(3)        Library Functions Manual        PMEVENTFLAGSSTR(3)

NAME         top

       pmEventFlagsStr,  pmEventFlagsStr_r  -  convert an event record flags
       value into a string

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       const char *pmEventFlagsStr(int flags);
       char *pmEventFlagsStr_r(int flags, char *buf, int buflen);

       cc ... -lpcp

DESCRIPTION         top

       For use in error and diagnostic messages, pmEventFlagsStr returns a
       `human readable' version of the value flags, assuming this to be the
       er_flags field of a pmEventRecord or pmEventHighResRecord.  The
       pmEventFlagsStr_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 64 bytes.

       The string value result from pmEventFlagsStr is held in a single
       static buffer, so the returned value is only valid until the next
       call to pmEventFlagsStr.

NOTES         top

       pmEventFlagsStr returns a pointer to a static buffer and hence is not
       thread-safe.  Multi-threaded applications should use
       pmEventFlagsStr_r instead.

SEE ALSO         top

       PMAPI(3) and pmdaEventAddRecord(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 ⟨https://github.com/performancecopilot/pcp.git⟩ on
       2017-09-15.  If you discover any rendering problems in this HTML ver‐
       sion 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 man‐
       ual page), send a mail to man-pages@man7.org

Performance Co-Pilot                 PCP                  PMEVENTFLAGSSTR(3)

Pages that refer to this page: pmdaeventarray(3)pmdaeventclient(3)