@IsAgentEnabled (Formula Language)

Indicates whether or not a scheduled agent is enabled.

Syntax

@IsAgentEnabled( agent )

Parameters

agent

Text. The name of the agent. Not case-sensitive.

Return value

flag

Number

  • 1 (True) indicates that the agent is enabled
  • 0 (False) indicates that the agent is disabled, or that an agent by that name does not exist

Usage

A database must be open. If a database is not open, returns 0.

@IsAgentEnabled returns 1 for macros created in Notes® Release 3, and for any agents that are not scheduled.

@IsAgentEnabled does not work in column or selection formulas and is not intended for use in window title or form formulas.

You cannot use this function in Web applications.

Examples

This example returns 1 if the UnderCover agent is enabled; otherwise, it returns 0.
@IsAgentEnabled( "UnderCover" )