BUG: Excel Does Not Shut Down After Calling the Quit Method When Automating from JScript

View products that this article applies to.

This article was previously published under Q266088

SYMPTOMS

When automating Microsoft Excel from Microsoft JScript, Excel stays in memory after calling the Quit method until you close Internet Explorer or navigate to another page.

Back to the top

JScript is holding on to a reference to Excel. Because there is a reference on Excel when you issue the Quit command, Excel does not shut down. JScript is a garbage collecting language, which means the engine cleans up after itself at a certain point, and not when you set the variables to NULL. When you shut down Internet Explorer or move to another page, the engine is destroyed. This behavior forces garbage collection and frees the reference to Excel.

Back to the top

RESOLUTION

To work around this problem, you can call the CollectGarbage method. This forces JScript's garbage collection to occur immediately, which releases the reference to Excel. The following code snippet illustrates how to use the CollectGarbage method:

<HTML> 
<BODY> 
<INPUT type="button" value="Automate Excel" name=AutomateExcel onclick="StartExcel()"> 
<SCRIPT LANGUAGE=Javascript> 
  var idTmr = "";


  function StartExcel() { 
    var oExcel; 

    oExcel = new ActiveXObject("Excel.Application"); 
    oExcel.Quit(); 
    oExcel = null;
    idTmr = window.setInterval("Cleanup();",1);
  } 

  function Cleanup() {
    window.clearInterval(idTmr);
    CollectGarbage();
  }

</SCRIPT> 
</BODY> 
</HTML>

Notice that the CollectGarbage method is not called directly after Excel's Quit method. You need to give JScript a small amount of time before calling CollectGarbage. A timer is used in this example to show how to wait briefly before forcing garbage collection.

Another workaround to this problem is to use VBScript for Automation of Microsoft Excel. Unlike JScript, VBScript is not a garbage collecting language and, therefore, references are released when you set the variables to Nothing. Using VBScript, Excel shuts down immediately after calling the Quit method and releasing the variables. Please see the "References" section of this article for more information.

NOTE: The undocumented CollectGarbage method is not part of the ECMA-262 specification, and may not be available in future versions of the scripting engine. When you force the garbage collector to run by calling CollectGarbage, this may also negatively impact performance.

Back to the top

STATUS

Microsoft has confirmed that this is a bug in the Microsoft products that are listed at the beginning of this article.

Back to the top

MORE INFORMATION

Steps to Reproduce Behavior

Start Notepad and paste the following code in the editor:

<HTML> 
<BODY> 
<INPUT type="button" value="Automate Excel" name=AutomateExcel onclick="StartExcel()"> 
<SCRIPT LANGUAGE=Javascript> 
  function StartExcel() { 
    var oExcel; 

    oExcel = new ActiveXObject("Excel.Application"); 
    oExcel.Quit(); 
    oExcel = null; 
  } 
</SCRIPT> 
</BODY> 
</HTML>

Save the file as JScriptTest.HTM, and then exit Notepad.
Double-click the JScriptTest.HTM file to load the file in Internet Explorer.
Start the Windows Task Manager.
Click the Automate Excel button on the Web page in Internet Explorer. Examine the Windows Task Manager, and note that Excel starts and stays in memory.
Navigate to another page or exit Internet Explorer. Note that Excel quits and no longer appears in Windows Task Manager.

Back to the top

REFERENCES

For additional information a VBScript code sample that demonstrates Automation to Excel, click the article number below to view the article in the Microsoft Knowledge Base:

198703 (http://support.microsoft.com/kb/198703/EN-US/ ) HOWTO: Automating Excel From Client-Side VBScript

For more information on Office Automation, please visit the Microsoft Office Development support site at:

http://support.microsoft.com/ofd (http://support.microsoft.com/ofd)

Back to the top