Section 3(cbl) - COBOL Functions

e-docs > Tuxedo > ATMI COBOL Function Reference > Section 3(cbl) - COBOL Functions

ATMI COBOL Function Reference

TPCLOSE(3cbl)

Name

TPCLOSE() - close the BEA Tuxedo ATMI resource manager

Synopsis

01 TPSTATUS-REC.
 COPY TPSTATUS. 
 
CALL "TPCLOSE" USING TPSTATUS-REC.

Description

TPCLOSE() tears down the association between the caller and the resource manager to which it is linked. Since resource managers differ in their close semantics, the specific information needed to close a particular resource manager is placed in a configuration file.

If a resource manager is already closed (that is, TPCLOSE() is called more than once), no action is taken and success is returned.

Return Values

Upon successful completion, TPCLOSE() sets TP-STATUS to [TPOK].

Errors

Under the following conditions, TPCLOSE() fails and sets TP-STATUS to:

[TPERMERR]

A resource manager failed to close correctly. More information concerning the reason a resource manager failed to close can be obtained by interrogating a resource manager in its own specific manner. Note that any calls to determine the exact nature of the error hinder portability.

[TPEPROTO]

TPCLOSE() was called in an improper context (for example, while the caller is in transaction mode).

[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.