PropertyCa

MAKEMSI quickly and reliably creates MSI files in a non-programmatic way

Source Code

Commands

PropertyCa

The "PropertyCa" Command

This command is used to create or update the value of a Windows Installer property (or directory key).

This command differs from the "Property" command in that the property assignment is scheduled as a custom action type 51 (or 35 for directories). This allows you to "capture" the current value of properties at runtime.

This command takes these parameters:

Property Name (positional)
This is one of:
- Name of a property to be updated or created.
- Name of a directory to be updated. Its name should only contain upper case characters.
[*]Value (required)
The value of the property.
You should use "*VALUE" if you have a VBSCRIPT expression which resolves to a string (use "cstr()" if you get a type mismatch).
Any MSI formatting will be replaced which is a major difference from the "Property" command.
DIR (optional)

This should be Y/N, "Y" indicates that the "property" is a directory key in the ("Directory" table ).
If you want to set the location of a directory then you you need to look at where you wish to sequence it, if this is after "CostFinalize" then pass "Y" to this parameter else pass "N" ("CostFinalize" will apply the property of the same name to the directory).
Seq (required)
Actions are executed in sequence number order and some actions (or types of) are only allowed at certain "locations". This parameter allows you to specify when this action should be executed in relation to others. The fact that MAKEMSI successfully sequences your action at a particular location should not be assumed to mean that it is valid for it to be there.
There will typically be a lot of standard actions at known fixed locations (which may however differ in sequence number or even order relative to one another with different templates). Click here for the default "InstallExecuteSequence" and "InstallUISequence" sequencing details.
Normally you try not to duplicate sequence numbers but it is probably OK to do so as long as you don't care which one executes first! One possible exception would be deferred custom actions where the custom action data needs to be setup before execution. You should get a validation message to indicate a duplicated number (note that validation can't know whether custom action conditions are mutually exclusive etc).
The sequencing information (see some default sequencing) can be supplied in a number of formats:
- An Integer
  If you supply a number such as "1001" then this is a literal numeric value which generally should not duplicate any other in the same table. I suggest you only use this format as a last resort!
- A VBSCRIPT Expression
  If the value you supply starts with "@" then what follows is the name of a VBSCRIPT variable or expression which will evaluate to a sequence number.
- A MAKEMSI Expression
  MAKEMSI has its own syntax which describes the characteristics of the desired sequence number but leaves the actual value up to MAKEMSI to determine.
  Basically you describe a range of valid values and whether you prefer the value to be chosen from the lower (default) or higher end.
  The range should be specified in the format "lower - higher". Either value can be omitted, be specified as an integer such as "1000" or the name of an action such as "InstallFiles". The default value for the lower end is "1" and for the higher "32767" and leading and trailing spaces for each are stripped. The minimum and maximum values can be returned as the range is inclusive.
  By default MAKEMSI will choose a number as close as possible to the lower end, if you wish it to be as high as possible then begin the specification string with "<".
  Some Examples:
  - InstallFiles-
  - -InstallFiles
  - <-InstallFiles
  - < 1000 - 2000
  - AppSearch - CostFinalize
  You should of course be aware of what your script does, for example if it moves a custom action that you have already sequenced other actions relative to then that would probably be "bad"!
Key (optional)
This is the key for the custom action. If not supplied a default is chosen, however if you wish to have the same action occur more than once within a table you need to define a unique key. You would also define the KEY if you were setting up "CustomActionData".
SeqTable (optional)
This is the sequence table or tables you wish to use ("InstallExecuteSequence" table by default). The most common other table you might wish to use would be "InstallUISequence" table ). Use space as a delimiter if more than one table. An empty list is invalid!

Condition (optional)
This identifies the conditions under which the code should be executed. Any properties you set should be available before the "CostFinalize"" action.

I have captured a large number of "sample properties" which could be used in any conditions. Note that the values of some properties may not be available at all times and in some cases are modified during processing.

You can also use any of the following predefined conditions:

#define? CONDITION_ALREADY_INSTALLED Installed                          ;;Repair, uninstall etc.
#define? CONDITION_INSTALL_ONLY      not Installed                      ;;Doesn't include a repair, uninstall etc!
#define? CONDITION_UNINSTALL_ONLY    Installed and REMOVE~="ALL"        ;;Complete uninstall  - HIGHLY RECOMMENDED at you read the "REMOVE" properties MAKEMSI doco!
#define? CONDITION_EXCEPT_UNINSTALL  not (<$CONDITION_UNINSTALL_ONLY>)  ;;Install, Repair etc (all but complete uninstall)
#define? CONDITION_IS_WIN2000        VersionNT = "500"                  ;;Is OS WIN2000?
#define? CONDITION_IS_WINXP          VersionNT = "501"                  ;;Is OS WINXP?
#define? CONDITION_IS_VISTA          VersionNT = "600"                  ;;Is OS WINDOWS Vista?
#define? CONDITION_IS_WINDOWS_7      VersionNT = "601"                  ;;Is OS WINDOWS Windows7
#define? CONDITION_UI_NONE           UILevel = 2                        ;;Silent Install
#define? CONDITION_UI_BASIC          UILevel = 3
#define? CONDITION_UI_REDUCED        UILevel = 4
#define? CONDITION_UI_FULL           UILevel = 5                        ;;"Normal"
#define? CONDITION_UI_NO_DIALOGS     UILevel <> 5                       ;;Don't bother user with popup dialogs, opening readme files etc.
#define  CONDITION_PER_MACHINE       Version9X or (ALLUSERS = 1)        ;;True if per-machine install.
#define  CONDITION_PER_USER          not (<$CONDITION_PER_MACHINE>)     ;;True if per-user (not per-machine) install.

