XNA Game Studio Cleanup Tool User's Guide

Introduction

The XNA Game Studio cleanup tool is designed to automatically perform a set of steps to remove selected versions of XNA Game Studio from a computer.  It will remove files, directories, registry keys and values and Windows Installer product registration information for XNA Game Studio.  The tool is intended primarily to return your system to a known (relatively clean) state in case you are encountering XNA Game Studio installation, uninstallation or repair errors so that you can try to install again.

There is a very important caveat that you should review before using this tool to remove any version of XNA Game Studio from your system:

• This tool is designed as a last resort for cases where install, uninstall, repair or patch installation did not succeed for unusual reasons.  It is not a substitute for the standard uninstall procedure.  You should try to uninstall XNA Game Studio from Add/Remove Programs prior to using this tool.

Download location

The XNA Game Studio cleanup tool is available for download at the following locations:

• http://cid-27e6a35d1a492af7.skydrive.live.com/self.aspx/Blog%7C_Tools/xnags%7C_cleanup%7C_tool.zip
• http://blogs.msdn.com/cfs-file.ashx/__key/CommunityServer-Components-PostAttachments/00-09-54-43-20/xnags_5F00_cleanup_5F00_tool.zip

The .zip file that contains the tool also contains a file named history.txt that lists when the most recent version of the tool was published and what changes have been made to the tool over time.

Supported products

The XNA Game Studio cleanup tool supports removing the following products:

• XNA Game Studio 2.0
• XNA Game Studio 3.0
• XNA Game Studio 3.1
• XNA Game Studio 4.0
• XNA Game Studio 4.0 Refresh
• Windows Phone Developer Tools 7.0
• Windows Phone SDK 7.1

Silent installation mode

The XNA Game Studio cleanup tool supports running in silent mode.  In this mode, the tool will run without showing any UI, and the user must pass in a version of XNA Game Studio to remove as a command line parameter.  To run the cleanup tool in silent mode, you need to download the cleanup tool, extract the file cleanup_tool.exe from the zip file, and then run it using syntax like the following:

cleanup_tool.exe /q:a /c:"cleanup.exe /p <name of product to remove>"

The value that you pass with the /p switch to replace <name of product to remove> in this example must exactly match one of the products listed in the Supported products section above.  For example, if you would like to run the cleanup tool in silent mode and remove XNA Game Studio 3.0, you would use a command line like the following:

cleanup_tool.exe /q:a /c:"cleanup.exe /p XNA Game Studio 3.0"

Unattended installation mode

The XNA Game Studio cleanup tool supports running in unattended mode.  In this mode, the tool will run and only show a progress dialog during removal, but will require no user interaction.  Unattended mode requires the user to pass in a version of XNA Game Studio to remove as a command line parameter.  To run the cleanup tool in unattended mode, you need to download the cleanup tool, extract the file cleanup_tool.exe from the zip file, and then run it using syntax like the following:

cleanup_tool.exe /q:a /c:"cleanup.exe /p <name of product to remove> /u"

For example, if you would like to run the cleanup tool in unattended mode and remove XNA Game Studio 2.0, you would use a command line like the following:

cleanup_tool.exe /q:a /c:"cleanup.exe /p XNA Game Studio 2.0 /u" 

Exit codes

The cleanup tool can return the following exit codes:

• 0 - cleanup completed successfully for the specified product
• 3010 - cleanup completed successfully for the specified product and a reboot is required to complete the cleanup process
• 1 - cleanup tool requires administrative privileges on the machine
• 2 - the required file cleanup.ini was not found in the same path as cleanup.exe
• 4 - a product name was passed in that does not exist in cleanup.ini
• 100 - cleanup was able to start but failed during the cleanup process
• 1602 - cleanup was cancelled

Log files

The cleanup tool creates the following log files:

• %temp%\cleanup_main.log - a log of all activity during each run of the cleanup tool; this is a superset of the logs listed below as well as some additional information
• %temp%\cleanup_actions.log - a log of actions taken during removal of each product; it will list files that it finds and removes, product codes it tries to remove, registry entries it tries to remove, etc.
• %temp%\cleanup_errors.log - a log of errors and warnings encountered druing each run of the cleanup tool