Section 3(cbl) - COBOL Functions

ATMI COBOL Function Reference

TPGBLKTIME(3cbl)

Name

TPGBLKTIME() - retrieves the blocktime value previously set by TPSBLKTIME

Synopsis

01 TPBLKDEF-REC.
	COPY TPBLKDEF.
01 TPSTATUS-REC.
	COPY TPSTATUS.

CALL "TPGBLKTIME" USING TPBLKDEF-REC TPSTATUS-REC.

Description

TPGBLKTIME() retrieves a previously set, per second, blocktime value and places this value in BLKTIME in TBLKDEF-REC. 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 TPBLKDEF-REC flag values:

TPBLK-NEXT

This value retrieves the per second blocktime value for the previously set TPSBLKTIME() using a TBLKNEXT value.

TPBLK-ALL

This value retrieves the per second blocktime value for the previously set TPSBLKTIME() using a TBLKALL value.

If TPGBLKTIME() does not specify a TPBLK-NEXT or TPBLK-ALL blocktime flag value, it returns the applicable blocktime value for the next blocking API 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 TPGBLKTIME() without a TPBLK-NEXT or TPBLK-ALL blocktime flag value, the system-wide default blocktime value cannot be returned. A 0 value is returned instead.

Return Values

Upon successful completion, TPGBLKTIME() sets TP-STATUS to [TPOK] and returns the previously set blocktime, if any, in BLKTIME in TBLKDEF-REC. A BLKTIME 0 value indicates that there are no previously set input blocktime values.

Errors

Under the following conditions, TPGBLKTIME fails and sets TP-STATUS to one of the following values. The failure does not affect transaction timeout values

[TPEINVAL]

Invalid arguments were given. For example, a value other than TPBLK-NEXT or TPBLK-ALL was specified in TPBLKDEF-REC.

[TPESYSTEM]

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