Runs the agent.

Defined in

NotesAgent

Syntax

status = notesAgent.Run( [ noteID$ ] )

Parameter

noteID$

String. Optional. The note ID of a document. The value is passed to the ParameterDocID property of the called agent.

Return value

status

Integer. Status of the operation where 0 indicates success.

This method runs any agent regardless of source language (simple action, formula, LotusScript, Java).

You cannot run an agent recursively (cannot call it from itself).

The user cannot interact directly with a called agent. User output goes to the Domino log.

You cannot debug a called agent.

For COM applications, the Notes program directory must be in the application path.

Language cross-reference

run in Java Agent class

AgentRun @command in formula language

ToolsRunMacro @command in formula language

RunAgent @command in formula language

Example
See Also

Accessing agents

Glossary