Retrieve Triggered Cache Manager Host Description (QzhtRtvTCMHostDesc) 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 description name Input Char(32)
6 error code I/O Char(*)
Library Name/Service Program: QTCM/QZHTINCONF
Threadsafe: Yes

Use the QzhtRtvTCMHostDesc API to retrieve information from host descriptions associated with triggered cache manager servers. 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 host description information.

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:

  • HSDG0100: Basic information format for a host description.
server name
INPUT: CHAR(32)

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

description name
INPUT: CHAR(32)

The name used to identify the retrieved host description information (left justified and padded with blanks if necessary).

error code
I/O: CHAR(*)

The structure in which to return error information.

HSDG0100 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 Char(32) Host description name
72 48 Binary(4) Default property
76 4C Char(256) IP interface

Field descriptions

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.
Default property
Specifies if the new description is the default host description for the triggered cache manager server specified in Server name. The value must equal to one of the special values described below.

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is the default host description for this server.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description is not the default host description.
Note: Data source, cache target, and acknowledgment target descriptions, added or changed using the *DEFAULT special value, reference the host description designated as default at the time they are added or changed.
Host description name
The name used by the host description (left justified and padded with blanks if necessary).
IP interface
The IP host name or address of the system hosting servers used by the triggered cache manager server (left justified and padded with blanks if necessary). The value must be a host name (for example, server.mycompany.com), dotted address (for example, 192.168.3.57).
Server name
The name of the triggered cache manager server for which the description is associated (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.
TCM7036 E
Description parameter is not valid.
TCM703E E
Error code parameter is not valid
TCM70F0 E
Unknown error occurred while processing request.
TCM7101 D
User QTCM is not authorized to the configuration file for triggered cache manager server &1.
TCM7190 D
A configuration file for triggered cache manager server &1 was not found.
TCM7290 D
&1 &2 was not found for triggered cache manager server &3.