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

PMPARSEINTERVAL(3)        Library Functions Manual        PMPARSEINTERVAL(3)

NAME         top

       pmParseInterval - convert interval string to timeval structure

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmParseInterval(const char *string, struct timeval *rslt,
               char **errmsg);

       cc ... -lpcp

DESCRIPTION         top

       pmParseInterval parses the argument string specifying an interval of
       time and fills in the tv_sec and tv_usec components of the rslt
       structure to represent that interval.

       The input string is most commonly the argument following a -t command
       line option to a PCP application, and the syntax is fully described
       in PCPIntro(1).

DIAGNOSTICS         top

       pmParseInterval returns 0 and errmsg is undefined if the parsing is
       successful.

       If the given string does not conform to the required syntax
       pmParseInterval returns -1 and a dynamically allocated error message
       string in errmsg.  The error message is terminated with a newline and
       includes the text of the input string along with an indicator of the
       position at which the error was detected, e.g.
                 4minutes 30mumble
                            ^ -- unexpected value

       In the case of an error, the caller is responsible for calling
       free(3) to release the space allocated for errmsg.

SEE ALSO         top

       PCPIntro(1), free(3), PMAPI(3) and pmParseTimeWindow(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-05-03.  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                  PMPARSEINTERVAL(3)

Pages that refer to this page: pcp-free(1)pcp-mpstat(1)pcp-pidstat(1)pmconverttime(3)pmparsectime(3)pmparsetime(3)pmparsetimewindow(3)