Previous Topic

Next Topic

Book Contents

Book Index

4. Search

The Search function can be used to

which satisfy the selection criteria.

It can be called from any environment. When invoking the SEARCH via CTMBAPI mode the selected AJF entry of the job(s) are returned to the caller. In all other environments, only the selected job list and return code, indicating whether or not the job(s) exist in the AJF, are returned to the caller.

This function should only be used when you want to execute your own process based on the result of this search or you simply want to list the jobs which satisfy the search criteria. If you want to execute one of the other CTMAPI functions based on the Search result, it is recommended that you use the conditional form of that function instead.

The full syntax for the Search call is as follows:

SEARCH selection_criteria [selection_criteria]…

The various valid selection_criteria are described in Conditional Requests and Selection Criteria and Table 282 in Conditional Requests and Selection Criteria.

Parent Topic

The Control-M Application Program Interface (CTMAPI)