_purgeAgentRunInfo

_purgeAgentRunInfo

Purge the run instance spool of the agent.

Syntax
Syntax Description

Syntax

CALL SEND(agentInst, '_purgeAgentRunInfo ',
agentName, runKey, rc);

Where... Is type... And represents...

agentName C name of agent to purge

runKey N run instance key

rc N return code

_purgeAgentRunInfo method: purges the spool from a specific run instance that is identified by the agentName and the runKey parameters.
agentName: is an agent that has been defined to the DOMAIN server by using the _defineAgent method.
runKey: is returned from the _runAgent method and is used to retrieve the run information for this particular run.
rc: indicates the success or failure of the purge.