Programming Guides › Programming Guide for Perl › CLI Agent API Methods › User Methods › Logout Method—Logs the User out of the Session

Logout Method—Logs the User out of the Session

The Logout method logs the user out of the session. Calling this method is optional, because the user is automatically logged out when the user object exceeds its scope in the Perl script.

Syntax

The Logout method has the following format:

Netegrity::AgentUser‑>Logout()

Parameters

The Logout method accepts no parameters.

Return Value

The Logout method returns one of the following values:

• SM_AGENTAPI_YES (value = 1)

  Specifies that the user logged out successfully.

• SM_AGENTAPI_NO (value = 2)

  Specifies that user logout failed.

• SM_AGENTAPI_CHALLENGE (value = 3)

  Specifies that a challenge is required for authentication.

• SM_AGENTAPI_FAILURE (value = -1)

  Specifies that the operation failed.

• SM_AGENTAPI_TIMEOUT (value = -2)

  Specifies that the method timed out.

• SM_AGENTAPI_NOCONNECTION (value = -3)

  Specifies that the object was not connected.

Remarks

Calling Logout while one user is impersonating another user ends the impersonation session and restores the impersonator's original session. Calling AgentUser‑>Impersonate allows one user to impersonate or log in as another user.