pmsearchtextindom(3) — Linux manual page

PMSEARCHTEXTINDOM(3)     Library Functions Manual    PMSEARCHTEXTINDOM(3)

NAME         top

       pmSearchTextInDom - search for all entities related to given
       instance domain

C SYNOPSIS         top

       #include <pcp/pmwebapi.h>

       int pmSearchTextInDom(pmSearchSettings *settings,
                             pmSearchTextRequest *request, void *arg);

       cc ... -lpcp_web

DESCRIPTION         top

       Executes  search  for all metrics, instances and instance domains,
       that are related to given instance domain as specified by request:

       query
            Target instance domain.

       count
            Limits number of results. Defaults to 10.

       offset
            Search offset. Defaults to 0.

       Results are ordered by type in an ascending order.

       Each entity matched by the request above will be passed to
       on_text_result callback provided by settings.

DIAGNOSTICS         top

       This function always returns zero on success.  On failure a nega‐
       tive PMAPI error code is returned.

SEE ALSO         top

       pmproxy(1), pmlogger(1), pmsearch(1), pmSearchSetup(3), PMAPI(3)
       and PMWEBAPI(3).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.  In‐
       formation 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
       2025-08-11.  (At that time, the date of the most recent commit
       that was found in the repository was 2025-08-11.)  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               PMSEARCHTEXTINDOM(3)

Pages that refer to this page: pmsearchsetup(3),  pmwebapi(3)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.