Type (optional)
This parameter may not be required for all custom action types, it provides a mechanism to override, update or undo any options that MAKEMSI may have decided to use.
This parameter accepts one or more space separated attributes which are processed in left to right order. Available attributes are (not all may apply):
1. Deferred
  This indicates that the custom action should be run deferred (not immediately). The opposite to the "Immediate" attribute and the default for most custom action types. If its deferred the "Description" will be displayed in the progress bar (line 1).
  A deferred (in-script) custom action must be sequenced between the "InstallInitialize" and "InstallFinalize" actions (or you will get a 2762 error) and data is passed via the "CustomActionData" property.
  All deferred actions are executed in a single pass by the server "MSIEXEC.EXE" service (a separate process) after being combined in a "script".
2. Immediate
  The "immediate" attribute is the opposite of "deferred".
  All immediate custom actions scheduled between the "InstallInitialize" and "InstallFinalize" actions (regardless of their sequence number) are executed before deferred ones.
3. Sync
  This indicates that Windows Installer should wait for the custom action to complete. The opposite to the "ASYNC" attribute and this is the default.
4. ASync
  The opposite to the "SYNC" attribute..
5. Rc0
  This indicates that the SET PROPERTY indicates success by returning a return code of 0. The opposite to the "AnyRc" attribute.
