SetSessionParameter

The command SetSessionParameter can be used to assign a value to a session parameter. Session parameters can be used to store values between jobs which are associated with the same session. The stored values can be retrieved using the function get_sessionparameter. Refer to chapter Using ITP/Server sessions for more information on sessions.

Note

SetSessionParameter is implemented as a script component, which is part of the built-in ITP/Server script library. The script for SetSessionParameter is available in the subfolder Examples of the folder Scripts in the ITPWork folder. Refer to the section Script Component Examples for more information on how to use these examples.

Syntax

SetSessionParameter
   Par(<text>)
   Value(<text>);

Parameters

Par: Required.
The name of the session parameter.

Value:
The value that should be stored in the session parameter.

Example

SetSessionParameter
  Par ("plugh")
  Value ("plover");

Var Text X = get_sessionparameter ("plugh") 	# returns "plover"

Remarks

The command SetSessionParameter is a convenient interface to the function set_sessionparameter that does not return a value. The command SetSessionParameter and the function set_sessionparameter provide equivalent functionality.