Return to PQtypesRegister.3 CVS log

Up to [pgFoundry] / libpqtypes / libpqtypes / docs / man3

removed PQtypesObjectHooks.3 and added PQtypesRegister to reflect libpq new event system

.TH PQtypesRegister 3 2008 "libpqtypes" "libpqtypes Manual"
.SH NAME
PQtypesRegister \- Registers libpqtypes with the libpq event system.
.SH SYNOPSIS
.LP
\fB#include <libpqtypes.h>
.br
.sp
int PQtypesRegister(PGconn *conn);
\fP
.SH DESCRIPTION
.LP
libpqtypes makes use of libpq's Event System.  Before using
libpqtypes, you must register libpqtypes as a libpq EventProc.
It takes a PGconn that libpqtypes is registered with.
.SH RETURN VALUE
.LP
The function returns zero if it fails and non-zero if it succeeds.
.SH EXAMPLES
.LP
.SS Registering libpqtypes
The examples shows how to register libpqtypes with the libpq event system.
.RS
.nf
.LP
\fB/* call prior to any other libpqtypes functions. */
PQtypesRegister(conn);
\fP
.fi
.RE
.SH AUTHOR
.LP
A contribution of eSilo, LLC. for the PostgreSQL Database Management System.
Written by Andrew Chernow and Merlin Moncure.
.SH REPORTING BUGS
.LP
Report bugs to <libpqtypes@esilo.com>.
.SH COPYRIGHT
.LP
Copyright (c) 2008 eSilo, LLC. All rights reserved.
.br
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or  FITNESS
FOR A PARTICULAR PURPOSE.
.SH SEE ALSO
.LP
None