Retrieve Triggered Cache Manager Object Dependency Graph Description (QzhtRtvTCMODGDesc) 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 QzhtRtvTCMODGDesc API retrieves information from object dependency graph (ODG) descriptions associated with triggered cache manager servers.

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 object dependency graph 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:

  • OGDG0100: Basic information format for an object dependency graph description.
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 object dependency graph description information is retrieved (left justified and padded with blanks if necessary).

error code
I/O: CHAR(*)

The structure in which to return error information.

OGDP0100 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) Object dependency graph description name
72 48 Binary(4) Default property
76 52 Binary(4) Allow API updates

Field descriptions

Allow API updates
Indicates whether APIs are allowed to update the object dependency graph described by the object dependency graph description. The value returned is one of the special values described below.

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The object dependency graph is updated using APIs via the triggered cache manager server, as well as from trigger handler publish parsing.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The object dependency graph is not updated using APIs via the triggered cache manager server. Only updates as a result of trigger handler publish parsing are allowed.
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
Number of bytes of information returned to the caller of the API.
Default property
Indicates whether the description is the current default object dependency graph description 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.
Object dependency graph description name
The name of the object dependency graph description (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 format specified.
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 to 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.