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

---

The "Directory" Command

This command creates a directory entry entry in the MSI "Directory" table. It basically creates a single directory at a time given the name of a parent. It can also be given a full directory name in which case it will assign it via a custom action. Generally a better way of defining directories is via the DirectoryTree command.

The macro takes these parameters:

• Key (required)
  This is the key of the directory entry being created. This represents the "Directory" field.

  If the "Key" was supplied in all upper case then the actual directory can be overriden on the MSIEXEC.EXE command line.

  There are some standard folder keys which you can use, see Microsoft's MSI "System Folder Properties" for more information.

• Parent (optional)
  This is the name of the parent directory. (the "Directory_Parent" column).

  The default for this parameter can be set via the DEFAULT_DIR1_PARENT macro. The initial value is "ProgramFilesFolder".

• Dir (optional)
  This is the name of the subdirectory we are referring to (it should not contain slashes). This represents the "DefaultDir" field.

  Unless the value contains "|" MAKEMSI normally adjusts the value so that there is a short/long name pair to prevent this set the "ASIS" parameter to "Y".

• Value (optional)
  If this value is non-blank then all fields apart from "Key" are ignored and the value supplied here is assigned to the directory via a property. This is useful for hardcoding specific directory names (for example "X:\root\somewhere").

• AsIs (optional)
  Should the "DIR" parameter be adjusted or left "as is"? The default is "N", supply "Y" to leave the value as supplied.

• Change (optional)
  If a non-blank parameter is passed then this is the name of an existing feature that should be associated with this directory. The final install directory will be able to be updated by the user at install time ("Browse" button). The value "\" is replaced with the value of the current "root" feature while "." is replaced with the value of the "current" feature. Of course an error message is created if there is no "current" feature.

• PrimaryFolder (optional)
  You should pass "Y" for this parameter if the directory represents the "primary folder". The MSI properties "ARPINSTALLLOCATION" and "PRIMARYFOLDER" will be set.

• Access (optional)
  You can use this parameter to indicate that the entry requires one or more (space separated) special user permissions which have previously been defined using an "Access" command.

  Note that the directory key must be specified in the "CreateFolder" table table otherwise you should get validation errors and it won't work.

• Make (optional)
  To add this directory to the MSI "CreateFolder" table you should pass "Y" (any other value means "N" - the default value).

  This is required to create an empty folder that may/will contain no files (maybe a "log" directory).

  You do not need to create folders which contain files as folders are automatically created when files are installed.

• Remove (optional)
  To add this directory to the MSI "RemoveFile" table table (for removal when the component is uninstalled/removed) you should pass "Y" (the default is "N").

  You will generally use this parameter to remove "ICE64" validation errors which indicate that the folder may not be removed on uninstall (the folder will not be removed if files exist). on If you used the "MAKE" parameter it will use the same component otherwise it works the same as the "MAKE" parameter except that a component will never be created for you.

• Component (optional)
  This parameter is ignored unless either "MAKE=Y" or "REMOVE=Y" (the only time a component is required).

  If not supplied then the "current" component information (see "Component" command) is used. If required (no current component), a component will be created.

• Conditional (optional)
  Possible values:

  1. N (the default value)
     Passing "N" means that you want the directory "key" created immediately, otherwise it's creation will be delayed up until and if its required (on demand).

     Delaying it's creation only makes sense if you are doing so in a "common header file", otherwise you already know whether you need it or not!

  2. Y
     The parameters passed to this directory command are used to build the directory when it is required.

     The "COMPANY.MMH" header uses "Y" to define system directories such as "ProgramFilesFolder" as "conditional".

  3. Macro Name (not "N" or "Y")
     You have passed the name of a macro which defines how the "key" is created (all other parameters ignored).

  Its best not to define directories that are not required as its easier to understand the msi and can also reduce the chance of installation issues since all directories are validated (whether used or not) during the install (some of these may be invalid on a "flakey" box).

Please note that this command doesn't validate parameters so if you mis-spell one it won't tell you... Sorry...

EXAMPLES

<$Directory KEY="AAA"        PARENT="ProgramFilesFolder" DIR="AAA">
<$Directory KEY="BBB"        PARENT="AAA"                DIR="BBB">
<$Directory Key="DIR83"      PARENT="AAA"                DIR="AN83NAME.1|ALongDirectoryNameForWhichIHaveSuppliedASpecific_8.3_Name">
<$Directory KEY="ZDRIVE_CCC" VALUE="Z:\CCC">

EXAMPLE - Create Alias to another directory

The following shows one way to create an alias to another directory (in this case a "system folder"):

<$Directory KEY="INSTALLDIR" PARENT="ProgramFilesFolder" DIR="." ASIS="Y" CHANGE=".">

EXAMPLE - Conditional Definition

The following demonstrates how to define a "Diagnostics" start menu folder so it gets created if required:

;--- Conditionally define the "Start->Programs->Diagnostics" menu (defined on demand) ---
<$Directory Key="SCDIR_DIAGNOSTICS" Conditional="@@SCDIR_DIAGNOSTICS">
#(
    ;--- Define how to create the "standard" diagnostics folder -------------
    #define @@SCDIR_DIAGNOSTICS

    <$Component "SCDIR_DIAGNOSTICS" Create="Y" Directory_="<$AnyDir>" LM="Y">
         <$DirectoryTree Key="SCDIR_DIAGNOSTICS" Dir="[ProgramMenuFolder]\Diagnostics" MAKE="Y" REMOVE="Y">
    <$/Component>
#)

The above code will only get created when the directory key "SCDIR_DIAGNOSTICS" is first used.

Please email me any feedback, additional information or corrections. See this page online (look for updates) MAKEMSI© is (C)opyright Dennis Bareis 2003-2008 (All rights reserved). Saturday May 28 2022 at 3:11pm Visit MAKEMSI's Home Page