Retrieve Triggered Cache Manager Rule Set (QzhtRtvTCMRuleSet) 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

The QzhtRtvTCMRuleSet API retrieves information from rule sets 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
INPUT: CHAR(*)

The variable used to return rule set 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 the receiver variable data. The following values must be used:

  • RSDG0100: Basic information format for a rule set.
server name
INPUT: CHAR(32)

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

description name
INPUT: CHAR(32)

The name used to identify which rule set information is retrieved (left justified and padded with blanks if necessary).

error code
I/O: CHAR(*)

The structure in which to return error information.

RSDG0100 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) Rule set name
72 48 Binary(4) Default property
76 52 Binary(4) Offset to publishing rules
80 56 Binary(4) Length of publishing rules
    Char(*) Publishing rules

RSDG0100 format 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
BINARY(4)

The number of bytes of information returned to the caller of the API.

Default property
Indicates whether the description is the current default rule set for the triggered cache manager server specified in Server name. The returned value equals 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 current default for this server.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description is not the current default.
Length of publishing rules
The length of the information returned for the Publishing rules entry.
Offset to publishing rules
The offset from the beginning of the receiver variable to the Publishing rules data, in bytes. The value returned is greater than 0, or equal to one of the special values described below.

Special values and their meanings are as follows:

0 QZHT_NONE: The value is null for Publishing rules.
Publishing rules
The list of publishing rules currently referenced are listed by name, separated by one (left justified and padded with blanks if necessary).
Note: If the value is null, Offset to publishing rules equals 0 (QZHT_NONE), indicating that an empty rule set is described. An empty rule set referenced by a trigger handler causes it to process all triggers according to the default publishing rule.
Rule set object name
The name of the rule set (left justified and padded with blanks if necessary).
Server name
The name of the triggered cache manager server with 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 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.
TCM7290 E
&1&2 was not found for triggered cache manager server &3.