Section 3(cbl) - COBOL Functions

ATMI COBOL Function Reference

TPCANCEL(3cbl)

Name

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(). 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 improperly.

[TPESYSTEM]

A BEA Tuxedo system error has occurred. The exact nature of the error is written to a log file.

[TPEOS]

An operating system error has occurred.