Retrieve Triggered Cache Manager Basic Configuration (QzhtRtvTCMBasicConfig) API

Important: Information for this topic supports the latest PTF levels for HTTP Server for i5/OS . It is recommended that you install the latest PTFs to upgrade to the latest level of the HTTP Server for i5/OS. Some of the topics documented here are not available prior to this update. See http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm Link outside Information Center for more information.
Required Parameter Group:
1 receiver variable Output Char(*)
2 length of receiver variable Input Binary(4)
3 receiver variable format Input Char(8)
4 server name Input Char(32)
5 error code I/O Char(*)
Library Name/Service Program: QTCM/QZHTINCONF
Threadsafe: Yes

Use the QzhtRtvTCMBasicConfig API to retrieve the basic configuration information for a triggered cache manager server. The API is a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB.

The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.

Authorities and locks

Required parameter group

receiver variable
OUTPUT: CHAR(*)

The variable used to return the basic configuration information for the triggered cache manager server.

length of receiver variable
INPUT: BINARY(4)

The number of bytes that the calling program provides for receiver variable. This value must be greater than or equal to 8.

receiver variable format
INPUT: CHAR(8)

The format name of receiver variable data. The following values must be used:

  • INDG0200: Detailed information format for server data.
server name
INPUT: CHAR(32)

The name used to identify the triggered cache manager server from which the configuration information is retrieved (left justified and padded with blanks if necessary).

error code
I/O: CHAR(*)

The structure in which to return error information.

INDG0200 format

Offset Type Field
Dec Hex
0 0 Binary(4) Bytes returned
4 4 Binary(4) Bytes available
8 8 Char(32) Server name
40 28 Binary(4) Autostart property
44 2C Binary(4) Local TCP port
48 30 Binary(4) Offset to root directory
52 34 Binary(4) Length of root directory
56 38 Binary(4) Maximum number of entries
60 3C Binary(4) Defer time between retries
64 40 Binary(4) Memory buffer size
    Binary(4) Root directory

Field descriptions

Autostart property
Specifies if the new triggered cache manager server is to start when startup of *AUTOSTART triggered cache manager servers, is requested. Usually *AUTOSTART servers are requested to start when TCP/IP is started, however they may also be requested via the STRTCPSVR command or QzhtStrTCMServer API. The default value is 0 (QZHT_NO).

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The server is set to start when startup of *AUTOSTART servers is requested.
2 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The server is not set to start when startup of *AUTOSTART servers is requested.
Bytes available
The number of information bytes available for return to the caller of the API.
Note: If this value is greater than the value of Bytes returned, the receiver variable was not large enough to return all information.
Bytes returned
The number of information bytes returned to the caller of the API.
Defer time between retries
The number of seconds the triggered cache manager server waits between retry attempts for a failing action. The value returned is greater than 0 and less than 231 (or 2.147x109), or equal to the following special value: 0 QZHT_NONE: No defer time is used.
Length of root directory
The length of the information for the root directory entry.
Local TCP port
The number of one of the TCP ports used by the triggered cache manager server. The return value is greater than 0 and less than 65536.
Maximum number of entries
The maximum number of time the triggered cache manager server attempts to retry a failing action. The return value is greater than -1 and less than 231 (or 2.147x109), or equal to one of the special values described below.

Special values and their meanings are as follows:

0 QZHT_NONE: Failing actions are not retried.
-3 QZHT_NOMAX: Retry failing actions until successful.
Memory buffer size
The maximum amount of working data the triggered cache manager server attempts to store in memory, in bytes. The return value is greater than -1 and less than 231 (or 2.147x109) bytes.
Offset to root directory
The offset from the beginning of the request variable to the root directory data, in bytes.
Root directory
The name of the local file system directory in which the triggered cache manager server maintains its persistent record of incoming transactions, left justified and padded with blanks if necessary.
Server name
The name of the triggered cache manager server for which the configuration information is retrieved (left justified and padded with blanks if necessary).

Error messages

TCM7001 E
User &1 is not authorized.
TCM7030 E
Severe error occurred while addressing parameter list.
TCM7032 E
Receiver variable format is not valid.
TCM7034 E
Length of receiver variable is not valid for the specified format.
TCM7035 E
Server parameter is not valid.
TCM703E E
Error code parameter is not valid.
TCM70F0 E
Unknown error occurred while processing request.
TCM7101 E
User QTCM is not authorized to the configuration file for triggered cache manager server &1.
TCM7190 E
A configuration file for triggered cache manager server &1 was not found.