Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Session Methods › IdleTimeout Method—Retrieves Session's Idle Timeout Value

IdleTimeout Method—Retrieves Session's Idle Timeout Value

The IdleTimeout method retrieves the session's idle timeout value in seconds. The idle timeout value is the maximum length of time a user session can be inactive. When this time is exceeded, the session is no longer valid and the user must re-authenticate.

Syntax

The IdleTimeout method has the following format:

Netegrity::AgentSession‑>IdleTimeout()

Parameters

The IdleTimeout method accepts no parameters.

Return Value

The IdleTimeout method returns the following value:

• idle_timeout_value (long)