| 1 | End type | Input | Char(10) |
| 2 | Delay time | Input | Binary(4) |
| 3 | Error Code | I/O | Char(*) |
The End PM Agent (Q1PENDPM) API ends the Performance Management Agent (PM Agent) jobs. PM Agent jobs will not run again until the Start PM Agent (Q1PSTRPM) API is issued or the function is configured by using any of the Configure PM Agent (CFGPMAGT or CFGPM400) commands.
The PM Agent jobs to have controlled endings or the jobs that are to be ended immediately. The possible values are:
| *CNTRLD | The PM Agent jobs end in a controlled manner. |
| *IMMED | The PM Agent jobs end immediately. The programs that are running do not get time to perform cleanup. This option may cause undesirable results if data has been partially updated. Therefore, this option should be used only if a controlled end was unsuccessful. |
The delay time when "End type" is *CNTRLD. This parameter is ignored if "End type" is *IMMED. The possible values are:
| -1 | The PM Agent jobs continue processing until the activity processing currently is complete. |
| Delay time (seconds) | The PM Agent jobs end immediately after the delay time. |
The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.
| Message ID | Error Message Text |
|---|---|
| CPFB03A E | Range of parameter &2 does not include &4. |
| CPFB03D E | PM Agent not active. |
| CPFB03E E | PM Agent already ending with *IMMED option. |
| CPFB03F E | PM Agent already ending with *CNTRLD option. |
| CPF24B4 E | Severe error addressing parameter list. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
[ Back to top | Performance Management APIs | APIs by category ]