__pmparsetime(3) [centos man page]

PMPARSETIME(3)						     Library Functions Manual						    PMPARSETIME(3)

NAME

       __pmParseTime - parse time point specification

C SYNOPSIS

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

       int __pmParseTime(const char *string, struct timeval *logStart, struct timeval *logEnd, struct timeval *rslt, char **errMsg);

       cc ... -lpcp

DESCRIPTION

       __pmParseTime  is  designed  to	encapsulate  the  interpretation of a time point specification in command line switches for use by the PCP
       client tools.

       This function expects to be called with the time point specification as string.	If the tool is running against PCP  archive(s),  you  also
       need to supply the start time of the first (only) archive as logStart, and the end of the last (only) archive as logEnd.  See pmGetArchive-
       Label(3) and pmGetArchiveEnd(3) for how to obtain values for these parameters.  If the tool is running against a live feed  of  performance
       data, logStart should be the current time (but could be aligned on the next second for example), while logEnd should have its tv_sec compo-
       nent set to INT_MAX.

       The rslt structure must be allocated before calling __pmParseTime.

       You also need to set the current PCP reporting time zone to correctly reflect the -z and -Z command line parameters  before  calling  __pm-
       ParseTime.  See pmUseZone(3) and friends for information on how this is done.

       If  the	conversion  is successful, __pmParseTime returns 0, and fills in rslt with the time value defined by the input parameters.  If the
       argument strings could not be parsed, it returns -1 and a dynamically allocated error message string in errMsg.	Be sure to  free(3C)  this
       error message string.

SEE ALSO

       PMAPI(3),  pmGetArchiveEnd(3),  pmGetArchiveLabel(3),  pmNewContextZone(3),  pmNewZone(3), pmParseInterval(3), pmParseTimeWindow(3), pmUse-
       Zone(3), __pmConvertTime(3) and __pmParseCtime(3).

Performance Co-Pilot							PCP							    PMPARSETIME(3)

PMGETCONFIG(3)						     Library Functions Manual						    PMGETCONFIG(3)

NAME

       pmGetConfig - return Performance Co-Pilot configuration variable

C SYNOPSIS

       #include <pcp/pmapi.h>
       char *pmGetConfig(const char *variable);

       #include <pcp/impl.h>
       char *__pmGetAPIConfig(const char *feature);

       cc ... -lpcp

DESCRIPTION

       The  pmGetConfig function searches for variable first in the environment and then, if not found, in the Performance Co-Pilot (PCP) configu-
       ration file and returns the string result.  If variable is not already in the environment, it is added with  a  call  to  putenv(3)  before
       returning.

       The default location of the PCP configuration file is /etc/pcp.conf but this may be changed by setting PCP_CONF in the environment to a new
       location, as described in pcp.conf(5).

       The internal __pmGetAPIConfig function reports on features of the PCP library.  It can be used to query support for multi-threading,  secu-
       rity extensions, and other features.

       The  pmconfig(1)  utility provides command line access to both of these interfaces, and also provides a mechanism for listing all available
       variables and features that are valid arguments to these routines.

RETURN VALUE

       If variable is not found in either the environment nor the PCP configuration file then the return value is an empty  string.   If  the  PCP
       configuration  file  is	not found then a fatal error message is printed and the process will exit(2) - although this sounds drastic, it is
       the only course of action available because the PCP configuration/installation is fatally flawed.

       If the pmGetConfig function returns a non-empty string, the returned value points into the environment and so changing it is  a	bad  idea.
       This function returns the same type as the getenv(3) function (which should probably be a const char *).

       The  __pmGetAPIConfig  routine  on the other hand returns NULL on failure to lookup the requested feature.  It does not modify the environ-
       ment, and returns a pointer to a static read-only string which also should not be modified or freed by the caller.

PCP ENVIRONMENT

       Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP.  On  each	installation,  the
       file  /etc/pcp.conf contains the local values for these variables.  The $PCP_CONF variable may be used to specify an alternative configura-
       tion file, as described in pcp.conf(5).	Values for these variables may be obtained programmatically using the pmGetConfig(3) function.

SEE ALSO

       PCPIntro(1), pmconfig(1), exit(2), PMAPI(3), getenv(3C), putenv(3C), pcp.conf(5), pcp.env(5) and environ(5).

Performance Co-Pilot							PCP							    PMGETCONFIG(3)