Section 3c - C Functions

ATMI C Function Reference

tpgetadmkey(3c)

Name

tpgetadmkey()—Gets administrative authentication key.

Synopsis

#include <atmi.h>  
long tpgetadmkey(TPINIT *tpinfo)

Description

tpgetadmkey() is available for application use by an application specific authentication server. It returns an application security key suitable for assignment to the indicated user for the purpose of administrative authentication. This routine must be called with a client name (that is, tpinfo—>cltname) of either tpsysadm() or tpsysop(); otherwise, a valid administrative key will not be returned.

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

Return Values

Upon success, tpgetadmkey() returns a non-0 value with the high-order bit (0x80000000) set; otherwise it returns 0. Zero may be returned if tpinfo is NULL, tpinfo—>cltname is not tpsysadm() or tpsysop(), or lastly if the effective user ID is not the configured application administrator for this site.

Errors

A zero return value is the only indication that a valid administrative key was not assigned.

Portability

This interface is available only on UNIX system sites running BEA Tuxedo release 5.0 or later.