RestoreSession

ITP/Server will create a new session and load its state from a previously saved session. Refer to chapter Using ITP/Server sessions for more information on sessions.

The command RestoreSession will fail if the active job has already been associated with a session.

Syntax

RestoreSession
   Archive(<text>)
   RequireEncryption(True or False);

Parameters

Archive: Required.
Provides the name of a file in which the state of the session was saved earlier using the command SaveSession.

RequireEncryption: Optional.
Indicates whether or not non-encrypted session archives can be restored. If this parameter is set to True only encrypted archives are accepted.

Remarks

The command RestoreSession will restore the session parameters and files in the directory _sessiondir. It is possible to restore a saved session more than once. Each restored session will receive a different unique session identifier.

If the command RestoreSession completes successfully, the variable _restored_session will contain the original session identifier of the saved session.

Note

The command RestoreSession will validate the archive's validity before restoring the session. If the archive fails this check an error will be issued and the command RestoreSession will fail.