Section 3(cbl) - COBOL Functions

ATMI COBOL Function Reference

TPCHKAUTH(3cbl)

Name

TPCHKAUTH()—check if authentication required to join a BEA Tuxedo ATMI application

Synopsis

01 TPAUTDEF-REC.
 COPY TPAUTDEF. 
 
01 TPSTATUS-REC.
 COPY TPSTATUS.
 
 CALL "TPCHKAUTH" USING TPAUTDEF-REC TPSTATUS-REC.

Description

TPCHKAUTH() checks if authentication is required by the application configuration. This is typically used by application clients prior to calling TPINITIALIZE() to determine if a password should be obtained from the user.

Return Values

Upon successful completion, TPCHKAUTH() sets TP-STATUS to [TPOK] and sets one of the following values in TPAUTDEF-REC.

TPNOAUTH

Indicates that no authentication is required.

TPSYSAUTH

Indicates that only system authentication is required.

TPAPPAUTH

Indicates that both system and application specific authentication are required.

Errors

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

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

Portability

The interfaces described in TPCHKAUTH() are supported on UNIX system and MS-DOS operating systems.