Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Session Methods › AddParameter Method—Adds Session Variable Name-Value Pair to Parameters List

AddParameter Method—Adds Session Variable Name-Value Pair to Parameters List

The AddParameter method adds a session variable name-value pair to a parameters list. Session variables contain data about the client application, such as business logic, certificate information, and SAML assertions for Affiliate applications. This data is bound to a user session.

Syntax

The AddParameter method has the following format:

Netegrity::AgentSession‑>AddParameter(varName [,varValue][, varFlag])

Parameters

The AddParameter method accepts the following parameters:

varName (string)

Specifies the name of the variable to add to the parameter list.

Limit: Maximum length is 255 characters.

varValue (string)

(Optional) Specifies the value of the variable to be added to the parameter list.

Limit: Maximum length is determined by the target data store.

varFlag (int)

(Optional) Specifies whether the GetVariables method deletes the variable name-value pair from the session store:

• 0 (zero)

  Specifies that GetVariables retrieves the variable name-value pair from the session store, but does not delete it.

• 1 (one)

  Specifies that GetVariables retrieves the variable name-value pair from the session store and then deletes it.

Return Value

The AddParameter method does not return a value.

Remarks

You can manage the name-value pairs in the parameters list by calling these session variable methods:

• AgentSession‑>DelVariables
• AgentSession‑>GetVariables
• AgentSession‑>SetVariables

To manage multiple variables, call AddParameter once for each variable before calling the AgentSession‑>DelVariables, AgentSession‑>GetVariables, and AgentSession‑>SetVariables methods. While AddParameter adds variables to the parameters list, AgentSession‑>DelVariables, AgentSession‑>GetVariables, and AgentSession‑>SetVariables clear the parameters list.

Before you can use the session variable methods, the following conditions must be met:

• A persistent session must be created in at least one realm.
• The SiteMinder session server must be enabled.

Note: For more information, see the Policy Server Administration Guide and the Policy Server Configuration Guide.