pmsprintf(3) — Linux manual page

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

PMSPRINTF(3)            Library Functions Manual            PMSPRINTF(3)

NAME         top

       pmsprintf - formatted string conversion

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmsprintf(char *str, size_t size, const char *fmt, ...
       /*args*/);

       cc ... -lpcp

DESCRIPTION         top

       Safe string formatting interface that wraps the vsnprintf(3)
       call.

       It differs primarily in that pmsprintf guarantees that the output
       buffer str will be null-terminated even when the provided buffer
       size is insufficient to contain the formatted string.  In this
       case a null-terminated truncated string will be returned in str.

       In the case of a failure in the underlying vsnprintf interface, a
       null-terminated empty string will be returned in str, and the
       return value will be zero.

DIAGNOSTICS         top

       On successful completion, pmsprintf returns the number of
       characters written to the supplied buffer, not including the null
       terminator.

       The return code is always zero or more, never negative.

SEE ALSO         top

       vsnprintf(3), pmprintf(3) and PMAPI(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@groups.io.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2021-08-27.
       (At that time, the date of the most recent commit that was found
       in the repository was 2021-08-27.)  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                      PMSPRINTF(3)