PostgreSQL

  +
  link:libpq-cancel.html#LIBPQ-PQGETCANCEL[`+PQgetCancel+`] creates a `+PGcancel+` object given a `+PGconn+` connection object. It will return `+NULL+` if the given _`+conn+`_ is `+NULL+` or an invalid connection. The `+PGcancel+` object is an opaque structure that is not meant to be accessed directly by the application; it can only be passed to link:libpq-cancel.html#LIBPQ-PQCANCEL[`+PQcancel+`] or link:libpq-cancel.html#LIBPQ-PQFREECANCEL[`+PQfreeCancel+`].
[.term]#`+PQfreeCancel+`::
  Frees a data structure created by link:libpq-cancel.html#LIBPQ-PQGETCANCEL[`+PQgetCancel+`].
  +

  +
  link:libpq-cancel.html#LIBPQ-PQFREECANCEL[`+PQfreeCancel+`] frees a data object previously created by link:libpq-cancel.html#LIBPQ-PQGETCANCEL[`+PQgetCancel+`].
[.term]#`+PQcancel+`::
  Requests that the server abandon processing of the current command.
  +

+
The return value is 1 if the cancel request was successfully dispatched and 0 if not. If not, _`+errbuf+`_ is filled with an explanatory error message. _`+errbuf+`_ must be a char array of size _`+errbufsize+`_ (the recommended size is 256 bytes).
+
Successful dispatch is no guarantee that the request will have any effect, however. If the cancellation is effective, the current command will terminate early and return an error result. If the cancellation fails (say, because the server was already done processing the command), then there will be no visible result at all.
+
link:libpq-cancel.html#LIBPQ-PQCANCEL[`+PQcancel+`] can safely be invoked from a signal handler, if the _`+errbuf+`_ is a local variable in the signal handler. The `+PGcancel+` object is read-only as far as link:libpq-cancel.html#LIBPQ-PQCANCEL[`+PQcancel+`] is concerned, so it can also be invoked from a thread that is separate from the one manipulating the `+PGconn+` object.

+
Requests that the server abandon processing of the current command. It operates directly on the `+PGconn+` object, and in case of failure stores the error message in the `+PGconn+` object (whence it can be retrieved by link:libpq-status.html#LIBPQ-PQERRORMESSAGE[`+PQerrorMessage+`]). Although the functionality is the same, this approach creates hazards for multiple-thread programs and signal handlers, since it is possible that overwriting the `+PGconn+`'s error message will mess up the operation currently in progress on the connection.