summaryrefslogtreecommitdiff
path: root/man/man3/pmiend.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/pmiend.3')
-rw-r--r--man/man3/pmiend.359
1 files changed, 59 insertions, 0 deletions
diff --git a/man/man3/pmiend.3 b/man/man3/pmiend.3
new file mode 100644
index 0000000..0c5d179
--- /dev/null
+++ b/man/man3/pmiend.3
@@ -0,0 +1,59 @@
+'\"macro stdmacro
+.\"
+.\" Copyright (c) 2010 Ken McDonell. 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 PMIEND 3 "" "Performance Co-Pilot"
+.SH NAME
+\f3pmiEnd\f1 \- finish up a LOGIMPORT archive
+.SH "C SYNOPSIS"
+.ft 3
+#include <pcp/pmapi.h>
+.br
+#include <pcp/impl.h>
+.br
+#include <pcp/import.h>
+.sp
+int pmiEnd(void);
+.sp
+cc ... \-lpcp_import \-lpcp
+.ft 1
+.SH "Perl SYNOPSIS"
+.ft 3
+use PCP::LogImport;
+.sp
+pmiEnd();
+.ft 1
+.SH DESCRIPTION
+As part of the Performance Co-Pilot Log Import API (see
+.BR LOGIMPORT (3)),
+.B pmiEnd
+closes the current context, forcing the trailer records
+to be written to the PCP archive files, and then these files are
+closed.
+.PP
+In normal operations, an application would include a call
+to
+.B pmiEnd
+at the end of processing for each context created with a call
+to
+.BR pmiStart (3).
+.SH DIAGNOSTICS
+.B pmiEnd
+returns zero on success else a negative value that can be turned into an
+error message by calling
+.BR pmiErrStr (3).
+.SH SEE ALSO
+.BR LOGIMPORT (3)
+and
+.BR pmiStart (3).