Difference between revisions of "ISDBApplication::Objects"

From MediaMonkey Wiki
Jump to: navigation, search
(Added JScript example)
(Added note about CollectGarbage in JS.)
Line 9: Line 9:
  
 
A collection for temporary storage of any type of object during MediaMonkey running time. For example if a window is created by script that should remain visible while the script isn't running, the window object can be put into this collection in order to keep a reference to it. The keys of this collection are strings, the values can be only objects.
 
A collection for temporary storage of any type of object during MediaMonkey running time. For example if a window is created by script that should remain visible while the script isn't running, the window object can be put into this collection in order to keep a reference to it. The keys of this collection are strings, the values can be only objects.
 +
 +
Some MediaMonkey objects are destroyed when last reference to them is deleted (such as [[SDBUIForm|form]] or [[SDBProgress|progress bar]]). In JScript there may be a delay between last reference removal and object disposal. In this case you might want to consider calling [http://msdn.microsoft.com/en-us/library/ff955348%28v=vs.85%29.aspx CollectGarbage()] method to tell the interpret to dispose objects right now.
  
 
===Example VBScript code===                     
 
===Example VBScript code===                     
Line 38: Line 40:
  
 
SDB.Objects('MyWindowRef') = {'__empty': true}; // And now remove it from the collection by replacing with special empty object.
 
SDB.Objects('MyWindowRef') = {'__empty': true}; // And now remove it from the collection by replacing with special empty object.
 +
// CollectGarbage(); // Consider calling garbage collector when needing object disposal right now.
 
</source>
 
</source>
  

Revision as of 19:19, 20 April 2013

CoClass SDBApplication, Interface ISDBApplication

Property Get/Let Objects(Name As String) As Object


Parameters

Name Type Description
Name String An identifier for object storage.


Property description

A collection for temporary storage of any type of object during MediaMonkey running time. For example if a window is created by script that should remain visible while the script isn't running, the window object can be put into this collection in order to keep a reference to it. The keys of this collection are strings, the values can be only objects.

Some MediaMonkey objects are destroyed when last reference to them is deleted (such as form or progress bar). In JScript there may be a delay between last reference removal and object disposal. In this case you might want to consider calling CollectGarbage() method to tell the interpret to dispose objects right now.

Example VBScript code

If SDB.Objects("MyWindowRef") Is Nothing Then    ' If the object isn't in collection yet...
  Set SDB.Objects("MyWindowRef") = MyWindow      ' ... add it to the collection (using Set for objects)...
End If

' Some code here

SDB.Objects("MyWindowRef") = Nothing             '  ... and now remove it from the collection.

Example JScript code

if (!SDB.Objects('MyWindowRef')) { // If the object isn't in collection yet...
  SDB.Objects('MyWindowRef') = my_window; // add it to the collection.
}

To release the object from global storage, you cannot call delete SDB.Objects('MyWindowRef') nor do SDB.Objects('MyWindowRef') = null. Best way is to reassign the storage key with empty JScript object. Later on, if you want to access the object from global storage, you should additionally check for the empty object presence as shown below.

var ref = SDB.Objects('MyWindowRef'); // Get the reference...
if (!ref || (ref && !!ref.__empty)) { // If the object isn't in collection yet or there is the empty object instead...
  SDB.Objects('MyWindowRef') = my_window; // add it to the collection.
}

// Some code here

SDB.Objects('MyWindowRef') = {'__empty': true}; // And now remove it from the collection by replacing with special empty object.
// CollectGarbage(); // Consider calling garbage collector when needing object disposal right now.