Section 3(cbl) - COBOL Functions

ATMI COBOL Function Reference

TPGETCTXT(3cbl)

Name

TPGETCTXT() - retrieves a context identifier for the current application association

Synopsis

01 TPCONTEXTDEF-REC.
   COPY TPCONTEXTDEF.
 
01 TPSTATUS-REC.
   COPY TPSTATUS.
 
CALL "TPGETCTXT" USING TPCONTEXTDEF-REC TPSTATUS-REC.

Description

TPGETCTXT() retrieves an identifier that represents the current application context and places that identifier in CONTEXT in TPCONTEXTDEF-REC. Typically, a COBOL application:

Calls TPINITIALIZE() with the TP-MULTI-CONTEXTS flag set.

Calls TPGETCTXT() and saves the TPCONTEXTDEF-REC.

Calls TPINITIALIZE(), again with the TP-MULTI-CONTEXTS flag.

Calls TPGETCTXT() again and saves the returned context.

Calls TPSETCTXT() to switch back to the first context.

TPGETCTXT() may be called in single-context applications as well as in multi-context applications.

Return Values

Upon successful completion, TPGETCTXT sets TP-STATUS to [TPOK] and places the program's context identifier in CONTEXT in TPCONTEXTDEF-REC. CONTEXT is set to the current context ID, which may be represented by either:

An actual context ID
TPNULLCONTEXT, indicating that this program is not currently associated with a context

Note: TPINVALIDCONTEXT cannot be returned in COBOL programs because this value is possible only in multithreaded programs.

Errors

Upon failure, TPGETCTXT sets TP-STATUS to one of the following values.

[TPEINVAL]

Invalid arguments have been given.

[TPESYSTEM]

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

[TPEOS]

An operating system error has occurred.