PURPOSE

TPCANCEL - cancel a communication handle for an outstanding reply

SYNOPSIS

01 TPSVCDEF-REC.
   COPY TPSVCDEF.
01 TPSTATUS-REC.
   COPY TPSTATUS.
CALL "TPCANCEL" USING TPSVCDEF-REC TPSTATUS-REC.

DESCRIPTION

TPCANCEL cancels a communication handle, COMM-HANDLE IN TPSVCDEF-REC, returned by TPACALL(3cbl). It is an error to attempt to cancel a communication handle associated with a transaction.

Upon success, COMM-HANDLE is no longer valid and any reply received on behalf of COMM-HANDLE will be silently discarded.

RETURN VALUES

Upon successful completion, TPCANCEL sets TP-STATUS to [TPOK].

ERRORS

Under the following conditions, TPCANCEL fails and sets TP-STATUS to:

[TPEBADDESC]

COMM-HANDLE is an invalid communication handle.

[TPETRAN]

COMM-HANDLE is associated with the caller's transaction. COMM-HANDLE remains valid and the caller's current transaction is not affected.

[TPEPROTO]

TPCANCEL was called in an improper context.

[TPESYSTEM]

A System/T error has occurred. The exact nature of the error is written to a log file.

[TPEOS]

An operating system error has occurred.

SEE ALSO

TPACALL(3cbl)