Man page - pmsearchtextindom(3)

Packages contains this manual

Package:  libpcp3-dev
apt-get install libpcp3-dev

Manuals in package:
• pmprintf(3)
• pmstrncat(3)
• pmsprintf(3)
• pmtrace(3)
• pmgetopt_r(3)
• pmfstring(3)
• pmhash(3)
• pmtime(3)
• pmstrncpy(3)
• pmflush(3)
• pmfault(3)
Documentations in package:
• libpcp3-dev

Manual

PMSEARCHTEXTINDOM

NAME
C SYNOPSIS
DESCRIPTION
DIAGNOSTICS
SEE ALSO

---

NAME

pmSearchTextInDom - search for all entities related to given instance domain

C SYNOPSIS

#include <pcp/pmwebapi.h>

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

cc ... -lpcp_web

DESCRIPTION

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

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

SEE ALSO

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

---