Section 3c - C Functions

ATMI C Function Reference

tpchkauth(3c)

Name

tpchkauth()—Routine for checking if authentication required to join an application.

Synopsis

#include <atmi.h> 
 
int tpchkauth(void)

Description

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

In a multithreaded application, a thread in the TPINVALIDCONTEXT state is not allowed to issue a call to tpchkauth().

Return Values

Upon success, tpchkauth() returns one of the following non-negative values:

TPNOAUTH

Indicates that no authentication is required.

TPSYSAUTH

Indicates that system authentication only is required.

TPAPPAUTH

Indicates that both system and application specific authentication are required.

Upon failure, tpchkauth() returns -1 and sets tperrno to indicate the error condition.

Errors

Upon failure, tpchkauth() sets tperrno to one of the following values:

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

Interoperability

tpchkauth() is available only on sites running release 4.2 or later.

Portability

The interfaces described in tpchkauth(3c) are supported on UNIX, Windows, and MS-DOS operating systems.