Login Method—Performs Session Login and Validation

The Login method performs session login and validation. Before calling this method, call AgentResource‑>IsProtected for the target resource.

Syntax

The Login method has the following format:

Netegrity::AgentUser‑>Login(resource[, clientIP])

Parameters

The Login method accepts the following parameters:

resource (AgentResource object)

Specifies the resource to log in to.

clientIP (string)

(Optional) Specifies the client's IP address.

Return Value

The Login method returns one of the following values:

SM_AGENTAPI_YES (value = 1)
Specifies that user login was successful.
SM_AGENTAPI_NO (value = 2)
Specifies that user login 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

To allow one user, who is already logged in, to log in again as another user, call AgentUser‑>Impersonate.