6. AnyRc
  The opposite to the "Rc0" attribute. The return code should be ignored.
  This should only be used as a last resort when executing some poorly written piece of "cr*p" (or perhaps if it's success is not critical to the install).
7. Commit
  This indicates that the custom action is a "commit" custom action.
8. Rollback
  This indicates that the custom action is a "rollback" custom action. It should be sequenced before the custom action being rolled back and have the same condition.
  Rollback custom actions (and so also the "worker" custom action) must be "deferred" and sequenced between "InstallInitialize" and "InstallFinalize".
9. Impersonate
  The custom action should be run under user-level privileges. This is the default. The opposite to the "System" attribute.
  There are circumstances where a custom action may still run with system privileges.
10. System
  The custom action should be run under the system account (elevated). The opposite to the "Impersonate" attribute.
  Lack of this attribute on deferred custom actions is a common reason for failures on Vista.
11. FirstSequence
  No effect in UI sequence. If the "UI sequence" did run and this action is in the "Execute sequence" then it won't run (whether or not your custom action is sequenced in the UI)
12. OncePerProcess
  Execute once per process if in both sequence tables. Skips action in execute sequence if UI sequence has been run in same process, for example both run in the client process. Used to prevent actions that modify the session state, such as property and database data, from running twice
13. ClientRepeat
  Execute only if running on client after UI sequence has run. The action runs only if the execute sequence is run on the client following UI sequence. May be used to provide either/or logic, or to suppress the UI related processing if already done for client session.
14. 64BitScript
  This is a 64-bit script based custom action. Form more information see the "64 Bit Installs" section.
15. HideTarget
  The installer is prevented from writing the value in the Target column of the CustomAction table into the log file.
  The CustomActionData property is also not logged when the installer executes the custom action.
  Because the installer sets the value of CustomActionData from a property with the same name as the custom action, that property must be listed in the "MsiHiddenProperties " property to prevent its value from appearing in the log.
16. TSAware
  Not sure, Microsoft don't document it (good one). If you have any issues with MSIs under terminal services then I'd guess this would be a good flag to try!
17. PatchUninstall [4.5+]
  Used to define a custom action that only runs during the uninstallation of a patch.
18. +[0x]Number
  A value beginning with "+" indicates that you wish to set (add) attribute(s)/bit(s).
  If the number begins with "0x" (case insensitive) then the number is being supplied as a hexadecimal value otherwise its interpreted as being in decimal.
  You may need to supply a numeric value such as "+0x0001" if I haven't provided a suitable alias above...
19. -[0x]Number
  A value beginning with "-" indicates that you wish to reset (remove) bit(s).
20. =[0x]Number
  A value beginning with "=" indicates that you wish to set the custom action type to a specific value. This will completely override any other attributes that may have been previously specified internally by the MAKEMSI command or by you. This should rarely if ever be required

EXAMPLE

This example show how the "CustomActionData" property is set up prior to calling a deferred custom action. Note that to do this I set the "key" on the "VbsCaSetup" command so I knew exactly what the key was, I then created a property of the same name, Windows Installer will do the rest.

In this case I am passing two properties, the custom action will need to separate these values, painful but required.

<$PropertyCa     "MyCa_Install" Value="[INSTALLDIR];[SecondProperty]" Seq="InstallFiles-">
<$VbsCaSetup Key="MyCa_Install" Binary="MyCa.vbs" Entry="Install"     Seq="InstallFiles-" CONDITION=^<$VBSCA_CONDITION_INSTALL_ONLY>^>

EXAMPLE - Overriding Installation Directory

The following is an example where the installation directory is specified by an environment variable but it could just as easily have been created via an immediate "VbsCa" custom action.

Note that Windows Installer remembers the location for repair and uninstall (at least where at least one file is installed there).

#define ENVVAR_INSTALLDIR       SOME_ENV_VAR        ;;Name of environment variable containing a path...
<$DirectoryTree Key="INSTALLDIR" Dir="C:\DummyLocation" CHANGE="\" PrimaryFolder="Y">
#(
    ;--- Check that the environment variable holding the install dir exists! ---
    <$AbortIf
        Condition=^%<$ENVVAR_INSTALLDIR> = "" and <$CONDITION_INSTALL_ONLY>^
              Seq=^CostFinalize-^ SeqTable="InstallUISequence InstallExecuteSequence"
          Message=^The "<$ENVVAR_INSTALLDIR>" environment variable doesn't exist. We can't determine the installation directory.^
    >

    ;--- Set the installation directory to the value of the environment variable ---
    <$PropertyCa "INSTALLDIR" Value="[%<$ENVVAR_INSTALLDIR>]"
              DIR="Y"
        Condition=^<$CONDITION_INSTALL_ONLY>^ Seq=^CostFinalize-^ SeqTable="InstallUISequence InstallExecuteSequence"
    >
#)

;--- Install files ----------------------------------------------------------
<$Files "TryMe.*" DestDir="INSTALLDIR">

EXAMPLE - Macro to Find "WSCRIPT.EXE"

;##################################################################################
;### Note that I have now created a "FileFindInListedDirs" command
;### which simplifies this and makes it more generic:
;###       <$FileFindInListedDirs File="wscript.exe" DIRS="System64Folder;SystemFolder;WindowsFolder">
;##################################################################################

;----------------------------------------------------------------------------
;--- Macro to find "WSCRIPT.EXE"
;--- MS stupidly places this file in logically different locations
;--- ("C:\windows" in WIN98). Also just to make it more difficult it is not
;--- possible to search by attribute, or search path and thus not possible
;--- to avoid possible incorrect matches in fixpack backup directories.
;--- All in all nearly a handful of reasons to swear at MS in one go....
;----------------------------------------------------------------------------
#(
    #define WSCRIPT.EXE

    ;--- Can't do this! Can find files in "$NtServicePackUninstall" type directories ---
    ;<$FileFind File="WSCRIPT.EXE" Property="WSCRIPT.EXE" PATH="[WindowsFolder]" Depth="1">   ;;Danger, Danger...

    ;--- Thanks MS... -------------------------------------------------------
    <$FileFind File="WSCRIPT.EXE" Property="WSCRIPT.EXE.WF" PATH="[WindowsFolder]" Depth="0" Default="">
    <$FileFind File="WSCRIPT.EXE" Property="WSCRIPT.EXE.SF" PATH="[SystemFolder]"  Depth="0" Default="">
    <$PropertyCa "WSCRIPT.EXE" Value="[WSCRIPT.EXE.WF]" Seq="AppSearch-" Condition="WSCRIPT.EXE.WF and (<$CONDITION_EXCEPT_UNINSTALL>)" SeqTable="InstallUISequence InstallExecuteSequence">
    <$PropertyCa "WSCRIPT.EXE" Value="[WSCRIPT.EXE.SF]" Seq="AppSearch-" Condition="WSCRIPT.EXE.SF and (<$CONDITION_EXCEPT_UNINSTALL>)" SeqTable="InstallUISequence InstallExecuteSequence">
    <$AbortIf
        Condition="not WSCRIPT.EXE and (<$CONDITION_EXCEPT_UNINSTALL>)"
          Message=^The file "WSCRIPT.EXE" was not found in the "[WindowsFolder]" or "[SystemFolder]" directories!^
         SeqTable="InstallUISequence InstallExecuteSequence"
              Seq="AppSearch-"
    >
    <$PropertyList "SecureCustomProperties" Value="WSCRIPT.EXE">
#)

EXAMPLE - "*VALUE" Parameter

The following shows the the "*value" parameter being used:

<$PropertyCa "CompileTimeBuild1"  Value="<?CompileTime>" Seq="CostFinalize-">   ;;Date/Time of build start from PPWIZARD standard definition
<$PropertyCa "CompileTimeBuild2" *Value="cstr( time() )" Seq="CostFinalize-">   ;;Time from VBSCRIPT expression (executed later during pass #1)

Microsoft awarded me an MVP (Most Valuable Professional award) in 2004, 2005, 2006, 2007, 2008 & 2009 for the Windows SDK (Windows Installer) area.

Please email me any feedback, additional information or corrections.
See this page online (look for updates)