Difference between revisions of "ISDBScriptControl::Terminate"

From MediaMonkey Wiki
Jump to: navigation, search
m (added description)
(style)
 
Line 3: Line 3:
 
===Property description===
 
===Property description===
  
Returns ''True'' if MediaMonkey wants to terminate the script, e.g. because the user commanded so.
+
Returns <tt>TRUE</tt> if MediaMonkey wants to terminate the script, e.g. because the user commanded so.
  
A script should regularly check this property if it's doing long-running work, e.g. before it enters a long loop. If the ''Terminate'' property returns ''True'', the script should terminate as safe and quickly as possible.
+
A script should regularly check this property if it's doing long-running work, e.g. in each iteration of long loop. If the ''Terminate'' property returns <tt>TRUE</tt>, the script should terminate as safe and quickly as possible.
  
 
[[Category:Scripting|{{PAGENAME}}]]
 
[[Category:Scripting|{{PAGENAME}}]]

Latest revision as of 20:27, 20 April 2013

CoClass SDBScriptControl, Interface ISDBScriptControl

Property Get Terminate As Boolean


Property description

Returns TRUE if MediaMonkey wants to terminate the script, e.g. because the user commanded so.

A script should regularly check this property if it's doing long-running work, e.g. in each iteration of long loop. If the Terminate property returns TRUE, the script should terminate as safe and quickly as possible.