PQparamCreate(3)               libpqtypes Manual              PQparamCreate(3)



NAME
       PQparamCreate,  PQparamReset,  PQparamClear  - PGparam management func-
       tions.

SYNOPSIS
       #include <libpqtypes.h>

       PGparam *PQparamCreate(const PGconn *conn);
       void PQparamReset(PGparam *param);
       void PQparamClear(PGparam *param);

DESCRIPTION
       These functions manage the opaque PGparam object.

       PQparamCreate() will allocate and  initialize  a  new  PGparam  object.
       After the create call, the PGparam object is ready for use.

       PQparamReset()  will  clear out any previously put parameters, but will
       not free any memory.  This is useful for application looking to "reuse"
       a PGparam object.

       PQparamClear()  releases  all resources being used by a PGparam object,
       the object should not be used after a clear.

       It is very important to call PQparamReset() if you plan  on  reusing  a
       PGparam object.

RETURN VALUE
       PQparamCreate()  returns  a  pointer to a PGparam object on success and
       NULL if something failed (check PQgeterror(3) for more information).

       PQparamReset() and PQparamClear() have no  return  values.   If  either
       function is provided a NULL PGparam pointer, it will silently fail.

EXAMPLES
       None.

AUTHOR
       A  contribution  of  eSilo, LLC. for the PostgreSQL Database Management
       System.  Written by Andrew Chernow and Merlin Moncure.

REPORTING BUGS
       Report bugs to <libpqtypes@esilo.com>.

COPYRIGHT
       Copyright (c) 2008 eSilo, LLC. All rights reserved.
       This is free software; see the source for copying conditions.  There is
       NO  warranty; not even for MERCHANTABILITY or  FITNESS FOR A PARTICULAR
       PURPOSE.

SEE ALSO
       pqt-specs(3), PQputf(3), PQgeterror(3), PQparamExec(3)



libpqtypes                           2008                     PQparamCreate(3)

libpqtypes home page