› KCM Core Scripting Language Developer's Guide › Commands › SetSessionParameter

SetSessionParameter

You can use the command SetSessionParameter to assign a value to a session parameter. Use session parameters to store values between jobs associated with the same session. The stored values are retrieved using the function get_sessionparameter. For more information, see Use KCM Core sessions.

SetSessionParameter is implemented as a script component and is part of the built-in KCM Core script library. The script for SetSessionParameter is available in: <deploy root>\KCM\Documentation\5.7\Resources\Examples\Core Scripting. For more information, see Examples of script components.

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 an interface to the function set_sessionparameter that does not return a value. The command SetSessionParameter and the function set_sessionparameter provide equivalent functionality.

Session parameters with names starting with _itp and ITP are reserved for internal use in KCM products.