oracular (3) __pmLogMetaTypeStr.3.gz

NAME

       __pmLogMetaTypeStr, __pmLogMetaTypeStr_r - convert an archive metadata record type into a string

C SYNOPSIS

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

       const char *__pmLogMetaTypeStr(int type);
       char *__pmLogMetaTypeStr_r(int type, char *buf, int buflen);

       cc ... -lpcp

CAVEAT

       This documentation is intended for internal Performance Co-Pilot (PCP) developer use.

       These  interfaces  are  not part of the PCP APIs that are guaranteed to remain fixed across releases, and
       they may not work, or may provide different semantics at some point in the future.

DESCRIPTION

       Given a numeric archive metadata record type (type), __pmLogMetaTypeStr produces the ASCII name  of  that
       record  type,  else  UNKNOWN  if type is not a valid record type.  __pmLogMetaTypeStr_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 17 bytes.

       Examples are DESC (for type equals 1), INDOM_V2 (for type equals 2), etc.

NOTES

       Both of these functions are safe to call from threaded contexts.