Description

Pop.Session is a subroutine that restores the current environment parameters saved by a preceding call to Push.Session.

Syntax

Pop.Session(cursor.loc, sentence, record, id, dict, mv)

Using Pop.Session

Use Pop.Session to restore an environment after use of Push.Session. The saved values are passed from the Push.Session argument list.

Parameters

The Push.Session subroutine has the following parameters:

ParameterDescription
cursor.locUse cursor.loc to pass the cursor position saved by Push.Session.
sentenceUse sentence to pass the TCL sentence saved by Push.Session.
recordUse record to pass the record saved by Push.Session.
idUse id to pass record key saved by Push.Session.
dictUse dict to pass the dictionary variable saved by Push.Session.
mvUse mv to pass the array of @MV, @INSERT (see Appendix I, "System Variables"), and video attributes saved by Push.Session.

Values Returned

None.

See also

Push.Session subroutine

Example

/* The following code demonstrates the use of Pop.Session */
Declare subroutine Push.Session, Pop.Session, Msg
Push.Session(cursor, sentence, record, id, dict, mv)
* Call a subroutine that modified the environment parameters.
Gosub Change_Environ
Pop.Session(cursor, sentence, record, id, dict, mv)


  • No labels

1 Comment

  1. PSA for this routine and the companion Push.Session Subroutine. While these do work in OpenInsight, they are still technically considered AREV commands and as such might create unexpected problems. For instance, we discovered that when executed during a web API procedure, this would result in the OECGI call failing and returning a 502 Bad Gateway error. With Bryan Shumsky's help, we figured out that these routines are designed to update the AREV UI. In AREV32 this is handled through SEND_DYN which then communicates to the engine. This results in the API response being corrupted because it is being pushed through the same stream.