Rule Search API

The Control‑M/Tape Rule Search API is a powerful tool that can be used to determine what actions (DO statements) is triggered when a given set of selection criteria (specified using ON statements) is satisfied.

To use the Control‑M/Tape Rule Search API, perform the following steps:

1. Use the CTTGTCT macro to obtain the address of the Control‑M/Tape Control Table (TCT) of the real-time Environment. For additional information, see Obtaining the Address of the Real-Time TCT. 
2. Specify desired selection criteria (that is, ON statements) using the RSO block. For more information, see Input.  
3. Call the Rule Search API with the necessary arguments specified.
4. Analyze the information returned by the Rule Search API in the RLM and RSI control blocks.

   Note: The Control‑M/Tape Rule Search API searches only the rules currently in memory. If new rules were defined but are not yet loaded, refresh the Control‑M/Tape rules before invoking the Rule Search API.