Creates a data structure containing the information needed to cancel a command issued through a particular database connection. 特定のデータベース接続を通して発行されたコマンドをキャンセルするために必要な情報を持つデータ構造を作成します。

PGcancel *PQgetCancel(PGconn *conn);

<xref linkend="libpq-PQgetCancel"/> creates a <structname>PGcancel</structname><indexterm><primary>PGcancel</primary></indexterm> object given a <structname>PGconn</structname> connection object. It will return <symbol>NULL</symbol> if the given <parameter>conn</parameter> is <symbol>NULL</symbol> or an invalid connection. The <structname>PGcancel</structname> object is an opaque structure that is not meant to be accessed directly by the application; it can only be passed to <xref linkend="libpq-PQcancel"/> or <xref linkend="libpq-PQfreeCancel"/>. PQgetCancelは、与えられたPGconn接続オブジェクトのPGcancelオブジェクトを作成します。 与えられたconnがNULLもしくは無効な接続であった場合、NULLが返されます。 PGcancelオブジェクトは不透明な構造体であり、アプリケーションから直接アクセスすることができません。 これはPQcancelもしくはPQfreeCancelに渡すことしかできません。

Frees a data structure created by <xref linkend="libpq-PQgetCancel"/>. PQgetCancelで作成されたデータ構造を解放します。

void PQfreeCancel(PGcancel *cancel);

<xref linkend="libpq-PQfreeCancel"/> frees a data object previously created by <xref linkend="libpq-PQgetCancel"/>. PQfreeCancelは事前にPQgetCancelで作成されたデータオブジェクトを解放します。

Requests that the server abandon processing of the current command. サーバに現在のコマンドの廃棄処理を要求します。

int PQcancel(PGcancel *cancel, char *errbuf, int errbufsize);

The return value is 1 if the cancel request was successfully dispatched and 0 if not. If not, <parameter>errbuf</parameter> is filled with an explanatory error message. <parameter>errbuf</parameter> must be a char array of size <parameter>errbufsize</parameter> (the recommended size is 256 bytes). キャンセル要求の受け入れが成功すれば1を、そうでなければ0を返します。 失敗した場合、errbufにそれを説明するエラーメッセージが収納されます。 errbufはerrbufsizeサイズの文字配列でなければなりません。 (推奨サイズは256バイトです。)

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. しかし、要求の受け入れが成功したとしても、その要求の効果が出ることは全く保証していません。 もしキャンセル操作が有効であれば、現在のコマンドは間もなく中断され、エラーが結果として返ります。 キャンセル操作に失敗した場合（例えばバックエンドがすでにコマンド処理を終了していたため）、目に見える結果は何も出てこなくなります。

<xref linkend="libpq-PQcancel"/> can safely be invoked from a signal handler, if the <parameter>errbuf</parameter> is a local variable in the signal handler. The <structname>PGcancel</structname> object is read-only as far as <xref linkend="libpq-PQcancel"/> is concerned, so it can also be invoked from a thread that is separate from the one manipulating the <structname>PGconn</structname> object. errbufがシグナルハンドラ内のローカル変数であれば、PQcancelはシグナルハンドラから起動しても問題ありません。 PQcancelの実行中、PGcancelは読み取りのみです。 従って、PGconnオブジェクトを操作するスレッドと別のスレッドからこの関数を呼び出すこともできます。

<xref linkend="libpq-PQrequestCancel"/> is a deprecated variant of <xref linkend="libpq-PQcancel"/>. PQrequestCancelはPQcancelの廃止予定の変形版です。

int PQrequestCancel(PGconn *conn);

Requests that the server abandon processing of the current command. It operates directly on the <structname>PGconn</structname> object, and in case of failure stores the error message in the <structname>PGconn</structname> object (whence it can be retrieved by <xref linkend="libpq-PQerrorMessage"/>). Although the functionality is the same, this approach is not safe within multiple-thread programs or signal handlers, since it is possible that overwriting the <structname>PGconn</structname>'s error message will mess up the operation currently in progress on the connection. サーバに現在のコマンドの廃棄処理を要求します。 これはPGconnオブジェクトを直接扱い、また、失敗した場合エラーメッセージはPGconnオブジェクト内に収納されます。 (PQerrorMessageにより取り出すことができます。) 機能的には同一ですが、この方法は複数スレッドプログラムやシグナルハンドラでは安全ではありません。PGconnのエラーメッセージが上書きされることにより、その接続で現在進行中の操作を台無しにする可能性があるからです。