verifCloseSession
verifCloseSession(
g_sessionId
[ ?saveIfModified g_saveIfModified ]
)
=> t / nil
Description
Closes a Verifier session.
Arguments
|
g_sessionId
|
Integer, string number, or window specifying the Verifier session ID. For example, 0, "0", or window(2).
|
|
?saveIfModified g_saveIfModified
|
|
|
A boolean which controls whether to save the session, or discard any changes if it is modified. If any value is not specified and the session has been modified, then a question dialog prompts to either save or discard the changes.
|
|
g_sessionId
|
Integer, string number, or window specifying the Verifier session ID. For example, 0, "0", or window(2).
|
|
?saveIfModified g_saveIfModified
|
|
|
A boolean which controls whether to save the session, or discard any changes if it is modified. If any value is not specified and the session has been modified, then a question dialog prompts to either save or discard the changes.
|
Value Returned
This is a sample lead-in
|
t
|
Specified Verifier session was closed successfully.
|
|
nil
|
Specified Verifier session was not opened or the command was unsuccessful.
|
Examples
The following example starts a Verifier cellview and adds a requirement. It then saves the cellview and closes the session using verifCloseSession.
sess = verifOpenCellView("test" "sample" "verifier")
=> 0
Closes the unmodified session
verifCloseSession(sess)
sess = verifOpenCellView("test" "sample" "verifier")
=> 1
Now modifies it by adding a requirement
verifAddReq(0 "A Requirement")
=> t
Will save then close the session - if saveIfModified is set to nil, the changes would be discarded before closing.
verifCloseSession(sess ?saveIfModified t)
=> t
Related Topics
verifSaveSession
verifSaveSessionAs
Verifier Session and Setup Functions
Return to top
