summaryrefslogtreecommitdiff
path: root/man/man3/pmwhichcontext.3
diff options
context:
space:
mode:
authorIgor Pashev <pashev.igor@gmail.com>2014-10-26 12:33:50 +0400
committerIgor Pashev <pashev.igor@gmail.com>2014-10-26 12:33:50 +0400
commit47e6e7c84f008a53061e661f31ae96629bc694ef (patch)
tree648a07f3b5b9d67ce19b0fd72e8caa1175c98f1a /man/man3/pmwhichcontext.3
downloadpcp-debian/3.9.10.tar.gz
Debian 3.9.10debian/3.9.10debian
Diffstat (limited to 'man/man3/pmwhichcontext.3')
-rw-r--r--man/man3/pmwhichcontext.349
1 files changed, 49 insertions, 0 deletions
diff --git a/man/man3/pmwhichcontext.3 b/man/man3/pmwhichcontext.3
new file mode 100644
index 0000000..36c229d
--- /dev/null
+++ b/man/man3/pmwhichcontext.3
@@ -0,0 +1,49 @@
+'\"macro stdmacro
+.\"
+.\" Copyright (c) 2000-2004 Silicon Graphics, Inc. All Rights Reserved.
+.\"
+.\" This program is free software; you can redistribute it and/or modify it
+.\" under the terms of the GNU General Public License as published by the
+.\" Free Software Foundation; either version 2 of the License, or (at your
+.\" option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+.\" for more details.
+.\"
+.\"
+.TH PMWHICHCONTEXT 3 "PCP" "Performance Co-Pilot"
+.SH NAME
+\f3pmWhichContext\f1 \- identify the current PMAPI context
+.SH "C SYNOPSIS"
+.ft 3
+#include <pcp/pmapi.h>
+.sp
+int pmWhichContext(void);
+.sp
+cc ... \-lpcp
+.ft 1
+.SH DESCRIPTION
+An application using the
+Performance Metrics Application Programming Interface (PMAPI)
+may manipulate several concurrent contexts,
+each associated with a source of performance metrics, e.g. \c
+.BR pmcd (1)
+on some host, or an archive log of performance metrics as created by
+.BR pmlogger (1).
+.PP
+.B pmWhichContext
+returns a handle for the current PMAPI context, that may
+be used in the associated PMAPI routines that require a handle
+to identify a PMAPI context.
+.SH SEE ALSO
+.BR PMAPI (3),
+.BR pmDestroyContext (3),
+.BR pmDupContext (3),
+.BR pmNewContext (3)
+and
+.BR pmUseContext (3).
+.SH DIAGNOSTICS
+.IP \f3PM_ERR_NOCONTEXT\f1
+no current context