Section 3c - C Functions

ATMI C Function Reference

tpgblktime(3c)

Name

tpgblktime()—Retrieves a previously set, per second, blocktime value

Synopsis

#include <atmi.h>  
int tpgblktime(TPBLK_NEXT, TPBLK_ALL long flags)

Description

tpgblktime() retrieves a previously set, per second, blocktime value.If tpgblktime() specifies a blocktime flag value, and no such flag value has been set, the return value is 0. A blocktime flag value less than 0 produces an error.

The following is a list of valid flags:

TPBLK_NEXT

This flag returns the per second blocktime value for the previously set tpsblktime(TPBLK_NEXT)call.

TPBLK_ALL

This flag returns the per second blocktime value for the previously set tpsblktime(TPBLK_ALL)call.

0

This flag returns the applicable blocktime value for the next blocking ATMI set due to a previous tpsblktime() call with the TPBLK_NEXT or TPBLK_ALL flag blocktime value, or a system-wide default blocktime value.

Note: When a workstation client calls a tpgblktime() 0 flag, the system-wide default blocktime value cannot be returned. A 0 value is returned instead.

Return Values

Upon success, tpgblktime() returns a positive integer indicating the blocking time value currently in effect for the corresponding flag value. A 0 return value indicates that no such blocking time override is currently in effect.

This function returns -1 on error and sets tperrno to indicate the error condition. The failure does not affect the existing transaction, if one exists.

Error

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

[TPEINVAL]

Invalid arguments were given. For example, the flags value is negative or more than one blocktime flag value (TPBLK_NEXT, TPBLK_ALL, or 0) was specified.

[TPESYSTEM]

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