Previous Topic

Next Topic

Book Contents

Book Index

Invoking the Rule Search API

Use the following call statement to invoke the Control‑M/Tape Rule Search API:

CALL   CTTRSR,(func-addr,tct-address,rso-address,expdt,rlm-address,IOA-trace-header- address,rsi-address)

Table 255 Fields for Invoking the Rule Search API

Field

Description

func-addr

 

The address of a function specification that indicates the action to be performed by the API. The address specified in this field points to a one‑byte character that indicates the function to be performed by the API.

You can specify the following function types:

  • R—Return only the DO statements that are triggered in response to the specified selection criteria. This function creates only an RLM control block. The RSI address (see field rsi-address in this table) need not be specified.
  • O—Return only the information about the rules triggered by the specified selection criteria. This function creates only an RSI control block.
  • I—Return the DO statements and rule information. This function creates both the RLM and RSI control blocks. For more information, see RLM Control Block and RSI Control Block, respectively.
  • F—Free control blocks RLM and RSI (that were created by previous runs of the Rule Search API). This function must be specified in the last call to the API.

tct-address

Address of the Real-Time TCT.

rso-address

Address of the RSO block (Input) within the user program that is calling the Rule Search API.

expdt

JCL EXPDT keyword to be associated with the specified selection criteria. If no keyword is needed, specify 0 for this argument in the CALL statement.

rlm-address

Address of a full‑word in which to return the address of the RLM control block. For more information, see RSI Control Block.

IOA-trace-header-address

Address of IOA-trace-header, starting with MCT’s MCTTRCHD.

rsi-address

Address of a full‑word in which to return the address of the RSI control block. For more information, see RSI Control Block.

Parent Topic

Rule Search API