Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Group Methods › GetAgent Method—Retrieves the Specified Agent Object from the Group

GetAgent Method—Retrieves the Specified Agent Object from the Group

The GetAgent method retrieves the specified agent object from the group.

Syntax

The GetAgent method has the following format:

Netegrity::PolicyMgtGroup‑>GetAgent(agentName)

Parameters

The GetAgent method accepts the following parameter:

agentName (string)

Specifies the name of the agent to retrieve.

Return Value

The GetAgent method returns one of the following values:

• A PolicyMgtAgent object
• undef if no such agent is found, if the group contains objects of another type, or if the call was unsuccessful