Wednesday, April 12, 2006 - Posts

WIX - CustomActions using VBScript

Here are some small tips when using VBScript CustomActions using WIX.

Creating a script CustomAction
First of all you have to create a CustomAction in your WXS file:

Id_Of_ScriptAction is a unique Id of your CustomAction
ID_of_binary is the unique Id of the binary that contains the vbs file.
Script_Name is the name of the Sub or Function in your vbs file.

Creating the VBS file
Create a .VBS file with a function or sub that should be executed.
Sub DoThis
   MsgBox "Hello there..."
End Sub


Add a Binary to the WXS file
After creating the script you have to include it into your WXS file. This is done by creating a Binary element like this:

Id_of_binary is a unique id
Local_Path is a local path (relative to the wxs file)

Add the action to the install sequence
After doing all this you have to tell the installer when and where to execute the custom action, this is done by adding the action to the InstallExecuteSequence element

...
Condition
...

Id_Of_ScriptAction is your custom action.
For more information on the Custom element and the After/Before/Sequence attributes, check out the WIX help file and/or this tutorial.
Note: The Execute attribute of the Custom element should be Deferred to execute during the install sequence or Immediate to execute it while the install script is executed, see MSDN for more information on this.


This blog has moved to http://www.wictorwilen.se/.