WINRESTORE Mnemonic - Restore a saved character window (Terminal Device)
Syntax
'WINRESTORE'(keystr)
'WINRESTORE'(windowID, keystr)
Description
|
Parameter |
Description |
|
keystr |
The text string identifier associated with the character window at the time it was saved. |
|
windowID |
The ID number that should be assigned to the restored character window, if it is not already in use by another window. |
In BBj 15.0 and higher, the 'WINRESTORE' mnemonic retrieves a copy of the window with the matching key string identifier from storage and adds it to the active list of character windows. The restored character window is displayed on the screen, responds to mnemonics, accepts input and updates normally. It appears exactly as the saved version of the window did when it was first put in storage, with the same attributes, content and cursor position.
The key string parameter is any arbitrary but unique name which serves as a key for identifying the saved character in the map. This key must be the same string that was used to save the character window in the original 'WINSAVE' operation, else the window cannot be located in the map and will not be restored. It does not correspond to the title of the character window (if the window has a title) or have any other purpose besides uniquely identifying the saved character window in the storage map.
The optional windowID parameter will be assigned to the restored character window if the ID number is not already in use by some other active window. When the 'WINRESTORE' mnemonic is used without supplying an ID number, the lowest free (not already in use) ID number will be automatically assigned to the restored window.
Restoring a character window does not remove the character window from the map of saved character windows; it makes a copy of the saved window instead. The 'WINRESTORE' mnemonic (without a specified windowID parameter) may therefore be used repeatedly to create many restored copies of a saved character window.
Restored character windows, like any other window, can be deleted with the 'POP' or 'DROP' mnemonics, which have no affect on the saved windows from which they were taken. Restoring a character window triggers a refresh of the screen in order to make the window visible once again.