Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Session Methods › GetVariables Method—Retrieves Session Variables from Session Store

GetVariables Method—Retrieves Session Variables from Session Store

The GetVariables method retrieves the session variables in the parameters list from the session store. Call AgentSession‑>AddParameter first to specify the variables in the parameters list. To delete a variable from the session store after it is retrieved, call AgentSession‑>AddParameter with varFlag set to 1 (one).

Syntax

The GetVariables method has the following format:

Netegrity::AgentSession‑>GetVariables()

Parameters

The GetVariables method accepts no parameters.

Return Value

The GetVariables method returns the following value:

• AgentResponseAttr (array)

Note: Some session variables cannot be retrieved. To check for these, call AgentResponseAttr‑>GetFlags for the associated AgentResponseAttr object and test for the following return value:

SM_AGENTAPI_RESPATTR_FLAGS_UNRESOLVED (value = 2)

Remarks

The GetVariables method clears the parameters list.