File: preunload.html

package info (click to toggle)
pcb-rnd 3.1.7b-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,108 kB
  • sloc: ansic: 213,400; yacc: 6,241; sh: 4,698; awk: 3,016; makefile: 2,254; lex: 1,166; python: 519; xml: 261; lisp: 154; tcl: 67; perl: 34; javascript: 6; ruby: 5
file content (15 lines) | stat: -rw-r--r-- 783 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<act>preunload</act> is an optional action scripts may provide. When present,
it is called by pcb-rnd as the last call to the script before the script is
unloaded. It has two purposes:
<ul>
	<li> give scripts a chance to clean up, uninit and unregister
	<li> give scripts a chance to perist their state
</ul>
<p>
State persisting is achieved through returning a string from this action. That
string is then saved by pcb-rnd under the scripts' load ID (as specified by
the user). In a later script load, the script with the same ID may read the
persistent data frolm disk using the <act>ScriptPersistency</act>(read) action
and can remove the save using the <act>ScriptPersistency</act>(remove) action.
<p>
<b>It should never be called by the user or other code or other actions.</b>