InstallShield 2020

User Guide
Legal Information
Book Name: InstallShield 2020 User Guide

Part Number: ISP-2600-UG00

Product Release Date: November 2020

Copyright Notice
Copyright © 2020 Flexera. All Rights Reserved.
This publication contains proprietary and confidential information and creative works owned by Flexera and its licensors, if any. Any use, copying,
publication, distribution, display, modification, or transmission of such publication in whole or in part in any form or by any means without the prior
express written permission of Flexera is strictly prohibited. Except where expressly provided by Flexera in writing, possession of this publication shall not
be construed to confer any license or rights under any Flexera intellectual property rights, whether by estoppel, implication, or otherwise.
All copies of the technology and related information, if allowed by Flexera, must display this notice of copyright and ownership in full.

Intellectual Property
For a list of trademarks and patents that are owned by Flexera, see https://www.flexera.com/producer/company/about/intellectual-property/. All other
brand and product names mentioned in Flexera products, product documentation, and marketing materials are the trademarks and registered
trademarks of their respective owners.

Restricted Rights Legend

The Software is commercial computer software. If the user or licensee of the Software is an agency, department, or other entity of the United States
Government, the use, duplication, reproduction, release, modification, disclosure, or transfer of the Software, or any related documentation of any kind,
including technical data and manuals, is restricted by a license agreement or by the terms of this Agreement in accordance with Federal Acquisition
Regulation 12.212 for civilian purposes and Defense Federal Acquisition Regulation Supplement 227.7202 for military purposes. The Software was
developed fully at private expense. All other use is prohibited.
 Contents

1 InstallShield 2020 Help Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Legal Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
What’s New in InstallShield 2020. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
New Features in InstallShield 2020 R3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
New Features in InstallShield 2020 R2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
New Features in InstallShield 2020 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
What Was New in Earlier Versions of InstallShield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
What’s New in InstallShield 2019 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
What’s New in InstallShield 2018 R2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
What’s New in InstallShield 2018 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
What’s New in InstallShield 2018 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
What’s New in InstallShield 2016 SP2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
What’s New in InstallShield 2016 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
What’s New in InstallShield 2016 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
What’s New in InstallShield 2015 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
What’s New in InstallShield 2015 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
What’s New in InstallShield 2014 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
What’s New in InstallShield 2014 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
What’s New in InstallShield 2013 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
What’s New in InstallShield 2013 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
What’s New in InstallShield 2012 Spring SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
What’s New in InstallShield 2012 Spring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
What’s New in InstallShield 2012 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
What’s New in InstallShield 2012 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
What’s New in InstallShield 2011 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
What’s New in InstallShield 2010 Expansion Pack for Visual Studio 2010 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
What’s New in InstallShield 2010 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
What’s New in InstallShield 2010 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
What’s New in InstallShield 2009 SP2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
What’s New in InstallShield 2009 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

InstallShield 2020 User Guide ISP-2600-UG00 3

Contents

What’s New in InstallShield 2009 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

What’s New in InstallShield 2008 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
What’s New in InstallShield 12 SP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
What’s New in InstallShield 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Target System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Targeting 64-Bit Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Targeting 64-Bit Operating Systems with Basic MSI and InstallScript MSI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Targeting 64-Bit Operating Systems with InstallScript Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Targeting 64-Bit Operating Systems with Suite/Advanced UI and Advanced UI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Launching InstallShield with vs. Without Administrative Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Developing and Building Installations on 32-Bit vs. 64-Bit Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Using Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Contacting Us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Installation Fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Application Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Starting InstallShield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
InstallShield Start Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Working with Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Installation Projects Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Determining Which Installation Project Is Right for You. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Project Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Advanced UI and Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
MSIX Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Package Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Package Payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Basic MSI Installation Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Run-Time Behavior for Basic MSI Installations with InstallScript Custom Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
DIM Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
InstallScript Installation Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
InstallScript MSI Installation Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Run-Time Behavior for InstallScript MSI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Merge Module Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
MSI Database and MSM Database Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
InstallScript Object Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
QuickPatch Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Transform Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Using Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Creating New Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Opening Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Opening Projects from Source Code Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Opening Patch Creation Properties Files in Direct Edit Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Opening Windows Installer Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

4 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Opening Merge Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Opening Object Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Placing Merge Modules in the Redistributables View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Saving Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Saving a Project with a New Name and Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Converting from One Project Type to Another Project Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Converting a Basic MSI Project to an InstallScript MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Converting an InstallScript MSI Project to an InstallScript Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
GUIDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Changing the Default Project Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Reusing Project Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Using a Repository to Share Project Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Setting up a Network Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Project Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Creating Project Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Basing New Projects on Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Publishing Project Templates to a Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Using the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Using the More Options, Other Places, and Help Links Sections in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Navigating in the Project Assistant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Opening the Installation Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Showing or Hiding the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Application Information Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Add or Remove Programs in the Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Company Name and Product Name in Your Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Installation Requirements Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Specifying Operating System in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
When Does the Installation Check for Requirements?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Modifying the Run-Time Message for Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Creating Custom Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Installation Architecture Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Adding Features in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Determining Whether to Create a Multiple-Feature Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Creating Installations with Multiple Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Default Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Defining Feature Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Application Files Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Adding Files to Features in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Removing Files from Features in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Adding Files to a Fixed Folder Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Viewing Additional Predefined Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Application Shortcuts Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
File Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Creating Shortcuts to Files That Are Not Included in the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

InstallShield 2020 User Guide ISP-2600-UG00 5

Contents

Modifying a Default Shortcut in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Associating a Shortcut’s Target with a File Extension in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Application Registry Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Updating the Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Configuring Registry Data in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Modifying Registry Data Values in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Associating Registry Data with Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Using Variable Data Types in Registry Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Application Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Installation Interview Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Specifying Dialogs for Your Installation in the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Allowing End Users to Modify the Installation Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
License Agreements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Creating Selectively Installable Installations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Installation Localization Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Localizing String Data from the Project Assistant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
How Localized String Data Is Used in the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Build Installation Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Building Your Installation from the Project Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
After Completing the Project Assistant: Next Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Working with the InstallShield Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Displaying the View List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Opening Views in the InstallShield User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Working with the Group Box Area in Various Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Showing or Hiding Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Adding Buttons and Menus to a Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Removing Buttons and Menus from a Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Creating Custom Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Docking or Undocking the Output Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Working with the Script Editor Pane in Various Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Using Bookmarks in the Script Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Enabling or Disabling Auto Completion in the Script Editors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Using Auto Completion when Writing Code in the Script Editors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Enabling or Disabling InstallScript Function Call Tips in the Script Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Viewing Function Call Tips for an InstallScript Function in the Script Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Enabling or Disabling Syntax Highlighting in the Script Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Changing Colors for Syntax Highlighting in the Script Editors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Changing the Font that Is Used to Display Text in the Script Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Showing or Hiding Line Numbering in the Script Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Going to a Line Number in a Script that Is Displayed in a Script Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Enabling or Disabling Automatic Indentation in the Script Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Setting the Tab Width for the Script Editors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Enabling or Disabling Syntax Folding in the Script Editors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Showing or Hiding Whitespace in the Script Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Dragging and Dropping Text in the Script Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Printing a Script File from Within a Script Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

6 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Keyboard Shortcuts for the Script Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Configuring Advanced Settings for InstallShield. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Changing the Timestamp Server for Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Configuring the Compression Level for Files that Are Streamed into Setup.exe and ISSetup.dll. . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Configuring the Maximum Size for .cab Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Configuring the Maximum Size for Virtual Media Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Modifying the List of Portable Executable Files for the Standalone Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Adding Support for XML Encoding Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Specifying the Location Where All Virtual Packages Should Be Built . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Changing the Default Clone_wait Parameter for the Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Configuring Platform Architecture for Digital Signing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Sharing Virtual Machine Settings for Distribution of Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Upgrading from Earlier InstallShield Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Upgrading Projects from InstallShield 2014 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Upgrading Projects from InstallShield 2013 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Upgrading Projects from InstallShield 2012 Spring or Earlier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Upgrading Projects from InstallShield 2012 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Upgrading Projects from InstallShield 2011 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Upgrading Projects from InstallShield 2010 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Upgrading Projects from InstallShield 2009 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Upgrading Projects from InstallShield 2008 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Upgrading Projects from InstallShield 12 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Upgrading Projects from InstallShield 11.5 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Upgrading InstallShield 11.5 or Earlier Basic MSI Projects that Have InstallScript Custom Actions . . . . . . . . . . . . . . . . . . . . . . 407
Creating and Scheduling InstallScript Custom Actions that Call InstallScript Event Handlers for Basic MSI Projects. . . . . . 410
Upgrading InstallShield 11.5 or Earlier InstallScript MSI Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Creating and Scheduling InstallScript Custom Actions that Call InstallScript Event Handlers for InstallScript MSI Projects415
Upgrading InstallShield 11.5 or Earlier InstallScript Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Upgrading InstallShield 11.5 or Earlier QuickPatch Projects that Have InstallScript Custom Actions . . . . . . . . . . . . . . . . . . . . 421
Creating Standard Patches for InstallShield 11.5 and Earlier InstallScript MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Upgrading InstallShield 11.5 or Earlier InstallScript MSI Object Projects or Projects that Contain This Type of Object . . . . 422
Upgrading Projects Created with InstallShield Express . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Upgrading Projects Created with InstallShield Professional. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Migrating from InstallShield Professional 6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Migrating from InstallShield Professional 5.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Script Changes: Lexicon Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Adding Project Assistant Dialog Support to Projects Upgraded from InstallShield Professional . . . . . . . . . . . . . . . . . . . . . . . . 437
Upgrading Projects Created with InstallShield—Windows Installer Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Post-Upgrade Changes in the Property Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Upgrading from Other InstallShield Editions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Upgrading from the Express Edition to the Professional or Premier Editions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Upgrading from the Professional Edition to the Premier Edition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Converting or Importing Visual Studio Projects into InstallShield Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Obtaining Updates for InstallShield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Run-Time Language Support in InstallShield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

InstallShield 2020 User Guide ISP-2600-UG00 7

Contents

Code Page Requirements for Language Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

Installing Supplemental Language Support on a Build Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Supported Application Programming Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

3 Tutorials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
InstallScript Project Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Step 1: Creating, Building, and Testing Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Creating a Project with the Project Assistant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Specifying Application Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Customizing the Installation Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Adding Files to Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Creating Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Configuring Registry Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Selecting Dialogs with the Installation Interview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Choosing a Language for Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Building Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Running Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Working with the InstallShield Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Setting Feature Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Setting Setup Type Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Creating Components and File Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Building a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Naming the Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Selecting the Media Type and General Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Specifying a Password and Supported Platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Specifying Setup Languages and Including Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Defining Media Layout and Dialog Appearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Specifying Internet Options and Digitally Signing Your Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Specifying Update and Postbuild Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Reviewing Your Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Troubleshooting Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Step 2: Shortcuts and Registry Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Creating Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Creating Registry Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Step 3: Registering COM Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Step 4: Conditions and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Step 5: Working with Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Step 6: Changing the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Handling User Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Changing the Dialogs Displayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Using the Dialog Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Basic MSI Project Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Step 1: Creating, Building, and Testing Your Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Creating a New Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Specifying Application Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Setting Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

8 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Customizing Installation Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

Adding Files to Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Creating Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Configuring Registry Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Selecting Dialogs with the Installation Interview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Choosing a Language for Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Building Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Running Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Working in the IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
Setting Feature Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
Creating Components and File Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Building a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Naming the Product Configuration and Release. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Specifying Filtering Settings and Languages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Selecting the Media Type and Disk Spanning Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Specifying Compression Settings and Setup Launcher Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Adding Digital Signature and Password Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Including .NET Framework Support and Choosing Advanced Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Reviewing Your Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Troubleshooting Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Step 2: Shortcuts and Registry Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Creating Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Creating Registry Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Step 3: Registering COM Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Step 4: Conditions and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
Step 5: Changing the End-User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Adding a New Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Modifying Dialog Layout in the Dialog Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Globalization Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Opening the Project File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Selecting the Target Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Editing Language-Specific String Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Creating String Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Including Language-Specific Files and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Specifying Component Installation Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Translating the Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Building the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Running the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
Testing the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

4 Creating Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Requirements for the Windows Logo Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Introduction to Windows Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Minimizing the Number of User Account Control Prompts During Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Setting an Application’s Disk Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

InstallShield 2020 User Guide ISP-2600-UG00 9

Contents

INSTALLDIR vs. TARGETDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

Preventing the Current Installation from Overwriting a Future Major Version of the Same Product. . . . . . . . . . . . . . . . . . . . . . . . . 517
Preparing Installations for Non-Administrator Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Settings for Platforms and Platform Suites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Specifying Installation Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Configuring General Project Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Saving an InstallShield Project File (.ism) in XML or Binary Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Specifying a Product Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
Specifying the Product Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
Product Version Numbers in InstallScript and InstallScript Object Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Setting the Product Code in a Windows Installer–Based Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Setting the Product Code in an InstallScript-Based Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Setting the Upgrade Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Setting Product Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Setting the Default Product Destination Folder (INSTALLDIR). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Securing Files, Folders, Registry Keys, and Windows Services in a Locked-Down Environment . . . . . . . . . . . . . . . . . . . . . . . . . 531
Selecting the Locked-Down Permissions Type for a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Specifying Whether Windows Installer Installations Should Be Logged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Running an InstallScript Installation Multiple Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Configuring the Enable Maintenance Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
Using the InstallScript Engine as an External vs. Embedded UI Handler for InstallScript MSI Installations . . . . . . . . . . . . . . . 538
Specifying the InstallScript User Interface Type for InstallScript MSI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Entering Summary Information Stream Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Accessing the Summary Information Stream Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Setting Summary Information Stream Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Using the Template Summary Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Configuring Add or Remove Programs Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Specifying a Readme File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Including a Software Identification Tag for Your Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Including Microsoft System Center Configuration Manager Application Model Data About Your Product . . . . . . . . . . . . . . . . . . . 550
Organizing Files for Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Designing Installations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Separating Applications into Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Separating Applications into Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
Using Path Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
Types of Path Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
Predefined Path Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
Standard Path Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Registry Path Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Environment Path Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Creating and Defining a Custom Path Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
Overriding the Value of a Custom Path Variable for a Release. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Converting Absolute Path References in Your Project to Path Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Deleting a Path Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
Including Files and Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
Adding to Your Project Files to Be Installed on Target Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565

10 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Dragging and Dropping Files Using the Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566

Adding Files from Your 64-Bit Source Machine’s 64-Bit System32 Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
Creating New Destination Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
Creating Empty Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Specifying Hard-Coded Destination Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Removing Files and Folders from Target Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Tips for Managing Files and Folders in Your Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
Finding Files and Folders in Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Displaying Components in the Files and Folders View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Modifying Components through the Files and Folders View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Configuring Settings for a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
File Associations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Adding New File Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Removing File Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Setting File Extension Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Specifying Command Verbs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Removing a Verb from a File Extension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Adding New MIME Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Removing MIME Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Creating ProgIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Removing ProgIDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Dynamic File Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
Limitations of Dynamic File Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Determining the Appropriate Component Creation Method for Dynamically Linked Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Creating a Dynamic Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Adding Dynamic File Links to Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Setting a Key File for a Dynamic File Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Overwriting Files and Components on the Target System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Displaying Predefined Folders in the Files View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Companion Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Configuring Permissions for Files and Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Extracting COM Data When Files Are Added . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
Installing Self-Registering Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Identifying Properties and Dependencies of .NET Assemblies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Scanning 64-Bit .NET Assemblies for Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Reviewing .NET Dependency Scanner Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Installing Fonts Through InstallScript and InstallScript Object Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Installing Fonts to the Windows Fonts Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Enabling or Disabling Global Font Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Enabling or Disabling Registration of a Font File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Using Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Setup Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Component Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Using the Setup Design or Components Views to Create a Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Using the Best Practices Option with the Component Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Best Practice Rules for Creating Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Letting InstallShield Create a COM Server Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602

InstallShield 2020 User Guide ISP-2600-UG00 11

Contents

Letting InstallShield Create Font Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602

Using the Component Type Option with the Component Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Installing COM Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Installing Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Exporting Components to Other Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Deleting a Component in Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Component-Feature Associations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Associating New Components with Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Associating Existing Components with Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Disassociating Components from Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Adding Data to a Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Adding Files to Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Changing the Value in the Link To Column for a Component’s File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Deleting a File from a Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Adding Registry Data to Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Creating Shortcuts in the Components View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Adding Subfolders to Statically Linked Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
Component Key Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
Setting Component Key Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Clearing a Key File from a Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Component Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Component Destination vs. Feature Destination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Setting a Destination Folder for the Component’s Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Specifying a Component’s Destination from the Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Uppercase Directory Identifiers and Component Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Specifying Whether a Component’s Files and Other Associated Data Are Uninstalled During Uninstallation. . . . . . . . . . . . . 619
Configuring Component Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Reevaluating Component Conditions During Reinstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Managing Reference Counts for Shared Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Checking File Versions Before Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Installing Files of the Same Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Setting a Component’s Remote Installation Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Component’s Remote Installation Setting vs. Feature’s Remote Installation Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Extracting COM Registration Data at Build Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
Scanning for .NET Dependencies and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Specifying the .NET Application File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Reading Properties Passed to the .NET Installer Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Enabling and Disabling Registry Reflection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Specifying Whether Shared Component Patching Should Be Enabled for a Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Advanced Component Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Configuring COM Registration Settings Manually. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Configuring COM Classes for COM Registration Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Configuring ProgIDs for COM Registration Manually. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Configuring Type Libraries for COM Registration Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Registering a File Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
Installing Assemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
Adding Assemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640

12 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Deleting Assemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641

Testing for .NET Assembly Support on the Target System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
Specifying an Application Path for a Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
Configuring Device Driver Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
Publishing Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
Specifying Publishing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
Adding ComponentIDs for a Component to Be Published . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Removing ComponentIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Adding Qualifiers to ComponentIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Removing Qualifiers from ComponentIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Configuring Qualifier Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Defining Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Creating Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Configuring Feature Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Setting a Feature’s Destination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Setting Feature Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Displaying Features to End Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Conditionally Selecting Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Conditionally Hiding Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Conditionally Setting the Visibility of a Suite Feature at Run Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
Requiring Features to Be Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Advertising Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Configuring a Feature’s Install Level Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
Setting a Feature’s Remote Installation Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
Using Release Flags with Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Assigning Release Flags to Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Removing Release Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Reordering Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Using the Required Features Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Working with Setup Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Adding Setup Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Editing Setup Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Renaming Setup Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Deleting Setup Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Including Redistributables in Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Shipping Redistributable Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Managing the Redistributables Gallery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Downloading Redistributables to Your Computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Adding InstallShield Prerequisites to the Redistributables Gallery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
Removing InstallShield Prerequisites from the Redistributables Gallery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Browsing for Merge Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
What Happens When You Browse for a Merge Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Adding Merge Modules to the Redistributables Gallery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Removing Merge Modules from the Redistributables Gallery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Registering Objects in InstallScript Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Incorporating InstallShield Prerequisites, Merge Modules, and Objects in Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects. . . . . . . . . . . . . 677

InstallShield 2020 User Guide ISP-2600-UG00 13

Contents

Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Removing InstallShield Prerequisites from a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Removing Merge Modules and Objects from a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Determining the Files in InstallShield Prerequisites, Merge Modules, and Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Working with InstallShield Prerequisites that Are Included in Installation Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Setup Prerequisites vs. Feature Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Associating an InstallShield Prerequisite with a Feature in a Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Disassociating an InstallShield Prerequisite from a Feature in a Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Specifying the Installation Order of InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Configuring a Release that Includes InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Specifying the Directories that Contain InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Specifying a Run-Time Location for a Specific InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Assigning Release Flags to InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Building a Release that Includes InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Run-Time Behavior for an Installation that Includes InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Uninstalling an Application Whose Installation Included InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
Working with Merge Modules that Are Included in Installation Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Specifying the Directories that Contain Merge Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Overriding a Merge Module’s Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
Troubleshooting Merge Module Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Publishing a Merge Module to a Repository from Within an Installation Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Adding Windows Installer Redistributables to Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
Including Microsoft Windows Installer Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
Adding .NET Framework Redistributables to Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
Including the Microsoft .NET Framework and Microsoft .NET Framework Language Pack Prerequisites . . . . . . . . . . . . . . . . 704
Including the MySQL Connector ODBC Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
Including the InstallShield Prerequisite for the Oracle 11g Instant Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
Including the DirectX 9.0 Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Identifying Application Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
Static Scanning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Dynamic Scanning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Scanning for 64-Bit Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Reviewing Dependency Scanner Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Filtering Files in Dependency Scanners. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Registering COM Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
Traditional COM Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
Determining Whether a COM Server Supports Self-Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Extracting COM Information from a COM Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Filtering Registry Changes for COM Extraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Self-Registering COM Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
Self-Registration Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
InstallShield Self-Registration (ISSelfReg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Registry-Free COM Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Creating and Modifying Reg-Free COM Files for Your Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
Sample Manifest File for a Reg-Free COM File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Including DIMs in a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723

14 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Determining the Appropriate Method for Incorporating DIMs in Installation Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
Referencing a DIM in a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
Associating a DIM Reference with a Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
Resolving Build-Time Conflicts Between a Basic MSI Project and a DIM Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
Viewing Build Instructions for a DIM Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
Overriding the Destination for a DIM Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Scheduling Custom Actions and Dialogs from a DIM Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Opening a Referenced DIM Project from Within an Installation Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Importing a DIM into a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Resolving Design-Time Conflicts While Importing a DIM Into a Basic MSI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Identifying DIM Elements in an Installation Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Overriding Path Variables in a DIM Project for Use in an Installation Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
Configuring the Target System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Creating Shortcuts and Program Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Types of Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Creating Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Configuring Shortcut Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Specifying the Icon for a Shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Creating Internet Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
Creating Shortcuts to Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Specifying a Keyboard Shortcut for Accessing a Shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Renaming Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Setting Shell Properties for a Shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Suppressing Initial Pinning of a Shortcut to the Windows 8 Start Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Specifying Whether End Users Should Be Able to Pin a Shortcut to the Taskbar or Start Menu . . . . . . . . . . . . . . . . . . . . . . . . . 744
Preventing a Shortcut on the Start Menu from Being Highlighted as Newly Installed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Setting Custom Shell Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Creating Uninstallation Shortcuts for Basic MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Creating Uninstallation Shortcuts for InstallScript and InstallScript MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Configuring the Appearance of a Desktop App’s Tile on the Start Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
Editing the Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Filtering Registry Entries by Component or Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Refreshing the Registry View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Creating Registry Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Dragging and Dropping Registry Entries to Create Registry Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Removing Registry Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Creating Registry Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Modifying Registry Value Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Removing Registry Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Registry Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Searching for Registry Entries in a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Setting Uninstall Behavior for Registry Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Using Environment Variables in Registry Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Writing Property Values to the Registry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Importing Registry Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Exporting Registry Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766

InstallShield 2020 User Guide ISP-2600-UG00 15

Contents

Setting Key Paths for Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766

Configuring Permissions for Registry Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Primary Keys for the Registry Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Specifying a Primary Key for the Registry Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Entering Multi-Line String Values for Registry Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
Writing Entries Under HKCU for a Per-User Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Setting or Getting Multi-Line Strings in the Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Working with Registry Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Reading Data from the Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Changing .ini File Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Creating .ini File References. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Importing an Existing .ini File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Specifying a Section in an .ini File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Specifying a Keyword in an .ini File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Reading Data from .ini Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Reading All Key Names from .ini Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Configuring ODBC Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Installing ODBC Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Including Additional ODBC Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Associating ODBC Resources with Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
Setting ODBC Resource Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
Using Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
Setting Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Environment Variables Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
Modifying XML Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Overview of XML File Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Run-Time Requirements for XML File Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
Creating an XML File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
Specifying the Location of the XML File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Associating an XML File Change Reference with a Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Adding a Root Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Adding a New Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Adding an Element for a .NET Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Adding an Attribute to an Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Editing an Attribute’s Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Adding Content to an Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Using XPath Expressions to Find XML Data in an XML File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Using Windows Installer Properties to Dynamically Modify XML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Using InstallScript Text Substitution to Dynamically Modify XML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Using Reserved Characters (<, >, &, ', and ") Inside Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
Using Namespaces in XML Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
Declaring Namespace Mappings for an XML File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
Adding a Namespace Prefix to an Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Adding a Namespace Prefix to an Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
Removing a Namespace Prefix from an Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
Removing a Namespace Prefix from an Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806

16 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Removing Namespace Mappings from an XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807

Testing Installation Changes to an XML File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
Testing Uninstallation Changes to an XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Removing an Element or an XML File from the XML File Changes View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Modifying Text Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Creating a Text Change Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
Specifying a Change for a Text File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Changing the Order in Which Text File Changes Are Made . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Using Windows Installer Properties to Dynamically Modify Text Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
Specifying the Code Page that Should Be Used for Opening ANSI Text Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Removing a Change Item or a Change Set from the Text File Changes View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
Scheduling Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Adding a Scheduled Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Using Windows Installer Properties to Dynamically Configure a Scheduled Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Removing a Scheduled Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Installing, Controlling, and Configuring Windows Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Creating Predetermined User Accounts at Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
Per-User vs. Per-Machine Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
Running InstallScript Installations Without Administrative Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Customizing Installation Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Using InstallScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Overview of ISSetup.dll. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Creating InstallScript Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Opening an InstallScript File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Inserting and Importing Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Compiling Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
Debugging Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Using Preprocessor Statements to Debug the Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Renaming an InstallScript File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Using String Entries in Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Removing InstallScript Files from Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Creating Script Libraries (.obl Files) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
Publishing InstallScript Files (.rul and .h) to a Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
InstallScript Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Creating and Destroying Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Adding Elements to Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Adding an Element to an Empty List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Adding an Element Before the Current Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Adding an Element After the Current Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Adding Elements Before and After the Current Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Changing Existing Elements in a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Deleting Elements from a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Finding a Particular Element in a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Getting the First and Next Elements in a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Reading a File into a List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847
Setting an Index in a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847

InstallShield 2020 User Guide ISP-2600-UG00 17

Contents

Traversing Lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848

Writing a List to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Saving InstallScript Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
System Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
Getting and Setting Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Using Bit Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
String Comparisons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Using Null-Delimited Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Relative Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Long File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Long File Names and 16-bit Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Long File Names and Double Quotation Marks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Long File Name Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Defining Constants Through the Compiler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Using Windows Constants in a Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Coding Long String Literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Absolute Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Building Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Calling Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Calling a DLL File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Passing an Array to a DLL File Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Declaring Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Returning Values from Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Unsupported Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Writing Entry-Point Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Adding Function Calls with the Function Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Declared Windows API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Specifying a Non-Default Feature Event Handler Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Accessing Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
Uninstalling Initialization (.ini) File Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
General Limitations of Uninstalling Initialization (.ini) File Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
Uninstalling AddProfString’s Initialization (.ini) File Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
Uninstalling ReplaceProfString’s Initialization (.ini) File Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
Uninstalling WriteProfString’s Initialization (.ini) File Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
Extending Your Installation with COM Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
Specifying Features and Subfeatures in Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
Calling a Windows API Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Embedding Custom Transfer File Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Expressing Large Numbers in InstallScript. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Installing Device Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Checking the Compiler Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Checking the Authoring Environment with _ISCRIPT_ISDEV and _ISCRIPT_ISPRO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Launching an Installation from Another InstallScript Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Language Support for InstallScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Preventing Color Distortion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Using Custom Actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Using the Custom Action Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882

18 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Creating Custom Actions in the Custom Actions and Sequences View (or the Custom Actions View) . . . . . . . . . . . . . . . . . . . . 883
Cloning Custom Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Exporting Custom Actions to Other Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Configuring Custom Action Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Custom Action Type Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
Custom Action Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
In-Script Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Documenting the Behavior of Custom Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Guidelines for Creating Custom Actions that Meet Requirements of the Windows Logo Program . . . . . . . . . . . . . . . . . . . . . . . 891
Conditionally Launching Custom Actions Based on Release Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Placing Files in the .msi Database and Extracting Them During Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Accessing or Setting Windows Installer Properties Through Deferred, Commit, and Rollback Custom Actions . . . . . . . . . . . 894
InstallScript Custom Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Calling Functions in Standard DLL Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Calling Functions in Windows Installer DLL Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
Passing Parameters to a DLL File Function in a Custom Action. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Calling a Public Method in a Managed Assembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Run-Time Requirements for Managed-Code Custom Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Specifying the Signature for a Managed Method in an Assembly Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Using 32-Bit vs. 64-Bit Managed-Code Custom Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Calling a Kill-Process Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Calling a PowerShell Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Launching Executable Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
Using Msiexec.exe to Launch a Second Windows Installer Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
Nested Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Creating Nested Installation Custom Actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Inserting Nested Installation Custom Actions into Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Removing Child Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Calling MessageBoxA in an Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Searching for Files on the Target System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Launching the Application After the Installation Is Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Exiting the Installation from Within an InstallScript Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Changing ODBC Properties Through Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Using the INSTALLDIR Property in a VBScript Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Using Action Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Specifying an Action Description and a Template for Action Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
Displaying Action Descriptions on the Progress Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
Displaying Action Data on the Progress Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Removing an Action Description or a Template for Action Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
Defining Sequences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
Installation Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
Advertisement Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Administration Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
User Interface Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Execute Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Inserting Actions into Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942

InstallShield 2020 User Guide ISP-2600-UG00 19

Contents

Copying a Custom Action from One Sequence to Another . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943

Reordering a Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Removing Actions from Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Sequencing Rollback Custom Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Sequencing a Custom Action that Launches an .exe File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Sequencing a Custom Action that Calls a Function in a DLL File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
Sequencing a Custom Action that Calls a Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Sequencing Custom Actions that Set Properties or Directory Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Sequencing a Custom Action that Launches a Second .msi Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
ISSetAllUsers Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Using Support Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
Adding Support Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Adding a License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Sorting Support Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Adding Files and Folders to the Disk1 Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
Removing Files or Folders from the Disk1 Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
Adding Files and Folders to the Last Disk Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
Removing Files or Folders from the Last Disk Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
Adding Files and Folders to the Other Disk Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Removing Files or Folders from the Other Disk Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Removing Support Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Defining the End-User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Working with Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Working with Dialogs in Any Project Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Using the Dialog Wizard to Create a New Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Adding the Ability to Create or Set an Existing User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Exporting a Dialog to an .isd File for Use in Other Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Importing Dialogs from an .isd File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
Publishing a Dialog (.isd) File to a Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
Exporting All Dialogs to an .rc File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Importing Dialogs from Resource .dll Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
Exporting Dialogs to Other Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
Removing Dialogs from Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
Creating and Configuring Custom Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
Undoing Changes in the Dialog Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Working with Dialogs in InstallScript and InstallScript MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Displaying Dialogs During InstallScript and InstallScript MSI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Changing the Text on Dialogs in InstallScript and InstallScript MSI Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
Background About the Default Images on Dialogs in InstallScript and InstallScript MSI Projects . . . . . . . . . . . . . . . . . . . . . . . 971
Creating New Custom Dialogs in InstallScript and InstallScript MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Using the New Dialog Wizard to Add a New Custom Dialog to an InstallScript or InstallScript MSI Project . . . . . . . . . . . . . . . 972
Editing the Layout of a Dialog in an InstallScript or InstallScript MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
Adding a Control to a Dialog in an InstallScript or InstallScript MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
Setting a Control’s Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
Displaying Controls on Top of a Bitmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
Using InstallScript to Implement Custom Dialogs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976

20 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Using InstallScript to Process Dialog Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979

Editing Dialog Behavior in an InstallScript or InstallScript MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Adding a Field That Contains a Product Name, Product Version, or Installed Version in Sd Dialog Static Text Fields. . . . . . 982
Using an HTML Control on a Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Reverting to the Default Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Resource Compiler and Resource Linker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Dialog Sampler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986
Dialog Skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986
Specifying Dialog Skins. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
Working with Dialogs in Basic MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Displaying Dialogs During Basic MSI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Creating New Dialogs in Basic MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
Editing Dialog Layout in Basic MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
Opening the Dialog Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
Adding a Control to a Dialog in a Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
Configuring the Controls’ Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
Displaying Controls on Top of a Bitmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
Editing Dialog Behavior in Basic MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Using Control Events in Basic MSI Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Using Subscriptions in Basic MSI Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997
Triggering Control Events in Basic MSI Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
Adding New Events to a Dialog Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
Reordering a Dialog Control’s Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
Removing an Event from a Dialog Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
Launching Custom Actions from Dialog Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1000
Viewing End-User Dialog Order in the Custom Actions and Sequences view (Basic MSI Projects) . . . . . . . . . . . . . . . . . . . . . .1001
CustomSetup Dialog Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1002
Dialog Themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1004
Run-Time Requirements for the Wide Dialog Themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
Previewing a Dialog Theme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005
Selecting or Changing a Dialog Theme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005
Applying a Theme to a Custom Exterior Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
Adding a Logo or Other Image to the Exterior Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1007
Available Themes and Corresponding Dialog Sizes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
Circles Theme (Wide) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
Classic Theme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
Cooperation Theme (Wide) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
Filmstrip Theme (Wide). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
Global Theme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
InstallShield Blue Theme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
InstallShield Blue Theme (Wide) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016
InstallShield Silver Theme. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017
Monitor Theme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
Pastel Wheat Theme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
Theater Theme (Wide) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
Dialog Support for Right-to-Left Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1023
Launching a File Open Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1023
Requiring End Users to Scroll Through the EULA in the LicenseAgreement Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1026

InstallShield 2020 User Guide ISP-2600-UG00 21

Contents

Adding a Print Button to a Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1028

Minimizing Reboots on Windows Vista and Later Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1030
Dialog Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
Billboard Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1034
Bitmap Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1037
Check Box Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1039
Combo Box Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1044
Dialog Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1048
Directory Combo Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1051
Directory List Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1054
Edit Field Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1056
Group Box Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1060
Hyperlink Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1063
Icon Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1067
Line Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1069
List Box Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1072
List View Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1076
Masked Edit Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1080
Path Edit Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1083
Progress Bar Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1085
Push Button Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1088
Radio Button Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1092
Radio Button Group Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1095
Scrollable Text Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1099
Selection Tree Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1101
Text Area Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1105
Volume Cost List Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1109
Volume Select Combo Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1112
Copying and Pasting Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1114
Cutting and Pasting Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1115
Working with the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
Elements of the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1116
Using Styles, Brushes, and Control Themes to Customize the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
Defining a Custom Style for the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1119
Applying a Text Style to Text in the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1120
Defining a Custom Brush for the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1121
Specifying the Background Brush for the Header, Body, and Navigation Areas of the Wizard Interface . . . . . . . . . . . . . . . .1121
Overriding the Default Background Brushes for a Wizard Page or Secondary Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1123
Defining a Custom Control Theme for the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1124
Applying a Theme to a Control in the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1125
Selecting the Format for the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126
Creating a New Blank Wizard Page in an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127
Adding a Predefined Wizard Page in an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
Creating a New Blank Secondary Window in an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
Sequencing Wizard Pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
Editing the Layout and Behavior of a Wizard Page or Secondary Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130

22 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Adding a Control to a Wizard Page or Secondary Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1131

Changing the Tab Order of Controls on a Wizard Page or Secondary Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1133
Designating Keyboard Shortcuts and Using Ampersands (&) in the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1134
Using Navigation Buttons on Wizard Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1135
Overriding the Default Behavior of a Navigation Button on a Wizard Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1137
Populating Combo Box and List Box Controls in the Wizard Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1138
Configuring Validation for a Control on a Wizard Page or Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1140
Configuring an Action for an Element in the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1143
Using Images, Text Files, and Other Objects in the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
DPI-Awareness in the Wizard Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
Localizing the End-User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1149
Working with String Entries in Projects that Support Multiple Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1150
Using String Entries in InstallShield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1151
Adding a String Entry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1153
Editing a String Entry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154
Searching for Instances of String Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1156
Finding and Replacing String Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1156
Removing a String Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1157
Removing String Identifiers from Localizable Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1158
Displaying Billboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
Displaying Billboards in Basic MSI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
Billboard File Types for Basic MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1159
Types of Billboards for Basic MSI Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1160
Specifying Which Type of Billboard to Use in a Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1163
Adding an Adobe Flash Application File Billboard to a Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1163
Adding Image Billboards to a Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1164
Configuring Billboard Settings in a Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1165
Previewing Billboards Without Building and Launching a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1165
Setting the Billboard Order in a Basic MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1166
Run-Time Behavior of a Basic MSI Installation that Includes Billboards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1166
Removing a Billboard from a Basic MSI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1167
Displaying Billboards in InstallScript and InstallScript MSI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167
Billboard Styles and File Types for InstallScript and InstallScript MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1168
Naming Billboard Files in an InstallScript or InstallScript MSI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1170
Adding an Adobe Flash Application File Billboard to an InstallScript or InstallScript MSI Project . . . . . . . . . . . . . . . . . . . . . .1171
Adding an Image Billboard to an InstallScript or InstallScript MSI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1172
Adding or Modifying the Code in an InstallScript or InstallScript MSI Project to Display Billboards. . . . . . . . . . . . . . . . . . . . .1173
Setting the Billboard Order in an InstallScript or InstallScript MSI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1174
Displaying Billboards with Special Effects During an InstallScript or InstallScript MSI Installation. . . . . . . . . . . . . . . . . . . . .1174
Moving Billboards to a Different Screen Location for an InstallScript or InstallScript MSI Project . . . . . . . . . . . . . . . . . . . . . .1175
Removing a Billboard from an InstallScript or InstallScript MSI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1175
Displaying a Background Window in InstallScript and InstallScript MSI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176
Populating List Boxes at Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177
Displaying File Browse Dialogs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177
Displaying Network Browse Dialogs in InstallScript Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177
Configuring Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1179

InstallShield 2020 User Guide ISP-2600-UG00 23

Contents

Configuring SQL Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1179

Using Windows Installer Properties for SQL Login Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1180
Specifying Whether New SQL Connections Should Share the Same Windows Installer Properties. . . . . . . . . . . . . . . . . . . . . .1182
Using the SQL Run-Time Functions in InstallScript and InstallScript MSI Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
Adding a New SQL Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
Overriding the Default TCP/IP Network Library with a Different Protocol for a SQL Server Database. . . . . . . . . . . . . . . . . . .1184
Requirements for Connecting to Instances of SQL Server Express LocalDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1185
Adding a New SQL Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186
Inserting and Importing SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187
Importing a SQL Server Database and Generating a SQL Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1188
Editing a SQL Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1189
Specifying a Version Number for a SQL Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1190
Specifying the Order for Running Multiple SQL Scripts That Are Associated with a Connection . . . . . . . . . . . . . . . . . . . . . . . . 1191
Overriding the Default SQL Run-Time Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1192
Handling SQL Run-Time Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
Setting Up a Database Server Type Condition for SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
Conditionally Launching a SQL Script in a Windows Installer-Based Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196
Conditionally Launching a SQL Script in an InstallScript Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197
Requiring that SQL Scripts Be Run Only Against a Full SQL Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1198
Using Windows Installer Properties to Dynamically Replace Strings in SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1198
Using InstallScript Text Substitution to Dynamically Replace Strings in SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
Requiring a SQL Server-Side Installation for a Windows Installer-Based Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
Requiring a Server-Side Installation for an InstallScript Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1203
Publishing SQL Script Files to a Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1204
Installing the MySQL ODBC Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1204
Deleting a SQL Server Database During Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
Connecting to a Microsoft Windows Azure Database Server and Running SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1206
Connecting to an Instance of Oracle and Running SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1207
Downloading the Oracle Instant Client and Creating an .msi Package for It . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1208
Downloading the Oracle Basic Instant Client and the Oracle ODBC Instant Client and Creating an .msi Package and Install-
Shield Prerequisite for Both . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1209
Installing the Oracle 11g Instant Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1213
Running SQL Scripts with Unicode Characters on an Oracle Database Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1214
Creating a Sample Installation that Creates a SQL Server Database by Running Customized SQL Script . . . . . . . . . . . . . . . 1214
Creating a Sample Installation that Creates an Oracle Schema by Running Customized SQL Script. . . . . . . . . . . . . . . . . . . . 1216
Adding a SQLLogin Predefined Wizard Page in a Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1219
Managing COM+ Applications and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220
Managing COM+ Server Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1221
Managing COM+ Application Proxies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
Including a COM+ Application that Targets Servers and Client Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
Managing Internet Information Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
Version-Specific Information for IIS Support in InstallShield. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
Determining Which Version of IIS Is Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1226
Run-Time Requirements for IIS Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
Specifying Whether a Web Server Should Allow the CMD Command to Be Used for SSI #exec Directives . . . . . . . . . . . . . . . 1227
Creating a Web Site and Adding an Application or a Virtual Directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228

24 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Scanning an IIS Web Site and Importing Its Settings into an InstallShield Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1230
Filtering IIS Data When Importing a Web Site and Its Settings into an InstallShield Project. . . . . . . . . . . . . . . . . . . . . . . . . . 1231
Creating a Nested Virtual Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1233
Configuring the TCP Port and Site Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234
Specifying the IIS Host Header Name for a Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
Specifying the SSL Certificate for a Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1238
Setting the IIS Certificate File at Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1239
Adding Files to an IIS Virtual Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1240
Removing Applications and Virtual Directories from the Internet Information Services View . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
Adding Application Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
Removing Application Pools from the Internet Information Services View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1242
Adding Web Service Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1243
Removing Web Service Extensions from the Internet Information Services View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1243
Feature and Component Associations for IIS Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1244
Uninstalling Web Sites, Applications, and Virtual Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
Uninstalling Web Service Extensions and Application Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
Setting the ASP.NET Version for a Web Site or Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
Specifying Whether to Perform Recursive or Non-Recursive ASP.NET Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1248
Considerations for Supporting IIS 6 on 64-Bit Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1248
Defining Application Mappings for a Web Site, Application, or Virtual Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1251
Specifying Timeout Parameters for a Web Site, Application, or Virtual Directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1251
Determining If a Target System Has IIS 6 or Earlier or the IIS 6 Metabase Compatibility Feature . . . . . . . . . . . . . . . . . . . . . . . 1252
Configuring Advanced IIS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1254
Configuring Custom Error Messages for a Web Site, Application, or Virtual Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1254
Using Windows Installer Properties to Dynamically Modify IIS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
Using InstallScript Text Substitution to Dynamically Modify IIS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
Deploying Web Services on a Target Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
Enabling Forms Authentication on Web Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
Adding IISROOTFOLDER Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
IIS_WEBSITE_NAME Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1260
IIS_PORT_NUMBER Property. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1260
Preparing Installations for Maintenance and Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1261
Preparing an InstallScript Installation for Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1261
Executing Script Code Only During Uninstallation or Only During Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1262
InstallScript Functions that Are Logged for Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263
Maintenance/Uninstallation Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1264
Removing Files that Were Created by Your Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1264
Removing Registry Data Created by Your Product. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1265
Configuring Multiple Packages for Installation Using Transaction Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1267
Overview of Multiple-Package Installations that Use Transaction Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1267
Adding a New Chained .msi Package to Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1268
Assigning Release Flags to a Chained .msi Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
Removing a Chained .msi Package from Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
Building, Testing, and Deploying Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273
Creating and Building Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273
Working with Product Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273

InstallShield 2020 User Guide ISP-2600-UG00 25

Contents

Selecting the Appropriate Type of Architecture Validation for Builds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1274

Working with Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1277
Using the Release Wizard to Create and Build a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1277
Using the Releases View to Create and Build a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1278
Setting the Release Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1279
Building a Release from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1280
Using ISCmdBld.exe to Build a Release from the Command Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1280
Passing Command-Line Build Parameters in an .ini File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1280
Using ISBuild.exe to Build from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1285
Building a Self-Extracting Executable File from the Command Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1286
Rebuilding Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1286
Performing Quick Builds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1287
Performing Batch Builds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1288
Specifying Commands that Run Before, During, and After Builds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1288
Resolving Build Errors and Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1290
Changing Project Settings from the Command Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1290
Canceling Builds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1291
Standalone Build. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1291
Installing the Standalone Build on a Build Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1291
Adding Redistributables to the Build Machine for the Standalone Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
Standalone Command-Line Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296
Standalone Automation Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296
Installing the Standalone Build and InstallShield on the Same Machine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296
Microsoft Build Engine (MSBuild) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1297
Using MSBuild to Build a Release from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1305
Configuring Release Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1305
Creating a Single Executable File for Distribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1306
Leaving Files Uncompressed in a Disk Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1307
Specifying the Required Execution Level for Your Setup Launcher on Windows Vista and Later Platforms . . . . . . . . . . . . . .1308
Specifying Whether a Product Should Be Advertised If Its InstallShield Prerequisites Are Run with Elevated Privileges . .1310
Password-Protecting Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1312
Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1312
Specifying the Run-Time Location for Advanced UI or Suite/Advanced UI Packages at the Release Level. . . . . . . . . . . . . . .1313
Specifying the Uninstallation Order of Packages in a Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1314
Digital Signing and Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1315
Digitally Signing a Release and Its Files at Build Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1317
Digitally Signing a Release After It Has Been Built From the Command Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1319
Release Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1319
Product Configuration Flags vs. Release Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1320
Filtering Based on Release Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1322
Using One Project to Create Installations for Multiple Product Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1323
Typical Web Installation vs. One-Click Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1324
One-Click Install Installations in InstallScript Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1325
One-Click Install Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1326
Player Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1326
LastError Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
Open Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1328

26 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Ether Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1328

GetLastError Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1329
IsPlaying Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1330
Play Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331
SetProperty Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331
Digital Signatures for One-Click Install Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1332
Replacing Obsolete Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1332
Default Web Page (Setup.htm). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1334
for One-Click Install Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1335
Alternate Ways to Call the Setup Player . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1335
HTTPS and One-Click Install Installations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1335
Creating One-Click Install Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1336
Using the Setup Player . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1336
Passing Data to the Launched One-Click Install Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
Running an Internet Installation Silently . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
Setting the Run-Time Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
Running a One-Click Install Installation in Debug Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
Authenticating a User from InstallScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
Setup.ini . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1339
The [Startup] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1340
The [Mif] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1342
Cloning Releases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
Creating Windows App Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
Testing and Running Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
Test Running Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
Running Installations from the InstallShield Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1346
Running Installations in Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1346
InstallScript MSI and InstallScript Silent Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1347
Creating a Silent Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1347
Creating the Response File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1348
Response File Silent Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
Response File Application Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350
Response File Dialog Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350
Response File Dialog Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1351
Sample Response File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
Running the Silent Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1362
Checking for Errors Using the Setup.log File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1362
MSI Silent Mode Installations for InstallScript MSI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1364
Silent Uninstallations from the Command Line (InstallScript MSI Only). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
Running a Suite Installation with Minimum User Interface from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
Validating Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
Validating an Installation Package or Merge Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
Specifying Whether Validation Should Be Performed at Build Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
Specifying Which ICEs, ISICEs, ISVICEs and ISBPs Should Be Run During Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
Validating an Installation Package or Merge Module on Demand. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1369
Viewing Validation Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1369
ICEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1370

InstallShield 2020 User Guide ISP-2600-UG00 27

Contents

ISICEs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1370
ISICE01 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1373
ISICE02 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1374
ISICE03 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1375
ISICE04 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1376
ISICE05 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1376
ISICE06 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1377
ISICE07 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1378
ISICE08 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1380
ISICE09 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1381
ISICE10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1381
ISICE11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1382
ISICE12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1384
ISICE16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1385
ISICE17 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1385
ISICE18 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1386
ISICE19 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1387
ISICE20 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1389
ISICE21 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1391
ISICE22 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1391
ISICE23 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1392
ISICE24 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1393
ISICE25 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1393
ISICE26 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1394
InstallShield Virtualization Suitability Suite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
ISVICE01. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1398
ISVICE02. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1398
ISVICE03. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1399
ISVICE04. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1400
ISVICE05. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1401
ISVICE06. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1402
ISVICE07. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1402
ISVICE08. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1403
ISVICE09. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1404
ISVICE10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1405
ISVICE11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1406
ISVICE12. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1406
ISVICE13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1407
ISVICE14. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1408
ISVICE15. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1409
ISVICE16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1410
ISVICE17. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1410
ISVICE18. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1411
ISVICE19. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1412
InstallShield MSIX/UWP App Suitability Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1413
ISUWP01 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1414

28 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

ISUWP02 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1415
ISUWP03 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1415
ISUWP04 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1416
ISUWP05 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1416
ISUWP06 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1417
ISUWP07 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1417
ISUWP08 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1418
ISUWP09 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1418
ISUWP10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1419
ISUWP11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1419
ISUWP12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1420
ISUWP13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1420
ISUWP14 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1421
ISUWP15 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1421
ISUWP16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1422
ISUWP17 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1422
ISUWP18 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1423
ISUWP19 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1423
ISUWP20 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1424
InstallShield Best Practice Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424
ISBP01 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1426
ISBP02 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1427
ISBP03 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1428
ISBP04 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1428
ISBP05 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1430
ISBP06 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1430
ISBP07 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1431
ISBP08 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1432
ISBP09 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1433
ISBP10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1434
ISBP11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1435
ISBP12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1436
ISBP13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1437
ISBP14 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1437
ISBP15 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1438
ISBP16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1439
ISBP17 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1440
ISBP18 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1440
ISBP19 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1441
ISBP20 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1442
Understanding When an Installation or Uninstallation Restarts the Target System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443
Debugging Windows Installer–Based Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1444
Starting the MSI Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
Setting Breakpoints in the MSI Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
Removing Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446
Viewing and Setting Properties in the MSI Debugger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446

InstallShield 2020 User Guide ISP-2600-UG00 29

Contents

Step Into Actions in the MSI Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447

Step Through Actions in the MSI Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447
Stopping the MSI Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
Spanning Installations over Multiple Disks or CDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
Compressing Multi-Disk Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
Disk Spanning Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
Custom Disk Spanning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1450
Creating a Setup Launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1451
Customizing File Properties for the Setup Launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1453
Specifying the Icon for the Setup Launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1459
Distributing Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1460
Distributing Releases to a Folder or FTP Site Automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1461
Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand . . . . . . . . . . . . . . . . . . 1461
Preparing Installations for Internet Distribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1463
Redistributable Files that Are Distributed with an InstallScript Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1464
Building 64-Bit Setup Launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1465
Deploying Windows App Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1467
Creating Transforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1469
Creating a Transform by Comparing Two .msi Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470
Creating a Transform Based on a Single .msi Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470
Applying Transforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1471
Editing Transforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1472
Opening an Existing Transform File in the InstallShield Transform Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1473
Saving .msi Files as Transforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1473
Saving Transforms as .msi Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1474
Response Transforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1474
Creating a Response Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1474
Modifying a Response Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1475
Testing a Response Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
Configuring Server Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
Adding Server Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
Modifying Server Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1477
Removing Server Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1477
Changing the Order of Server Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478

5 Creating Advanced UI and Suite/Advanced UI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1479

Advanced UI Projects vs. Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1481
Organizing Features, Packages, Prerequisites, and Files in an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . 1484
Guidelines for Adding Packages to an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
Adding an .msi Package, an .msp Patch, or a Transaction to an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . 1487
Adding an InstallScript Package to an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1488
Special Considerations for InstallScript Packages in Advanced UI and Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . 1490
Adding an InstallShield Project (.ism) as a Package in a Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1491
Adding an Executable Package (.exe) to a Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1492
Adding a Web Deploy Package to a Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1493
Adding a Sideloading Windows App Package (.appx | .msix) to a Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1495

30 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Adding a Sideloading Windows App Bundle (.appxbundle | .msixbundle) to a Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . 1496
Static vs. Dynamic Files for Packages in an Advanced UI or Suite/Advanced UI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497
Creating a Dynamic Link in an Advanced UI or Suite/Advanced UI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498
Defining Filters for a Dynamically Linked Folder in an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . 1500
Including InstallShield Prerequisites (.prq) in an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1501
Primary Packages vs. Dependency Packages in Advanced UI and Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1502
Specifying the Installation Order of Packages and Transactions in an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . 1503
Configuring Settings for a Package in an Advanced UI or Suite/Advanced UI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1504
Associating a Package in an Advanced UI or Suite/Advanced UI Project with a Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505
Sharing Common Packages Among Different Advanced UI and Suite/Advanced UI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . 1506
Specifying a Run-Time Location for a Specific Package in an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . 1507
Configuring Package Operations for an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1508
Using Custom Folder Names for Packages in Advanced UI and Suite/Advanced UI Installations . . . . . . . . . . . . . . . . . . . . . . . . . . 1510
Customizing the Behavior of a Suite/Advanced UI Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1511
Enabling Windows Roles and Features During a Suite/Advanced UI Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1512
Using Actions to Extend the Behavior of a Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1514
Working with an .exe File for an Action in a Suite/Advanced UI Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1515
Working with a DLL File for an Action in a Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517
Working with a PowerShell Script for an Action in a Suite/Advanced UI Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1520
Working with an Action that Sets a Property in a Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1522
Working with an Action that Runs InstallScript Code in a Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1522
Working with a Managed-Code Action in a Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1524
Adding an Action to a Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1528
Configuring a Suite/Advanced UI Action’s Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1528
Scheduling a Suite/Advanced UI Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1529
Types of Events in a Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1531
Defining Exit Conditions for an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1533
Triggering Install Mode or Maintenance Mode of an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . 1535
Add or Remove Program Entries for an Advanced UI or Suite/Advanced UI Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1536
Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation. . . . . . . . . . . . . . . 1537
Using Advanced UI and Suite/Advanced UI Formatted Expressions to Dynamically Configure Command Lines. . . . . . . . . . . . . 1540
Defining the End-User Interface of an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1542
Referring to Feature States and Other Feature Data in the UI of an Advanced UI or Suite/Advanced UI Project. . . . . . . . . 1543
Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time . . . . . . . . . . . . 1544
Writing Object Expressions in Advanced UI and Suite/Advanced UI Projects to Search Target Systems . . . . . . . . . . . . . . . . . . . . 1546
Minimizing the Number of User Account Control Prompts During Advanced UI and Suite/Advanced UI Installations . . . . 1548
Restarting a Target System for an Advanced UI or Suite/Advanced UI Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
Specifying the Behavior for an Advanced UI or Suite/Advanced UI Package that Requires a Restart . . . . . . . . . . . . . . . . . . 1551
Supporting Downloadable Updates for an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . 1553
Password-Protecting an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1559
Troubleshooting Issues with an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1560
Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI Installa-
tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1565
Building 64-bit Setup Exe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1567

InstallShield 2020 User Guide ISP-2600-UG00 31

Contents

6 Designing InstallShield Prerequisites and Other Redistributables . . . . . . . . . . . . . . . . . . . . . . . . . . 1571

Defining InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1573
Creating an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1574
Modifying an Existing InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1574
Setting Properties for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1574
Specifying an Alternate URL for a .prq File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1575
Setting Installation Conditions for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576
Adding a New Installation Condition for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576
Adding an Operating System Condition for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1577
Modifying an Installation Condition for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1578
Removing an Installation Condition from an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1579
Specifying Files for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1579
Specifying URLs for Downloading InstallShield Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1580
Specifying Parameters for Installing an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1581
Specifying Command-Line Parameters for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1582
Restarting a Target Machine for InstallShield Prerequisite Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1584
Specifying Installation Behavior for an InstallShield Prerequisite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1585
Specifying that an InstallShield Prerequisite Requires Administrative Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1586
Allowing End Users to Choose Whether to Install an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1586
Specifying Whether to Include the Name of a Prerequisite in the List of Setup Prerequisites to Be Installed on the Target System
1587
Specifying Whether to Show the Progress of an InstallShield Prerequisite Installation at Run Time. . . . . . . . . . . . . . . . . . . . 1588
Planning for Issues that Could Occur with an InstallShield Prerequisite Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1589
Specifying the Behavior for an InstallShield Prerequisite that Requires a Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1589
Specifying Dependencies for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1590
Adding a Dependency for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1590
Modifying a Dependency for an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1591
Removing a Dependency from an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1591
Saving an InstallShield Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1591
Designing Merge Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1593
Creating a Merge Module Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1593
Specifying the Default Destination Folder for a Merge Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1594
Selecting the Merge Module Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1595
Adding Dependencies to Merge Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1595
Adding Exclusions to Merge Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1596
Publishing a Merge Module to a Repository from Within a Merge Module Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1597
Creating InstallScript Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1599
Designing Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1600
Designing Features for Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1601
Managing Object Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1602
Designing an Object’s Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1603
Custom Object Wizards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1604
Localizing an Object’s Design-Time Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1605
Preparing an Object for Internationalization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1605
Making Your Object Compatible with Installations During Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1606
Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1607

32 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Creating a Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1607

Creating a Structure-Valued Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1609
Passing a String Array Between an Object and an Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1611
Accessing an Object’s Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1612
Creating a Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1613
Using Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1614
Object Status Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1614
Creating the Object’s Run-Time User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1617
Unsupported Features in Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1618
Building an Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1619
Building an Object from the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1619
Compiling and Building an Object from the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1620
Testing and Debugging an Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1620
Distributing an Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1622
Object Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1623
Functions Not Supported in Object Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1623
Constants Not Supported in Object Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1623
Functions Supported Only in Object Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1624
Adding a ScriptDefinedVar Property to Your Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1624
Using System Variables in Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1625
Setting Your Object’s Destination Through the Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1626

7 Modularizing Installation Projects to Distribute Development Work and Enable Reuse . . . . . . . . 1627
Specifying Installation Information for a DIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1627
Saving a DIM Project File in XML or Binary Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1628
Specifying the Default Destination Folder for a DIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1628
Using Path Variables in a DIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1629
Organizing Files for a DIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633
Configuring the Target System for a DIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633
Customizing Installation Behavior for a DIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1634
Configuring Servers for a DIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1634

8 Updating Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1635

Upgrades Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1635
Major Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1636
Minor Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1637
Small Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1638
Patching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1638
QuickPatch Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1639
Differential Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1640
Full Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1641
Determining the Best Upgrade Solution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1641
Major Upgrade vs. Minor Upgrade vs. Small Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1643
Automatic Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1646
Patch vs. QuickPatch Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1646

InstallShield 2020 User Guide ISP-2600-UG00 33

Contents

Packaging Options for Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1649

Differential vs. Full Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1650
Working with Upgrades, Patches, and QuickPatch Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1651
Understanding File Overwrite Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1651
Upgrade Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1652
Configuring InstallShield to Automatically Determine the Upgrade Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1654
Adding an Automatic Upgrade Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1654
Configuring Automatic Upgrade Item Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1654
Converting Automatic Upgrades to Major or Minor Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1655
Removing Automatic Upgrade Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1655
Creating Major Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1656
Adding a Major Upgrade Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1656
Configuring Major Upgrade Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1657
Removing Major Upgrade Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1658
Creating Minor Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1658
Adding a Minor Upgrade Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1659
Configuring Minor Upgrade Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1659
Configuring Minor Upgrades to Remove Installed Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1660
Removing Minor Upgrade Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1661
Run-Time Behavior for Minor Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1661
Creating Small Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1662
Patching Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1663
Customizing File Properties for the Update Launcher. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1665
Specifying the Icon for the Update Launcher. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1666
Patch Sequencing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1667
Patch Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1670
Non-Administrator Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1671
Creating and Applying Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1672
Adding a New Patch Configuration Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1672
Adding a New Latest Setup Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1673
Adding a New Previous Setup Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1673
Adding an External File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1674
Configuring Patch Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1674
Specifying Identification Information for a Patch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1675
Enabling the Uninstallation of a Patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1676
Sequencing Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1676
Signing a Patch Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1677
Password-Protecting a Patch Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1678
Specifying Whether to Build an Update.exe Update Launcher for a Patch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1678
Copying a Latest Setup Item to Another Patch Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1679
Removing Patch Configuration Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1680
Removing Latest Setup Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1680
Removing a Previous Setup Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1680
Building a Patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1681
Applying Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1681
Creating a QuickPatch Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683

34 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Creating a QuickPatch Project for an Existing QuickPatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683

Specifying Whether to Streamline the QuickPatch Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1684
Specifying Target Releases for Patching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685
Specifying Custom Actions for the QuickPatch to Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685
Adding Files to a QuickPatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1686
Specifying Identification Information for a QuickPatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1686
Enabling the Uninstallation of a QuickPatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1687
Sequencing QuickPatch Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1687
Signing a QuickPatch Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1688
Password-Protecting a QuickPatch Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1688
Specifying Whether to Build an Update.exe Update Launcher for a QuickPatch Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689
Deleting Files from the Files To Patch Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1690
Modifying and Removing Installed Files with a QuickPatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1690
Adding, Modifying, and Deleting Registry Data with a QuickPatch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1690
Specifying the File Format of QuickPatch Projects: XML or Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1691
Validating Upgrades, Patches, and QuickPatch Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1692
Validators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1692
Val0001 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1693
Val0002 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1694
Val0003 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1695
Val0004 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1697
Val0005 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1698
Val0006 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1699
Val0007 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1700
Val0008 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1701
Val0009 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1702
Val0011 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1703
Val0012 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1704
Val0013 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1705
Val0014 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1706
Val0015 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1707
Patching Assemblies in the Global Assembly Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1709
Working with Differential and Full Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1709
Creating an InstallScript Release to Update Previous Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1710
Notifying End Users about Upgrades Using FlexNet Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1712

9 Additional Installation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1713

Creating Multilingual Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1715
Globalization Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1715
Setting the Default Project Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1716
Settings for Languages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1717
Selecting the Installation Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1719
Marking Components as Language Dependent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1720
Installing Components Based on Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1720
Including Languages in the Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1721
Translating String Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1722

InstallShield 2020 User Guide ISP-2600-UG00 35

Contents

Exporting and Importing String Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1722

Modifying Dialogs for Each Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1724
How an Installation Determines Which Language to Use for the User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1725
Customizing Language Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1726
Language Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1727
Installing Multiple Instances of Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1731
Run-Time Requirements for Multiple-Instance Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1731
Configuring Multiple Instances in InstallShield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1732
Adding an Instance to a Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1733
Naming an Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1734
Updating the Product Code of One or More Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1734
Setting Properties for an Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1735
Deleting an Instance from a Product Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1736
Special Considerations for Multiple-Instance Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1737
Configuring and Building a Release that Includes Multiple-Instance Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1738
Configuring and Building a Major Upgrade that Includes Multiple-Instance Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1739
Creating Patches for Multiple Instances of a Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1740
Run-Time Behavior for Installing Multiple Instances of a Product. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1740
Detecting Conditions on the Target System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1745
Building Conditional Statements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1745
Conditional Statement Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1747
Detecting Administrator and Elevated Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1749
Detecting First-Time Installations, Maintenance Mode, and Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1750
Triggering Behavior Only During a First-Time Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1751
Detecting If the End User Has Selected a Specific Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1751
Detecting If the End User Is Running a Particular Operating System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1752
Detecting Whether the Installation Is Being Run on a Virtual Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1753
Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1755
Types of Condition Checks in Advanced UI and Suite/Advanced UI Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1758
Platform Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1762
File Exists Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1765
File Comparison Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1767
Registry Exists Condition Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1770
Registry Comparison Condition Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1771
Property Comparison Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1774
MSI Package Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1777
MSI Upgrade Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1779
Eligible Package Condition Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1781
InstallScript Package Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1782
Locale Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1784
Suite Installed Condition Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1785
Windows App Package Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1788
UWP Type Present Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1789
Package Operation Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1790
Feature Operation Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1791
Extension Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1792

36 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Mode Condition Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1793

Guidelines for Defining Conditions in an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1794
Detecting Whether a Specific Version of an Advanced UI or Suite/Advanced UI Installation Is Already Installed . . . . . . . . . 1796
Using Locale Conditions in Advanced UI and Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1798
Creating a Custom Condition for an Advanced UI or Suite/Advanced UI Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1800
Creating an Extension Condition DLL for an Advanced UI or Suite/Advanced UI Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1800
Adding an Extension Condition DLL to an Advanced UI or Suite/Advanced UI Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1803
Searching for Installed Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1805
Adding a Predefined System Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1805
Adding a System Search. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1806
Modifying a System Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1807
Special Considerations for Searching the Registry at Run Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1807
Publishing a System Search to a Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1809
Removing a System Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1809
Searching for XML Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1810
Editing Installation and Project Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1813
Editing Project Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1814
Adding New Tables Through the Direct Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1814
Adding Records to a Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1815
Finding and Replacing in the Direct Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1816
Editing a Table Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1817
Editing Fields in a Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1818
Exporting Tables from the Direct Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1819
Importing Tables with the Direct Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1820
Deleting Records from a Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1820
Removing Tables Through the Direct Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1821
In-Place Windows Installer Database and Project File Differencing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1822
Entering Binary Data in a Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1823
Orphaned Directory Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1824
Using InstallShield Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
InstallShield MSI Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
InstallShield MSI Diff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
Determining the Changes that a Transform (.mst File) Makes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1826
Determining Whether a Patch Is Valid for an .msi Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1827
Determining the Run-Time Effects of a Patch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1827
Determining the Differences Between Two .msi Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1828
Running InstallShield MSI Diff from the Command Line to Generate a Log File of Differences . . . . . . . . . . . . . . . . . . . . . . . . .1828
Determining the Differences Between Two InstallShield Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1829
InstallShield MSI Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1829
Running a SQL Query for a Specific Windows Installer Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1829
InstallShield MSI Sleuth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1830
Viewing Details about an .msi Package that Was Run on a Target System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1830
Searching for All Installed Packages that Include a Specific Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1831
InstallShield MSI Grep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1831
Searching .msi Packages for Specific Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1832
InstallShield Cabinet and Log File Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1832

InstallShield 2020 User Guide ISP-2600-UG00 37

Contents

Viewing InstallScript Cabinet Files (.cab) and Header Files (.hdr). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1833
Overview of InstallScript .cab and .hdr Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1834
Opening InstallScript .cab and .hdr Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1834
Extracting a File from an InstallScript .cab or .hdr File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1835
Generating a Report about an InstallScript .cab or .hdr File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1836
Viewing InstallScript Log Files (.ilg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1836
Overview of InstallScript Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1837
Opening InstallScript Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1838
Searching InstallScript Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1838
Converting an InstallScript Log File to a Text File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1839
InstallShield MSIX Bundle Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1839
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1841
Overview of Windows Installer Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1841
Windows Installer Property Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1843
SETUPEXEDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1864
Advanced UI and Suite/Advanced UI Property Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1865
Creating Properties in Windows Installer–Based Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1871
Creating Properties in Advanced UI and Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1872
Changing an Existing Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1873
Creating a Localizable Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1874
Making an Existing Property Localizable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1874
Preventing a Property Value from Being Written in Windows Installer Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1875
Preventing a Property Value from Being Written in Advanced UI and Suite/Advanced UI Debug Log Files . . . . . . . . . . . . . . . . . . 1876
Specifying that a Public Property Should Be a Restricted Public Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1877
Getting or Setting Windows Installer Properties in InstallScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1878
Removing a Value from a Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1878
Deleting a Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1879
Directly Editing .msi and .msm Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
Opening Windows Installer Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1881
Editing .msi and .msm Databases in Direct Edit Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1882
Adding Files in Direct Edit Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1882
Adding Merge Modules in Direct Edit Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1883

10 Integrating InstallShield with External Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1885

Using Source Code Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1885
Using Source Code Control Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1886
Adding Projects to Source Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1886
Checking Projects out of Source Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1887
Checking Projects in to Source Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1888
Unlinking Projects from Source Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1888
Integrating with Microsoft Visual Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1888
Creating InstallShield Projects in Microsoft Visual Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1889
Opening InstallShield Projects in Microsoft Visual Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1890
Using the VSSolutionFolder Path Variable with Visual Studio Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1890
Adding References to Visual Studio Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1891
Using the Toolbox to Add Dialog Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1892

38 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Adding InstallShield Toolbars or Commands to the Visual Studio Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1892

Building Releases in Microsoft Visual Studio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1893
Adding .NET Assemblies to Installation Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1895
Adding Project Output from a Web Service or Web Application Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1896
Integrating with Microsoft Visual Studio Team Foundation Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1896
Adding InstallShield Projects to Team Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1898

11 Automating Installation Development and Build Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1899

Linking Subfolders to Features Using VBScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1899
Exporting and Importing String Entries Using the Automation Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1902
Running Project Reports Using the Automation Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1904
Using Source Code Control at the Command Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1906
Using Build Status Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1908
Using the Automation Interface on a 64-Bit System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1909

12 Building InstallShield Project in DevOps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1911

Azure DevOps Build Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1911
InstallShield StandAlone Build with Docker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1912

13 Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1913
Menu, Toolbar, and Window Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1915
Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1915
File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1916
Home Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1917
Edit Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1918
View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1920
Go Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1921
Project Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1923
Build Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1925
Tools Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1929
Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1931
Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1931
Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1932
Standard Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1933
Controls Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1935
Layout Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1937
MSI Debugger Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1938
Output Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1938
Dialog Box Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1941
.NET Installer Class Arguments Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1945
Add an Argument/Value Pair Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1945
Add Existing Media Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1946
Add Files for This Package Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1946
Add MIME Type Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1948

InstallShield 2020 User Guide ISP-2600-UG00 39

Contents

Add New Method Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1948

Add New Property Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1949
Add Predefined Search Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1950
Add to Source Control Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1950
Application Extension Mapping Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1951
Application Mappings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1952
Associate Components Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1953
Associate DIMs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1953
Batch Build Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1953
Browse for Directory Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1954
Browse for Directory/Shortcut Target Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1955
Browse for File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1957
Browse for File to Run Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1958
Browse for Shortcut Icon Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1958
Browse for Tile Target Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1959
Certificate Selection Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1960
Check In Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
Check Out Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
Component Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1964
File Linking Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1966
Features Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1967
Condition Builder Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1968
Content Source Path Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1969
Convert InstallScript MSI Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1969
Create a New Component Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1971
Create a New Feature Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1972
Custom Error Handling Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1972
Custom Errors Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1973
Customize Validation Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1973
Data Languages Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
Delete Property Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
Dependencies Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
Dialog Images Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
Digitally Sign Setup Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
Differences Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
Dynamic File Link Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
Edit Data Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
Edit IIS Metabase Value Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
Edit List Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1980
Edit Registry Data Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
Edit Virtual Machine Configurations Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
Error Mapping Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1984
Exclusion Languages Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
Export Tables Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
Feature Condition Builder Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1986

40 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

File Details Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987

File Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987
File Properties Dialog Box (InstallScript Installation Projects) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1991
File Removal Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1991
Find and Replace Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1993
Find String ID in Project Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
Folder Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
Sharing Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
Function Signature Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1997
General Options - Advanced Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2000
General Options - Other Disk Files Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2001
History Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2002
Import Dialog Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2002
Import InstallScript Files Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2003
Import SQL Script Files Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2003
Insert Action Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2004
InstallShield Prerequisite Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2006
Languages Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2008
Link Type Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2008
Logging Options for Windows Installer 4.0 and Later Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2010
Lowercase Component Directory Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2011
Media File Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2011
Merge Module Configurable Values Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2012
Merge Module Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2012
Media Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2013
Destination Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2013
Method Browser Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2014
Method Signature Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2014
MIME Types Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2016
Modify Dynamic Links Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2017
Modify Property Dialog Box/Release Wizard—Platforms Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2018
Module Dependencies Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2020
Module Exclusions Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2021
MSI Value Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2021
MST SIS Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2021
Multi-Line String Value Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2023
New Dependency Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2025
New File Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2025
New Project Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2026
Operating Systems Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2028
Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2028
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2029
File Locations Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2030
Path Variables Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2031
User Interface Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2032

InstallShield 2020 User Guide ISP-2600-UG00 41

Contents

Preferences Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2033

.NET Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2034
Files View Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2035
File Extensions Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2036
Prerequisites Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2038
Source Control Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2038
Directory Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2040
Resource Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2040
Validation Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2041
Repository Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2042
SQL Scripts Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2043
Merge Modules Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2044
Other IIS Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2045
Other Window Styles Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2045
Other Window Styles for Dialogs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2046
Other Window Styles for Bitmap, Icon, and Text Area Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2047
Other Window Styles for Button Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2049
Other Window Styles for Combo Box Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2051
Other Window Styles for List View Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2053
Other Window Styles for Edit Field and List Box Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2055
Other Window Styles for Line Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2056
Other Window Styles for Progress Bar Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2059
Other Window Styles for Selection Tree Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2059
Outputs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2061
Overwrite Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2061
Patch Sequence Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2063
Path Variable Overrides Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2064
Path Variable Recommendation Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2064
Permissions Dialog Boxes for Files and Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2065
Permissions Dialog Boxes for Registry Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2068
Platform Suites Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2070
Platforms Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2071
Postbuild Event Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2073
Prebuild Event Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2074
Precompression Event Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2074
Prerequisite Condition Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2075
Privileges Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2081
Product Condition Builder Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2081
Project Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2083
Project Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2083
Application Tab (in Windows Installer–Based Projects) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2084
Application Tab (in InstallScript Projects) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2085
Platforms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2087
Languages Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2088
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2089
Language-Independent Object Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2089

42 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Language-Specific Object Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2090

Rename Key Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2091
Required Features Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2091
Resolve Conflict Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2092
Save As Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2093
Script Conversion Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2094
Script Editor Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2095
SCM Pre-shutdown Delay Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2099
Security Descriptor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2099
Select File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2100
Select Media Location Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2100
Select SQL Server Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2101
Select String Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2101
Serial Number Violation Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2103
Server Locations Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2103
Service Options Dialog Box for a Time Delay of an Auto-Start Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2104
Service Options Dialog Box for Running Recovery Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2105
Service SID Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2105
Set File(s) URL Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2106
Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2106
Compile/Link Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2107
Run/Debug Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2111
MSI Log File Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2112
Setup Languages Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2113
SQL Server Requirement Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2114
Supersedence Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2115
UI Languages Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2115
Update Merge Module Search Path Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2116
Wizard Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2117
Component Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2118
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2119
Setup Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2120
Destination Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2121
Files Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2122
Summary Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2123
Component Type Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2123
COM Server Component Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2124
COM Server File Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2125
Classes Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2127
Context Types Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2128
Type Library Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2129
AppID General Information Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2130
AppID Advanced Information Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2131
Summary Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2132
Control Service Component Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2132
Specify Service Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2133
Installation Events Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2134

InstallShield 2020 User Guide ISP-2600-UG00 43

Contents

Uninstallation Events Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2135

Wait Type Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2136
Summary Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2137
Install Service Component Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2137
Service Executable Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2138
Service Type Information Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2139
Service Start Type Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2140
Service Load Order Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2141
Error Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2142
Service Logon Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2143
Summary Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2144
Font Component Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2144
Add Installed Fonts Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2145
Add New Fonts Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2146
Summary Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2146
Component Wizard General Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2147
Convert Source Paths Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2148
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2148
Search Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2148
Search Results and Recommendations Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2148
Updating Your Project Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2149
Update Completed Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2149
Create New QuickPatch Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2149
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2150
QuickPatch Project Base Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2150
Original Setup Package Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2151
Location of Existing QuickPatch Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2152
Create Table Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2153
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2153
Column Properties Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2154
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2155
Custom Action Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2156
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2157
Basic Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2157
Action Type Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2158
Function Definition Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2163
Action Parameters Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2166
Managed Method Definition Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2171
In-Sequence Scripts Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2173
Additional Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2173
Respond Options Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2175
Insert into Sequence Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2176
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2177
Database Import Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2177
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2178
SQL Server Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2178
SQL Database Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2179

44 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Database Tables Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2179

Objects to Script Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2179
Scripting Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2180
Advanced Scripting Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2183
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2184
Device Driver Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2185
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2186
Device Driver Package Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2186
Device Driver Files Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2186
Device Driver Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2186
Device Driver Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2187
Project-Wide Device Driver Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2188
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2189
Dialog Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2189
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2190
Dialog Template Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2190
User Interface Sequence Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2193
Dialog Position and Condition Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2193
DirectX Object Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2194
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2195
Object Settings Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2195
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2196
Dynamic Scanning Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2196
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2197
Filter Files Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2198
Specify the Executable Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2198
Specify Application File Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2199
Launch the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2199
Your Application is Running Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2200
File Selection Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2200
Scan Results Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2201
Completing the Dynamic Scanning Wizard Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2201
Export Components Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2202
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2203
Select Components Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2203
Select Target File Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2204
Target File Info Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2205
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2205
Function Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2206
Function Name Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2206
Function Parameters Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2206
Import DIM Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2207
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2207
Select Source File Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208
Import Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208
Import REG File Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208

InstallShield 2020 User Guide ISP-2600-UG00 45

Contents

Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2209

Import Registry File Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2209
Import Conflict Options Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210
Import Progress Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210
Import XML Settings Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2211
XML File Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2212
XML Element Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2212
XML Progress Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2212
XML Results Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2213
Microsoft .NET Framework Object Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2213
Step 1 Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2213
Step 2 Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2214
MSI to MSIX Conversion Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2215
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2216
New Language Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2217
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218
Project Language Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218
Project Files Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2219
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2220
Open MSI/MSM Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2220
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2221
File Locations Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2221
Open MSP Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2222
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2222
Base MSI Package Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2222
Open Transform Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2224
Transform Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2224
Additional Transforms Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2224
Create a Response Transform Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2225
Publish Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2226
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2227
Repository Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2227
Publishing Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2227
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2228
Redistributable Downloader Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2228
Reg-Free COM Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2228
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2229
Select an EXE File Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2229
Select the Manifest File Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
Select Files Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
Release Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2231
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2231
Product Configuration Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2231

46 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Specify a Release Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232

Filtering Settings Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232
Merge Module Options Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
Setup Languages Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2234
Media Type Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2235
Disk Spanning Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2236
Disk Spanning Advanced Settings Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2237
Web Type Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2238
Downloader Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2239
Install From The Web Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2240
One-Click Install Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
Local Machine Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
Release Configuration Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2242
Custom Compression Settings Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
Setup Launcher Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
Windows Installer Location Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2244
InstallShield Prerequisites Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2245
Digital Signature Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2247
Digital Signature Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2247
Password & Copyright Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2251
.NET Framework Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2252
.NET Run-Time Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2253
.NET Language Pack Run-Time Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2253
Visual J# Run-Time Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2254
Advanced Settings Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2255
Release Settings Summary Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2258
General Options Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2258
Features Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
Media Layout Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
Custom Media Layout Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2261
User Interface Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2262
Internet Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2263
Update Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2264
Object Difference Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2266
Postbuild Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2266
Setup Best Practices Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2268
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2268
Compliance Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2269
Static Scanning Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2269
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2270
Filter Files Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2270
Scanning Progress Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2271
File Selection Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2271
Scan Results Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2272
Completing the Static Scanning Wizard Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2273
System Search Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2273

InstallShield 2020 User Guide ISP-2600-UG00 47

Contents

Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2274

What do you want to find? Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2275
How do you want to look for it? Panel (Defining Your System Search Method). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2276
Specify the file details Panel (File Search Options) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2277
How do you want to look for it? Panel (Folder Search Options). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2278
How do you want to look for it? Panel (Specific Folder Options) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2279
How do you want to look for it? Panel (Registry Search Options) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2280
How do you want to look for it? Panel (.ini File Search Options) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2281
How do you want to look for it? Panel (Component Search Option). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2281
Specify the data that you wish to find in the XML file Panel (XML File Options) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2282
What do you want to do with the value? Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2283
What do you want to do with the value? Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2284
Transform Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2285
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2285
Specify Files Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2286
Validation Settings Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2286
Suppress Error Conditions Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2288
Specify Output File Name Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2289
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2290
Completing the Transform Wizard Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2290
Upgrade Validation Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2290
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2291
Settings Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2291
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2292
User Interface Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2292
Predefined Task Pages Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2293
Task Configuration Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2295
Visual Studio .NET Wizard for Visual Basic .NET, C# .NET, and Visual C++ .NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2296
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2297
Solution Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2297
Visual Studio Deployment Project Import Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2297
Welcome Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2298
Project File Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2298
Options Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2299
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2304
View Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2305
Installation Information View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2305
General Information View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2306
General Information View Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2307
Package Information View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2343
General Information View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2343
General Information View Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2344
Visual Assets View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2347
Package Logo Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2347
Default Visual Asset Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2348
User Defined Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2352

48 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Capabilities View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2353

Device Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2353
General Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2354
Restricted Capabilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2357
Declarations View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2358
Application Declaration Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2358
Package Declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2405
Content URIs View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2408
Organization View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2408
Setup Design View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2411
Features View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2412
Feature Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2413
Components View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2424
Component Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2425
Advanced Settings for a Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2444
Application Path Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2445
Assembly Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2446
COM Registration Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2448
File Type Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453
Services Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2456
Publishing Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2456
Device Driver Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457
Other Data Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2460
Setup Types View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2461
Packages View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2462
Common Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2463
Features Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2492
Dynamic Link Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2492
DIM References View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2495
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2495
Instructions Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2496
Build Options Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2496
Features Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2497
Sequences Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2498
Application Data View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2498
Files and Folders View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2500
Destination Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2502
Redistributables View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2505
Prerequisites View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2509
Objects View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2511
System Configuration View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2512
Shortcuts View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2516
Shortcut Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2517
Folder Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2534
Tile Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2536
MSIX Applications View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2539
Application Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2540

InstallShield 2020 User Guide ISP-2600-UG00 49

Contents

Registry View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2546

ODBC Resources View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2547
ODBC Resource Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2548
INI File Changes View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2550
.ini File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2551
Section Settings for an .ini File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2552
Keyword Settings for an .ini File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2553
Environment Variables View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2554
Environment Variable Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2555
XML File Changes View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2558
General Tab for an XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2559
Advanced Tab for an XML File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2560
Namespace Tab for an XML File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2561
General Tab for an XML Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2562
Advanced Tab for an XML Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2563
Text File Changes View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2564
Change Set Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2565
Change Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2567
Scheduled Tasks View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2570
Scheduled Tasks Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2571
Services View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2574
Services View Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2575
Server Configuration View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2588
Internet Information Services View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2590
Web Site Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2591
Application and Virtual Directory Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2599
Application Pool Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2607
Web Service Extension Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2612
Component Services View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2614
Installation Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2615
SQL Scripts View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2617
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2618
Requirements Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2621
Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2623
SQL Script Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2626
General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2626
Script Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2627
Runtime Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2628
Database Import Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2631
Text Replacement Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2631
Behavior and Logic View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2632
InstallScript View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2635
Script Editor in the InstallScript View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2636
Custom Actions and Sequences View (or Custom Actions View). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2637
Custom Action Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2640
Custom Action Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2644
Action Text Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2655

50 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Support Files View (Advanced UI, Basic MSI, InstallScript Object, and Suite/Advanced UI Projects) . . . . . . . . . . . . . . . . . . . . 2658
Support Files/Billboards View (InstallScript and InstallScript MSI Projects) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2659
System Search View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2661
Property Manager View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2661
Events View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2665
Events View Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2665
User Interface View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2673
Dialogs View (InstallScript, InstallScript MSI, and InstallScript Object Projects). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2675
Dialogs View (Basic MSI and Other Windows Installer–Based Projects) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2676
Wizard Interface View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2677
Wizard Interface View Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2679
Billboards View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2684
Billboard Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2685
Settings for Adobe Flash Application File Billboards and Image Billboards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2686
String Editor View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2690
Media View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2693
Path Variables View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2695
Upgrades View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2699
Common Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2701
Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2703
Major Upgrade Item: Common Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2705
Major Upgrade Item: Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2707
Minor Upgrade/Small Update Item Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2711
Automatic Upgrade Item Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2712
Releases View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2712
Product Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2713
General Tab for a Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2713
Multiple Instances Tab for a Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2722
Release Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2723
Build Tab for a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2724
Setup.exe Tab for a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2736
Signing Tab for a Release. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2751
Internet Tab for a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2756
Events Tab for a Release. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2759
Appx/MSIX Tab for a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2768
Updates Tab for a Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2776
General Tab for MSIX Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2777
Chained .msi Package Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2787
Patch Design View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2791
Patch Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2791
Common Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2792
Identification Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2794
Digital Signature Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2795
Sequence Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2796
Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2797
Latest Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2805
Previous Setups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2805

InstallShield 2020 User Guide ISP-2600-UG00 51

Contents

Common Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2806

Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2806
Additional External Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2808
External File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2808
Additional Tools View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2808
Dependency Scanners. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2810
MSI Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2811
Direct Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2812
Windows Installer Table Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2817
InstallShield Table Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2818
ISAlias Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2819
ISCOMCatalogAttribute Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2820
ISCOMCatalogCollection Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2821
ISCOMCatalogCollectionObject Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2821
ISCOMCatalogObject Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2822
ISCOMPlusApplication Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2822
ISCustomActionReference Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2823
ISIISItem Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2824
ISIISProperty Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2825
ISProductConfigurationInstance Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2826
ISSelfReg Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2827
InstallShield Columns in Standard Windows Installer Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2828
QuickPatch Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2830
Patch Settings View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2831
General Information View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2831
Product Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2831
Build Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2832
Common Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2832
Identification Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2833
Digital Signature Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2834
Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2835
History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2842
Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2842
Files View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2842
New File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2843
Modified/Deleted File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2843
Registry View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2845
InstallShield Prerequisite Editor Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2847
Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2848
Conditions Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2848
Files to Include Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2849
Application to Run Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2850
Behavior Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2852
Dependencies Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2856
Errors and Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2857
Build Errors and Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2858
Media Build Errors and Warnings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2945
Error 118 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2946

52 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Error 129 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2947

Warning -5000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2947
Warning -5006 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2948
Warning -5020 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2948
Warning -5021 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2948
Warning -5032 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2949
Warning -5050 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2949
Warning -5051 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2949
Error -7040 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2949
Error -7041 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2950
Error -7043 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2950
Error -7044 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2950
Error -7045 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2951
Error -7126 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2951
Error -7127 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2951
Error -7275 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2952
Error -7276 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2952
Error -7380 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2952
Error -9008 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2952
MSI/MSM Conversion Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2953
Windows Installer Run-time Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2956
Setup.exe Return Values and Run-Time Errors (InstallScript Projects). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2965
Setup.exe Return Values and Run-Time Errors (Basic MSI and InstallScript MSI Projects). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2968
Setup.exe Return Values and Run-Time Errors (Advanced UI and Suite/Advanced UI Projects) . . . . . . . . . . . . . . . . . . . . . . . . . . . 2973
Visual Studio Project Import Errors and Warnings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2980
Upgrade Errors (Upgrading from InstallShield Professional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2994
Upgrade Warnings (Upgrading from InstallShield Professional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3001
Upgrade Warning 289: File Link Does Not Exist for Dynamically Linked File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3002
Upgrade Warning -305: Include In Build Property for the InstallShield Professional Component Could Not Be Directly Migrated
3002
Upgrade Warning -480: Incrementing the Shared .dll Reference Count for Files in a File Group. . . . . . . . . . . . . . . . . . . . . . . . 3003
Upgrade Warning -481: Incrementing the Shared DLL Reference Count for Dynamically Linked Files in a File Group . . . . 3003
Upgrade Warning -486: Specifying Shortcut Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3004
Upgrade Warning -487: Overwriting Files Upon Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3005
Upgrade Warning -488: Obsolete Event Encountered in Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3006
Upgrade Warning 495: ODBC Core Not Installed by Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3007
Upgrade Errors and Warnings (Upgrading from InstallShield—Windows Installer Edition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3007
HRESULT Values for Windows Installer Run-time Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3008
DIFxAPI Errors (InstallScript Projects). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3009
"String PRODUCT_NAME was not found in string table" Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3011
InstallScript Error Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3012
InstallScript Syntax or Compiler Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3012
Error C8001 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3017
Error C8002 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3017
Error C8003 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3018
Error C8004 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3018

InstallShield 2020 User Guide ISP-2600-UG00 53

Contents

Error C8005 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3019

Error C8006 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3019
Error C8007 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3020
Error C8008 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3020
Error C8009 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3021
Error C8010 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3021
Error C8011 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3021
Error C8012 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3022
Error C8013 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3022
Error C8014 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3023
Error C8015 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3023
Error C8016 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3024
Error C8017 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3024
Error C8018 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3025
Error C8019 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3025
Error C8020 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3026
Error C8021 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3026
Error C8022 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3026
Error C8023 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3027
Error C8024 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3027
Error C8025 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3027
Error C8026 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3028
Error C8027 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3029
Error C8028 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3029
Error C8031 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3030
Error C8032 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3030
Error C8033 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3031
Error C8034 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3031
Error C8035 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3031
Error C8036 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3032
Error C8037 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3032
Error C8038 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3033
Error C8039 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3033
Error C8040 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3034
Error C8042 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3034
Error C8043 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3035
Error C8044 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3035
Error C8045 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3036
Error C8046 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3036
Error C8047 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3036
Error C8048 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3037
Error C8049 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3037
Error C8050 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3038
Error C8051 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3038
Error C8052 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3038
Error C8053 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3039

54 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Error C8054 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3039

Error C8055 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3040
Error C8057 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3040
Error C8058 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3040
Error C8059 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3041
Error C8062 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3041
Error C8063 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3041
Error C8064 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3042
Error C8065 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3042
Error C8066 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3043
Error C8067 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3043
Error C8068 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3043
Error C8069 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3044
Error C8070 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3044
Error C8071 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3044
Error C8072 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3045
Error C8073 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3045
Error C8074 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3046
Error C8075 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3046
Error C8076 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3047
Error C8077 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3047
Error C8078 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3048
Error C8079 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3048
Error C8080 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3048
Error C8081 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3049
Error C8082 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3049
Error C8083 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3050
Error C8084 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3050
Error C8085 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3050
Error C8086 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3051
Error C8087 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3051
Error C8088 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3052
Error C8089 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3052
Error C8090 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3052
Error C8091 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3053
Error C8092 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3053
Error C8093 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3054
Error C8097 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3054
Error C8098 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3054
Error C8099 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3055
Error C8100 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3055
Error C8101 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3055
Error C8112 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3056
Error C8113 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3056
Error C8114 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3057
Error C8115 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3057

InstallShield 2020 User Guide ISP-2600-UG00 55

Contents

Error C8126 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3057

Error C8127 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3058
Error C8128 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3058
Error C8522 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3059
InstallScript Fatal Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3059
Error F8501 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3060
Error F8502 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3061
Error F8503 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3061
Error F8504 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3061
Error F8505 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3062
Error F8506 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3063
Error F8508 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3063
Error F8509 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3063
Error F8510 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3064
Error F8511 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3064
Error F8512 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3065
Error F8513 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3065
Error F8514 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3065
Error F8515 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3066
Error F8516 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3066
Error F8517 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3066
Error F8518 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3067
Error F8519 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3067
InstallScript Internal Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3067
Error C9001 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3068
InstallScript Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3068
Warning C7501. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3068
Warning C7502. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3069
Warning C7503. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3069
Warning C7505. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3069
Virtualization Conversion Errors and Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3071
Error -9000: Unknown Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3071
Error -9001: Unknown COM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3071
Error -9002: Error Opening Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3072
Error -9003: Error Saving Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3072
Error -9004: Process Cancelled By User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3073
Error -9005: Error Creating Temporary Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3073
Error -9006: Error Decompressing Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3073
Error -9007: File With Extension Not Found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3074
Error -9008: Error Extracting Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3074
Error -9009: Unknown Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3075
Error -9010: Invalid Target File Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3075
Error -9011: Error Reading MSI Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3076
Error -9012: Unexpected Error in Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3076
Error -9013: Type Library Not Found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3076
Error -9014: ShellExecute Failed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3077

56 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Error -9015: Unable to Determine Full Path for Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3077

Warning -9016: Contents of Table Ignored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3078
Warning -9017: .NET 1.x Assembly Not Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3079
Warning -9018: Custom Actions Ignored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3079
Warning -9019: Conditionalized Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3080
Error -9020: Directory With Null Parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3081
Error -9021: Unable to Extract COM Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3081
Error -9022: Complus Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3082
Error -9024: FileSFPCatalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3082
Warning -9026: LaunchCondition Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3083
Warning -9027: LockPermissions Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3083
Error -9028: MoveFile Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3084
Error -9029: MsiDriverPackages Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3085
Warning -9030: ODBCTranslator Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3085
Warning -9031: RemoveFile Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3086
Warning -9032: RemoveIniFile Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3086
Warning -9033: RemoveRegistry Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3087
Error -9036: ISCEInstall Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3087
Error -9037: ISComPlusApplication Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3088
Error -9038: ISPalmApp Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3088
Error -9039: ISSQLScriptFile Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3089
Error -9040: ISVRoot Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3089
Error -9041: ISXmlFile Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3090
Error -9051: Package Decompression Canceled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3090
Error -9100: CreateInstance of Package Object Failed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3090
Error -9101: Create Operation of Package Object Failed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3091
Error -9102: Failed to Write Header Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3091
Error -9103: Citrix Finalization Failed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3092
Error -9104: Citrix Save Failed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3092
Error -9105: Error Initializing Citrix Writer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3092
Error -9106: Error Initializing Citrix Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3093
Error -9107: Error Writing Citrix File Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3093
Error -9108: Error Determining Source File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3094
Error -9109: Error Writing Citrix Folder Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3094
Error -9110: Error Writing Citrix Registry Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3094
Error -9113: Error Writing Citrix INI File Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3095
Error -9114: Error Writing Citrix Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3095
Error -9115: Error Saving Citrix Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3096
Error -9116: Error Creating Empty Citrix Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3096
Error -9117: Error Creating Intermediate Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3096
Error -9118: Error Initializing Citrix Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3097
Error -9119: Error Creating Default Target in Citrix Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3097
Error -9120: Error Deleting File From Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3098
Error -9121: Failed to Copy File into Citrix Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3098
Error -9122: Target Does Not Exist in Citrix Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3099
Error -9124: No Shortcuts Created for this Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3099

InstallShield 2020 User Guide ISP-2600-UG00 57

Contents

Error -9125: Error Writing Citrix File Type Associations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3099

Error -9126: Failed to Sign Profile Using Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3100
Error -9127: Could Not Create Script Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3100
Warning -9128: Duplicate Shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3101
Warning -9129: Duplicate Shortcut Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3101
Warning -9130: Duplicate Shortcut Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3102
Warning -9131: Unable to Resolve Installer Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3102
Warning -9132: 16 Color Shortcut Icon Not Found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3103
Warning -9133: Shortcut Icon Not Found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3103
Warning -9134: Failure to Extract Icon from Executable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3104
Error -9135: Shortcut Target is 16-Bit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3104
Warning -9136: Some Files May Not Be Decompressed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3104
Warning -9137: Destination Directory Cannot Be Found. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3105
Warning -9138: Ignoring a DuplicateFile Table Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3106
Warning -9150: Warning Building Windows Installer Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3106
Error -9151: Error Building Windows Installer Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3107
Error -9200: ThinApp Must Be Installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3107
Warning -9201: Extension for Shortcut Files Must Be “.exe”. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3108
Error -9202: No Applications Were Created . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3108
Error -9203: ThinApp Tool is Missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3108
Error -9204: Duplicate Shortcut. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3109
Error -9205: Identically Named Shortcut Already Exists, But With Different Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3109
Error -9206: Identically Named Shortcut Already Exists, But With a Different Target. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3110
Error -9207: Error During Build Process (vregtool.exe) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3110
Error -9208: Error Occurred During Build Process (vftool.exe). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3111
Error -9209: Error Occurred During Build Process (tlink.exe) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3111
Error -9300: Unhandled Exception During AdviseFile Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3112
Error -9301: Unhandled Exception During AdviseRegistry Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3112
Error -9302: Unhandled Exception During Command Action. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3112
Error -9303: Unhandled Exception During Alter File Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3113
Error -9304: Unhandled Exception During Alter Registry Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3113
Error -9305: Unhandled Exception During Create Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3113
Error -9306: Unhandled Exception During Execution of Rules Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3114
Error -9401: Error Initializing App-V Writer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3114
Error -9402: Error Initializing App-V Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3114
Error -9403: Error Writing App-V File Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3115
Error -9404: Error Writing App-V Folder Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3115
Error -9405: Error Writing App-V Registry Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3115
Error -9406: Error Writing App-V INI File Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3116
Error -9407: Error Writing App-V Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3116
Error -9408: Error Writing App-V File Type Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3116
Error -9409: Error Saving App-V Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3117
Error -9410: Error Determining Source File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3117
Error -9411: OSD File Template Could Not Be Extracted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3117
Error -9412: OSD File Could Not Be Saved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3118
Error -9413: App-V OSD Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3118

58 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

Warning -9414: Local App-V Application Specified as a Dependency of the Primary Application . . . . . . . . . . . . . . . . . . . . . . . 3118
Error -9415: Dependency Application Was Not Found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3119
Warning -9416: Invalid Primary Application Directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3119
Error -9417: Dependency Application’s OSD File Contains an Invalid HREF Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3120
Error -9418: Error While Privatizing Side-By-Side Assemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3120
Error -9419: Error Inserting Watermark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3121
Error -9424: Building an App-V 5.x Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3121
Warning -9500: Shortcut Missing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3121
Error -10000: Process Cancelled By User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3122
Warning -10001: Suite File Missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3122
Warning -10002: Suite File is Duplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3123
Warning -10003: Application File Missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3123
Warning -10004: INI File Missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3123
Fix 11000: Excluding TCPIP Registry Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3124
Fatal Error 11001: Fail on VMware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3124
Warning 11003: Control Panel Applet - Citrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3124
Fix 11004: Control Panel Applet - ThinApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3125
Fatal Error 11005: QuickTime 7.4.1 Causes Fatal Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3125
Fix 11006: Adobe Distiller Exclude AdobePDFSettings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3125
Fix 11007: Exclude URL Shortcut. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3126
Steps to Take Before Calling Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3126
Application Features Requiring Pre- or Post-Conversion Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3126
Automation Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3129
Automation Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3129
ISWiProject Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3130
AddAdvancedFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3144
AddAutomaticUpgradeEntry Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3145
AddComponent Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3146
AddCustomAction Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3147
AddFeature Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3148
AddLanguage Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3150
AddPatchConfig Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3151
AddPathVariable Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3151
AddProductConfig Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3152
AddProperty Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3153
AddSetupFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3153
AddSetupType Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3154
AddSQLServerConnection Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3155
AddUpgradeTableEntry Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3156
BuildPatchConfiguration Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3157
BuildPCPFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3159
CloseProject Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3160
CreatePatch Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3160
CreateProject Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3161
DeleteAdvancedFile Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3162
DeleteComponent Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3163

InstallShield 2020 User Guide ISP-2600-UG00 59

Contents

DeleteCustomAction Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3164

DeleteMergeModule Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3164
DeletePatchConfig Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3165
DeletePathVariable Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3166
DeleteProductConfig Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3166
DeleteProperty Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3167
DeleteSetupFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3168
DeleteSetupType Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3169
DeleteSQLConnection Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3169
DeselectLanguage Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3170
ExportProject Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3171
ExportStrings Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3172
ForceUpgrade Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3173
GenerateGUID Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3174
ImportProject Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3174
ImportStrings Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3175
OpenProject Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3176
RemoveFeature Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3179
SaveProject Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3180
ISWiAdvancedFile Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3180
ISWiAutomaticUpgradeEntry Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3182
Delete Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3182
ISWiCustomAction Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3183
ISWiComponent Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3184
AddComponentSubFolder Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3200
AddDynamicFileLinking Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3201
AddEnvironmentVar Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3202
AddFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3202
AddRemoveFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3203
DeviceDriverFlagsEx Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3204
DeviceDriverSetRedist Property. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3205
ImportINIFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3206
ImportRegFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3207
ISWiRemoveFiles Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3208
RemoveComponentSubFolder Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3209
RemoveDynamicFileLinking Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3210
RemoveEnvironmentVar Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3211
RemoveFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3212
RemoveRemoveFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3212
ISWiComponentSubFolder Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3213
DeleteFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3214
ISWiCondition Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3215
ISWiDynamicFileLinking Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3216
ISWiEnvironmentVar Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3218
ISWiFeature Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3220
AddCondition Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3226

60 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

AddMergeModule Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3227

AddObject Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3228
AttachComponent Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3228
DeleteCondition Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3229
RemoveComponent Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3230
RemoveMergeModule Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3230
RemoveObject Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3231
ISWiFile Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3232
ISWiFolder Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3236
AddShortcut Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3238
AddSubFolder Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3238
DeleteShortcut Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3239
DeleteSubFolder Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3240
ISWiLanguage Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3240
AddStringEntry Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3241
DeleteStringEntry Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3242
ISWiLatestSetup Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3243
AddPreviousSetup Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3245
DeletePreviousSetup Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3245
ISWiMsiPatchSequence Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3246
ISWiObject Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3248
ISWiPatchConfig Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3248
AddLatestSetup Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3257
DeleteLatestSetup Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3258
ISWiPatchExternalFile Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3258
ISWiPatchWholeFile Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3259
ISWiPathVariable Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3260
ISWiPreviousSetup Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3262
ISWiProductConfig Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3263
AddRelease Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3267
DeleteRelease Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3268
ISWiProperty Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3269
ISWiRelease Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3270
Build Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3309
BuildTablesOnly Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3310
BuildTablesRefreshFiles Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3310
CubFile Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3311
SignMedia Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3311
ISWiRemoveFile Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3312
ISWiSequenceRecord Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3313
ISWiSetupFile Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3314
ISWiSetupType Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3316
ISWiShellProperty Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3317
ISWiShortcut Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3317
AddShellProperty Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3323
DeleteShellProperty Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3323

InstallShield 2020 User Guide ISP-2600-UG00 61

Contents

ISWiSISProperty Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3324

ISWiSQLConnection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3326
AddSQLRequirement Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3328
AddSQLScript Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3329
AddSQLScriptEx Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3329
DeleteSQLScript Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3330
GetDatabaseServer Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3331
InsertSQLScript Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3331
RemoveSQLRequirement Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3332
ISWiSQLDatabaseServer Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3333
ISWiSQLReplace Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3334
ISWiSQLRequirement Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3335
SetPredefinedRequirement Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3336
ISWiSQLScript Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3338
AddSQLScriptError Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3340
AddSQLScriptReplacement Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3341
DeleteSQLReplace Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3341
DeleteSQLScriptError Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3342
ISWiSQLScriptError Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3342
ISWiStringEntry Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3343
ISWiUpgradeTableEntry Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3344
Delete Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3345
Automation Collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3346
ISWiAdvancedFiles Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3346
ISWiAutomaticUpgradeEntries Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3347
ISWiComponents Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3348
ISWiComponentSubFolders Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3350
ISWiConditions Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3351
ISWiCustomActions Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3352
ISWiDynamicFileLinkings Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3353
ISWiEnvironmentVars Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3354
ISWiFeatures Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3355
ISWiFiles Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3356
ISWiFolders Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3357
ISWiLanguages Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3358
ISWiLatestSetups Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3359
AddMsiPatchSequence Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3360
DeleteMsiPatchSequence Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3360
ISWiMsiPatchSequences Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3361
BuildPatch Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3362
ISWiObjects Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3364
ISWiPatchConfigs Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3365
ISWiPatchExternalFiles Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3366
AddPatchWholeFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3367
DeletePatchWholeFile Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3368
ISWiPatchWholeFiles Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3368

62 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

ISWiPathVariables Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3369

ISWiPreviousSetups Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3370
AddPatchExternalFile Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3371
DeletePatchExternalFile Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3372
ISWiProductConfigs Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3372
ISWiProperties Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3374
ISWiReleases Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3375
ISWiRemoveFiles Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3376
ISWiSequence Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3377
InsertCustomAction Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3379
RemoveSequenceRecord Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3379
ISWiSetupFiles Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3380
ISWiSetupTypes Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3381
ISWiShellProperties Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3382
ISWiShortcuts Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3383
ISWiSISProperties Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3384
ISWiSQLConnections Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3385
ISWiSQLDatabaseServers Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3386
ISWiSQLReplaces Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3387
ISWiSQLRequirements Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3388
ISWiSQLScriptErrors Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3389
ISWiSQLScripts Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3390
ISWiStringEntries Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3391
ISWiUpgradeTableEntries Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3392
Automation Objects for Advanced UI and Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3395
ISWiProject Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3395
AddExitCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3403
AddLanguage Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3403
AddPathVariable Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3404
AddProperty Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3405
AddSetupFile Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3406
AddSuiteAction Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3407
AddSuiteFeature Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3408
AddSuitePackage Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3409
AddSuiteRelease Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3412
AddSuiteTransaction Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3412
CloseProject Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3413
CreateProject Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3413
DeleteExitCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3414
DeleteLanguage Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3415
DeletePathVariable Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3416
DeleteProperty Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3417
DeleteSetupFile Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3417
DeleteSuiteAction Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3418
DeleteSuiteFeature Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3419
DeleteSuitePackage Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3420

InstallShield 2020 User Guide ISP-2600-UG00 63

Contents

DeleteSuiteRelease Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3421

ForceUpgrade Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3421
GenerateGUID Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3422
ISWiSuiteEvent Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3422
OpenProject Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3425
SaveProject Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3426
ISWiLanguage Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3427
AddStringEntry Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3428
DeleteStringEntry Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3429
ISWiPathVariable Object (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3430
ISWiProperty Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3433
ISWiSetupFile Object (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3434
ISWiSuiteAction Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3435
ISWiSuiteActionRef Object (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3442
MoveTo Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3443
ISWiSuiteCondition Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3444
AddCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3447
AddExtensionCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3450
AddGroup Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3451
AddParameter Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3452
ChangeGroupType Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3452
DeleteCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3454
DeleteParameter Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3454
Move Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3455
ISWiSuiteConditionParameter Object (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3456
ISWiSuiteDFLFilter Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3457
CanMove Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3458
MoveDown Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3459
MoveUp Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3460
ISWiSuiteDynamicFileLink Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3460
AddFilter Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3461
DeleteFilter Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3462
ISWiSuiteEvent Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3463
AddSuiteActionRef Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3464
DeleteSuiteActionRef Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3465
ISWiSuiteExitCondition Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3466
ISWiSuiteFeature Object (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3467
AddCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3470
AddSuiteSubFeature Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3471
AttachPackage Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3471
DeleteCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3472
DeleteSuiteSubFeature Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3473
RemovePackage Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3473
ISWiSuiteFile Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3474
ISWiSuiteFolder Object (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3475
AddDynamicFileLink Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3477

64 ISP-2600-UG00 InstallShield 2020 User Guide

 Contents

AddFile Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3477

AddFolder Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3478
DeleteDynamicFileLink Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3479
DeleteFile Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3480
DeleteFolder Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3480
ISWiSuiteOperation Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3481
ISWiSuitePackage Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3486
AddDetectCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3505
AddEligibleCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3506
AddSuitePackage Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3506
DeleteCondition Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3508
MoveDown Method (Advanced UI and Suite/Advanced UI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3508
MoveUp Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3509
ISWiSuiteRelease Object (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3510
Build Method (Advanced UI and Suite/Advanced UI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3523
Automation Collections for Advanced UI and Suite/Advanced UI Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3524
ISWiLanguages Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3524
ISWiPathVariables Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3525
ISWiProperties Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3526
ISWiSetupFiles Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3527
ISWiSuiteActionRefs Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3527
ISWiSuiteActions Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3528
ISWiSuiteConditionParameters Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3529
ISWiSuiteConditions Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3529
ISWiSuiteDFLFilters Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3530
ISWiSuiteDynamicFileLinks Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3531
ISWiSuiteEvents Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3532
ISWiSuiteExitConditions Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3533
ISWiSuiteFeatures Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3533
ISWiSuiteFiles Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3534
ISWiSuiteFolders Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3535
ISWiSuitePackages Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3536
ISWiSuiteReleases Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3537
Object Reference for Expressions in Advanced UI and Suite/Advanced UI Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3539
Feature Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3540
File Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3542
Parcel Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3544
Platform Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3545
Registry Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3547
InstallShield Custom Action Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3551
Command-Line Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3563
Compile.exe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3565
ISCmdBld.exe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3571
ISBuild.exe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3580
IISscan.exe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3581
iSign.exe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3582

InstallShield 2020 User Guide ISP-2600-UG00 65

Contents

ReleasePackager.exe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3583
SetupIni.exe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3584
MsiExec.exe Command-Line Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3585
Setup.exe and Update.exe Command-Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3590
Advanced UI and Suite/Advanced UI Setup.exe Command-Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3606
Setup.exe (InstallScript Projects). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3610

14 Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3613

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3617

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3645

66 ISP-2600-UG00 InstallShield 2020 User Guide

 1
InstallShield 2020 Help Library

InstallShield 2020

You can use InstallShield to rapidly build, test, and deploy installations that target Windows-based systems.

The InstallShield Help Library contains information about the functionality and features of InstallShield. The Help Library
contains the following sections:

Table 1-1 • Help Library Sections

Section Description

What’s New in InstallShield 2020 Informs you about the changes in InstallShield 2020.

What Was New in Earlier Versions Informs you about changes that were made in earlier versions of InstallShield.
of InstallShield

Target System Requirements Lists the requirements for target systems.

Launching InstallShield with vs. Alerts you to functionality that is not available if you are running InstallShield
Without Administrative Privileges without administrative privileges; also describes a potential problem that may
occur if you switch between full Administrator and non-Administrator contexts and
you use mapped-drive locations in your projects.

Developing and Building Alerts you to differences that you may notice if you use InstallShield on some 32-bit
Installations on 32-Bit vs. 64-Bit systems compared to some 64-bit systems.
Systems

Using Help Provides information about the InstallShield documentation.

Getting Started Contains information to help you become familiar with InstallShield, begin creating
an installation project, and customize the InstallShield user interface.

Tutorials Leads you step-by-step through the process of creating InstallScript and Basic MSI
installation projects, and creating global installations.

InstallShield 2020 User Guide ISP-2600-UG00 67

Chapter 1 InstallShield 2020 Help Library

Table 1-1 • Help Library Sections (cont.)

Section Description

Creating Installations Explains how to create user-friendly, reliable installations and guides you through
every step of the process—from specifying information for Add or Remove
Programs to building, testing, and deploying an installation.

Creating Advanced UI and Suite/ Contains an overview, plus some detailed how-to information, about Suite/
Advanced UI Installations Advanced UI and Advanced UI projects.

The Suite/Advanced UI project type that is available in the Premier edition of

InstallShield lets you package multiple .msi packages, .msp packages, InstallScript
packages, .exe packages, sideloading Windows App packages (.appx), and
Windows Installer transactions as a single installation while providing a
contemporary, customizable user interface.

The Advanced UI project type that is available in the Professional edition of

InstallShield lets you provide a contemporary, customizable user interface for a
single .msi package, .msp package, or InstallScript package.

Designing InstallShield Introduces some basic concepts to help you get started designing your own
Prerequisites and Other InstallShield prerequisites, merge modules, and InstallScript objects that can be
Redistributables used in any of your installation projects or distributed for use by other installation
developers.

Modularizing Installation Projects Introduces developer installation manifests (DIMs), a feature-sized collection of
to Distribute Development Work related items such as product files, shortcuts, registry entries, text file changes, IIS
and Enable Reuse Web sites, and other elements that together make up a discrete portion of a
product installation.

Updating Applications Leads you through steps for planning and implementing the various types of
upgrades and patches for updating a product. Also explains how you can use
FlexNet Connect to notify end users about upgrades and patches that are available.

Creating Customized Virtual Explains how to use InstallShield to create customized virtual applications.
Applications

Additional Installation Options Discusses a broad range of options available in InstallShield: creating multilingual
installations, installing multiple instances of a product, building conditional
statements, searching for installed data, editing installation tables, and more.

Integrating InstallShield with Contains details about integrating InstallShield with third-party tools such as
External Applications source code control software, Microsoft Visual Studio, and Microsoft Visual Studio
Team Foundation Server (TFS).

Automating Installation Provides information about the InstallShield automation interface, which enables
Development and Build Processes you to automate processes for creating installation projects without having to
directly open the InstallShield user interface.

68 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
Legal Information

Table 1-1 • Help Library Sections (cont.)

Section Description

Reference Contains comprehensive reference information for the InstallShield user interface;
the InstallScript language; errors and warnings that might occur when you create,
compile, build, or run your installation; tools that you can use from the command
line to perform tasks such as building a release and running an installation; the
objects that you can use to embed object expressions in various settings of an
Advanced UI or Suite/Advanced UI project to search target systems; the
InstallShield custom actions that are added to projects; and objects, methods,
properties, and collections used to modify an installation project through the
automation interface.

Frequently Asked Questions Directs you to help topics that answer many commonly asked questions about
InstallShield and project creation.

Glossary Contains a collection of terms and their meanings.

Note • Because the InstallShield Help Library is designed to interact with InstallShield, it is recommended that you open the
help from within InstallShield. Copying the help files to another folder or system causes many of its features to work
incorrectly.

For answers to many commonly asked questions and new information about InstallShield that do not appear in the
documentation, visit the Knowledge Base.

Legal Information
InstallShield 2020

Copyright Notice
Copyright © 2020 Flexera Software. All Rights Reserved.

This publication contains proprietary and confidential information and creative works owned by Flexera Software and its
licensors, if any. Any use, copying, publication, distribution, display, modification, or transmission of such publication in
whole or in part in any form or by any means without the prior express written permission of Flexera Software is strictly
prohibited. Except where expressly provided by Flexera Software in writing, possession of this publication shall not be
construed to confer any license or rights under any Flexera Software intellectual property rights, whether by estoppel,
implication, or otherwise.

All copies of the technology and related information, if allowed by Flexera Software, must display this notice of copyright
and ownership in full.

Intellectual Property
For a list of trademarks and patents that are owned by Flexera Software, see https://www.revenera.com/legal/

InstallShield 2020 User Guide ISP-2600-UG00 69

Chapter 1 InstallShield 2020 Help Library
What’s New in InstallShield 2020

intellectual-property.html. All other brand and product names mentioned in Flexera Software products, product
documentation, and marketing materials are the trademarks and registered trademarks of their respective owners.

Restricted Rights Legend

The Software is commercial computer software. If the user or licensee of the Software is an agency, department, or other
entity of the United States Government, the use, duplication, reproduction, release, modification, disclosure, or transfer of
the Software, or any related documentation of any kind, including technical data and manuals, is restricted by a license
agreement or by the terms of this Agreement in accordance with Federal Acquisition Regulation 12.212 for civilian
purposes and Defense Federal Acquisition Regulation Supplement 227.7202 for military purposes. The Software was
developed fully at private expense. All other use is prohibited.

What’s New in InstallShield 2020

InstallShield 2020

InstallShield includes the following new features:

• New Features in InstallShield 2020 R3

• New Features in InstallShield 2020 R2

• New Features in InstallShield 2020

New Features in InstallShield 2020 R3

For information about new features added in InstallShield 2020 R3, refer to the following section:

• InstallShield Azure DevOps Build Extension

• Files and Folders View Shortcut Option

• MSIX Fonts

InstallShield Azure DevOps Build Extension

InstallShield 2020 R3 introduces native extension for building InstallShield projects in Azure DevOps pipelines. To configure
the tasks and build InstallShield projects, see InstallShield Azure DevOps Build Extension KB article.

Files and Folders View Shortcut Option

The Files and Folders view has been enhanced by adding an option to create shortcut in Basic MSI project.

To create a shortcut from Files and Folders view,

1. Right click on the executable file.

2. Click the Add Shortcut option.

70 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What’s New in InstallShield 2020

MSIX Fonts
Installshield supports “Windows Shared Fonts” declaration for MSIX project. This declaration can be added to MSIX project
from the “Declaration” view to install and share the custom fonts with other applications in the system.

InstallShield 2020 User Guide ISP-2600-UG00 71

Chapter 1 InstallShield 2020 Help Library
What’s New in InstallShield 2020

New Features in InstallShield 2020 R2

For information about new features added in InstallShield 2020 R2, refer to the following section:

• MSIX Bundles

• MSIX - Support for Services

• MSIX Bundle or AppX Bundle Packages for Suite/Advanced UI Projects

MSIX Bundles
Now you can create MSIX Bundles using a new MSIX Bundle Utility. Add your architecture specific packages to the utility,
provide signing information, and create an MSIX Bundle.

MSIX - Support for Services

Now you can create MSIX Packages with Services by a adding a new declaration to your package. Also, easily convert your
existing services in Basic MSI project to MSIX Package.

72 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What’s New in InstallShield 2020

MSIX Bundle or AppX Bundle Packages for Suite/Advanced UI Projects

In addition to the ability to create MSIX bundles, you can now add them to your Suite/Advanced UI projects and install
along with any other packages.

New Features in InstallShield 2020

For information about new features added in InstallShield 2020, refer to the following section:

• MSIX Modification Packages

• Support for MSIX Core

• Pure 64-bit Installers

• Support for AWS CloudHSM Based Digital Signing

MSIX Modification Packages

You can now use InstallShield to create Modification Packages for any given MSIX package. Create a Modification Package
as follows:

InstallShield 2020 User Guide ISP-2600-UG00 73

Chapter 1 InstallShield 2020 Help Library
What’s New in InstallShield 2020

3. Create a new Modification Package from New Project Dialog.

74 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What’s New in InstallShield 2020

4. In the MSIX Modification Package Creation Wizard, click Next.

5. Browse for your base MSIX package.

6. In Files and Folders view, add any new files you wish to add to the modification package.

InstallShield 2020 User Guide ISP-2600-UG00 75

Chapter 1 InstallShield 2020 Help Library
What’s New in InstallShield 2020

7. In Registry view, add or modify any entries, which you wish to include in the modification package.

8. Add digital signing information in the Releases view.

9. Build the project.

This would generate a Modification Package.

Support for MSIX Core

Starting from the InstallShield 2020 R1, you will be able to create and install MSIX packages targeting Windows 7 and older
versions of Windows 10 (prior to 1709). In addition to this, you can create a single Suite Installer that installs the MSIX
package in all supported platforms.

When you create an MSIX Package in a Basic MSI Project or MSIX Project, set the value in the Release view as below:

76 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What’s New in InstallShield 2020

Pure 64-bit Installers

Starting from the InstallShield 2020 R1, you will be able to create installers using 64-bit launchers for Basic MSI Projects and
Suite Projects.

1. To create a Pure 64-Bit Installer in the Basic MSI project, navigate to the Product Configuration view and select 64-Bit
Setup Launcher.

2. To create a Pure 64-Bit Installer in the Suite project, navigate to the Releases view and select 64-Bit Setup Launcher.

Support for AWS CloudHSM Based Digital Signing

You can now use the InstallShield to digitally sign your installers using an AWS CloudHSM based digital certificate. To
enable this feature, add the below property in the file <<InstallShield_Location>/Support/<0409\0411>Settings.xml.

InstallShield 2020 User Guide ISP-2600-UG00 77

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

What Was New in Earlier Versions of InstallShield

InstallShield 2020

This section describes features and enhancements that were released in earlier versions of InstallShield:

• What’s New in InstallShield 2019

• What’s New in InstallShield 2018 R2

• What’s New in InstallShield 2018 SP1

• What’s New in InstallShield 2018

• What’s New in InstallShield 2016 SP2

• What’s New in InstallShield 2016 SP1

• What’s New in InstallShield 2016

• What’s New in InstallShield 2015 SP1

• What’s New in InstallShield 2015

• What’s New in InstallShield 2014 SP1

• What’s New in InstallShield 2014

• What’s New in InstallShield 2013 SP1

• What’s New in InstallShield 2013

• What’s New in InstallShield 2012 Spring SP1

• What’s New in InstallShield 2012 Spring

• What’s New in InstallShield 2012 SP1

• What’s New in InstallShield 2012

• What’s New in InstallShield 2011

• What’s New in InstallShield 2010 Expansion Pack for Visual Studio 2010

• What’s New in InstallShield 2010 SP1

• What’s New in InstallShield 2010

• What’s New in InstallShield 2009 SP2

• What’s New in InstallShield 2009 SP1

• What’s New in InstallShield 2009

• What’s New in InstallShield 2008

• What’s New in InstallShield 12 SP1

• What’s New in InstallShield 12

See Also
Upgrading from Earlier InstallShield Versions
Upgrading from Other InstallShield Editions

78 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

What’s New in InstallShield 2019

InstallShield includes the following new features:

• New Features in InstallShield 2019 R3

• New Feature in InstallShield 2019 R2

• New Feature in InstallShield 2019

New Features in InstallShield 2019 R3

For information about new features added in InstallShield 2019 R3, refer to the following section:

• Standalone Build on a Docker Container

• Support for File Redirection Fixup

• Use OLE DB Driver for SQL Server

• Choose SQL Driver for Database Server

• Ability to Configure Patch Design Patches Through the Automation Interface

Standalone Build on a Docker Container

InstallShield Standalone Build (SAB) can now be installed and run in a Docker container.

Instructions on how to set up an InstallShield 2019 R3 Standalone Build on a Docker container or to download an already
set up InstallShield 2019 R3 Standalone Build on Docker Hub can be found in the Revenera Community Knowledge Base.

Support for File Redirection Fixup

In the previous release, InstallShield added support for Package Support Framework with file redirection and custom
fixups for MSIX.

The InstallShield 2019 R3 release includes an enhancement that permits you to customize the file redirection fixup
parameter executable name. This applies to executables that launch multiple processes.

In the previous release, the redirection fixup parameter executable was given the same name as the primary process. In
InstallShield 2019 R3, a new field, Executable, has been added to the Package Support Framework area of the
Application Settings view of an MSIX project type to enable you to specify the redirection fixup parameter executable
name. By default, this field is populated with the primary process name.

Use OLE DB Driver for SQL Server

The previous Microsoft OLE DB Provider for SQL Server (SQLOLEDB) and SQL Server Native Client OLE DB provider
(SQLNCLI) remains deprecated.

Now, Microsoft has released a new OLE DB provider called Microsoft OLE DB Driver for SQL Server (MSOLEDBSQL).

InstallShield 2019 R3 now uses Microsoft OLE DB Driver for SQL Server (MSOLEDBSQL) to support TLS 1.2 only
environments.

Advanced Note • Microsoft OLE DB Driver for SQL Server (MSOLEDBSQL) is included as a prerequisite in InstallShield 2019 R3.

InstallShield 2020 User Guide ISP-2600-UG00 79

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Choose SQL Driver for Database Server

In InstallShield 2019 R3, you can now choose a driver from a list of drivers for your database server.

By default, the Microsoft OLE DB Driver for SQL Server (MSOLEDBSQL) will appear on the Requirements tab for your new
SQL connection.

Ability to Configure Patch Design Patches Through the Automation Interface

In previous releases, you could not configure Patch Design patches through the automation interface; you could only build
pre-created patches through automation.

In the InstallShield 2019 R3 release, you can now configure Patch Design patches through the automation interface.

New Feature in InstallShield 2019 R2

For information about new features added in InstallShield 2019 R2, refer to the following section:

• MSIX - Package Support Framework

MSIX - Package Support Framework

The Package Support Framework is an opensource kit that helps you apply fixes to your existing win32 application when
you don't have access to the source code, so that it can run in an MSIX container.

It helps your application follow the best practices of the modern runtime environment. It contains an executable, a runtime
manager DLL, and a set of runtime fixes to a package.

When the users start your application, the Package Support Framework launcher is the first executable that runs. It reads
your configuration file and injects the runtime fixes and the runtime manager DLL into the application process. The
runtime manager applies the fix when it's needed by the application to run inside of an MSIX container.

In InstallShield 2019 R2, you can now use the Package Support Framework that contains runtime fixes such as the File
Redirection Fixup and Custom Fixup in MSIX.

• File Redirection Fixup - You can use the File Redirection Fixup to redirect attempts to write or read data in a directory
that isn't accessible from an application that runs in an MSIX container.

• Custom Fixup - You can use the Custom redirection fixup that will solve application compatibility issues with a
configuration file that specifies the fixes that you want to apply to your application.

New Feature in InstallShield 2019

For information about new features added in InstallShield 2019, refer to the following section:

• Use MSIX Project Type to Build an MSIX Package

• MSI to MSIX Conversion Wizard

• Build MSIX Validation Suite for Basic MSI

• Add MSIX in Suite

• New Project Wizard

80 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Use MSIX Project Type to Build an MSIX Package

MSIX is the Windows app package format that provides a modern packaging experience to all Windows apps. The MSIX
package format preserves the functionality of existing app packages and/or install files in addition to enabling new,
modern packaging and deployment features to Win32, WPF, and WinForm apps.

In InstallShield 2019, you can now use MSIX project type to build MSIX packages. It contains windows applications for side-
loading or distribution via the Windows Store.

• Package Information

• Package Payload

• Media

Package Information

Now you can describe and identify your project by providing:

• General Information view to specify details such as the name and format of the project file.

• MSIX VisualAssets explorer to offer an integrated, visual method for describing visual aspects of the MSIX apps.

• Capabilities view that requires to be enabled in app's package manifest to access certain API or resources like
pictures, music, or devices such as the camera or the microphone.

• Declarations view that provides a visual tool for creating and managing the application, package level declarations
and allows to configure their properties.

• Content URIs view to specify the URIs that can use window.external.notify to send a Script-Notify event to the app.

Package Payload

Now you can specify the files that designs your MSIX application:

• Files and Folders view lets you to add files to your InstallShield project. You can organize these files into folders on
the target system.

• Applications view offers an integrated, visual method for designing windows app properties that comprises part of or
all of the functionality delivered in the package.

• Registry view enables you to define registry keys and values to be created by your installation.

Media

Now you can customize the files and folders that you will use to distribute your installation:

• Path Variables view makes your installation easily portable between development systems through the use of
variables.

• Releases view provides a visual tool for each product in your project.

MSI to MSIX Conversion Wizard

The MSI to MSIX Conversion Wizard helps you convert existing Windows Installer files (.msi files) to MSIX package through
Basic MSI project.

InstallShield 2020 User Guide ISP-2600-UG00 81

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Build MSIX Validation Suite for Basic MSI

You can now identify the existing InstallShield projects that require changes to meet the Microsoft MSIX standards. It also
provides insights and steps needed to convert MSI project elements to work in MSIX.

Now in InstallShield, you can include a set of validators called the InstallShield MSIX Suitability Suite.

The InstallShield MSIX Suitability validators in this suite scan an.msi package for signs of items that are unsuitable for the
MSIX package (.msix) format.

Add MSIX in Suite

In InstallShield 2019, you can add an MSIX package in Suite and install along with other deployment package types.

New Project Wizard

The New Project Wizard helps you to select different project types with ease.

There are different tabs in the New Project Wizard which are given below:

• Common Project Types - Use the most commonly used project types.

• InstallScript Project Types - Use the previously built projects which uses the InstallShield setup engine with
InstallShield Professional

• Windows Installer Project Types - Use the previously built projects which uses the Microsoft Windows Installer
(MSI) setup engine with InstallShield

• MSIX Project Types - Use the Windows app package format

• All Project Types - Use all the available project types and any custom templates.

InstallShield 2019 R2 Enhancements

InstallShield 2019 R2 includes the following enhancements:

• Delay between Signing

• IsCmdBld.exe Parameter to Specify Digital Certificate Password

• Allow Suite Project to use Relative Path to link to ISM Package

• Update SQL 2012 Native Client prerequisites

• Add Windows Server 2019 in PRQ Conditions

Delay between Signing

InstallShield 2019 R2 supports adding a delay between the successive digital signing, this requires only if the timestamp
server fails handle the successive signing requests.

Required to specify the <DelayBetweenSigning default="1500"/> node in the settings.xml, under <DevStudio/Build> node
in Settings.xml in milliseconds.

Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following locations,
depending on which language version of InstallShield you are using:

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

82 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

IsCmdBld.exe Parameter to Specify Digital Certificate Password

Project • This information applies to the following project types:

• Basis MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI
• Advanced UI

In InstallShield 2019 R2, there is a new parameter (cert_password) that specifies the digital certificate password, this is an
optional parameter in the command line build (IsCmdBld.exe).

If it is not specified, the password configured in the project is used to sign the files.

Allow Suite Project to use Relative Path to link to ISM Package

Project • This information applies to the following project types:

• Basis MSI
• InstallScript

In InstallShield 2019 R2, now when trying to build a modified project, you will be able to link an ISM package using a relative
path.

Update SQL 2012 Native Client prerequisites

Project • This information applies to the following project types:

• Basis MSI
• InstallScript
• InstallScript MSI

In InstallShield 2019 R2, the Microsoft SQL Server 2012 Native Client prerequisites (x86 and x64) which is now included for
the latest versions of 2012 Native Client.

Add Windows Server 2019 in PRQ Conditions

Project • This information applies to the following project types:

• Basis MSI
• InstallScript

In InstallShield 2019 R2, you can set the Prerequisite Condition to run on a specified platform for Windows Server 2019. You
can set the appropriate PRQ Conditions in the Prerequisite Editor by selecting or deselecting the option.

InstallShield 2020 User Guide ISP-2600-UG00 83

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Enhancements in InstallShield 2019

InstallShield 2019 includes the following enhancements:

• View Details of a Selected Certificate

• Add Windows Server 2019 for Operating System Requirement

• Add Predefined Install Conditions

• Update TimeStamp Server Selection for Digital Signatures

• Support for Suite Projects using MSBuild

• Customize Debug Log File Name

• Customize Custom Return Code

• Customize Setup File Name

• Support for InstallShield Standalone Build

View Details of a Selected Certificate

Project • This information applies to the following project types:

• Basis MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI
• QuickPatch
• MSIX

In InstallShield 2019, the details of the certificate like the general information of the certificate, security details and
certification path is listed on the View Details option in the Certificate Selection dialog box.

Add Windows Server 2019 for Operating System Requirement

Project • This information applies to the following project types:

• Basis MSI
• InstallScript MSI

In InstallShield 2019, you can add an option for Windows Server 2019 in the operating system requirements section. You
can set the appropriate Install Condition in the project by selecting or deselecting the option.

Add Predefined Install Conditions

Project • This information applies to the following project types:

84 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Basis MSI
• InstallScript MSI

InstallShield has new predefined system search:

• Microsoft .NET Framework 4.6.2

If your installation requires the above, you can use the System Search view or the Installation Requirements page in the
Project Assistant to add this system search to your project. When end users launch your installation, Windows Installer
checks the target system to see if the requirements are met; if they are not met, the installation displays the error message
that is defined for the system search.

Update TimeStamp Server Selection for Digital Signatures

Project • This information applies to the following project types:

• Advanced UI
• Basis MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

In InstallShield 2019, if you select

• SHA-1 to sign the package, the package will get time timestamped using:

<DigitalSignature Timestamp="http://timestamp.verisign.com/scripts/timstamp.dll"/>

• SHA-256 to sign the package, the package will get time timestamped using:

<DigitalSignature TimestampRFC3161="http://sha256timestamp.ws.symantec.com/sha256/timestamp"/>

Support for Suite Projects using MSBuild

Project • This information applies to the following project types:

• Suite/Advanced UI

InstallShield supports the Microsoft Build engine (MSBuild) included with the .NET Framework. MSBuild support enables
you to build Visual Studio solutions with InstallShield projects where Visual Studio is not installed in the build lab
environments.

In InstallShield 2019, you can now build suite projects (.sln) which are created in Visual Studio using MSBuild.

Customize Debug Log File Name

Project • This information applies to the following project types:

• Suite/Advanced UI

InstallShield 2020 User Guide ISP-2600-UG00 85

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

An option, Always Create Debug Log, had been added to the Setup.exe tab of the Releases view for Advanced UI and
Suite/Advanced UI projects.

Now in InstallShield 2019, you can specify the debug log file name which will be generated.

Customize Custom Return Code

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• InstallScript

In InstallShield 2019, you can now override the return code of setup.exe with your own custom values during the runtime.

Customize Setup File Name

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• InstallScript
• Suite/Advanced UI

In InstallShield 2019, you have the ability to customize the original file name property for setup.exe.

Support for InstallShield Standalone Build

Now when you install the InstallShield Standalone build, the Automation Interface feature is set to default selection.

This allows you to install the Automation Interface feature without selecting manually.

Additional Prerequisites Included

InstallShield 2019 includes the following additional prerequisites:

• Microsoft .Net Core 2.1 Runtime Prerequisite

Microsoft .Net Core 2.1 Runtime Prerequisite

InstallShield now includes the prerequisites for Microsoft .Net Core 2.1 Runtime in the redistributables view.

What’s New in InstallShield 2018 R2

For information about new features added in InstallShield 2018 R2, refer to the following section:

• Build MSIX Package using InstallShield IDE

86 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Build MSIX Package using InstallShield IDE

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

In InstallShield 2018 R2, you can now build an MSIX package using the InstallShield IDE.

What’s New in InstallShield 2018 SP1

For information about new features and enhancements added in InstallShield 2018 SP1, refer to the following sections:

• Configure Downloadable Updates for a Suite/Advanced UI Installation

• Support Dual Signing using SHA1 & SHA256 Digest

• Configure Suite Loading Screen Message

• Customize Update Launcher Name

• Specify Character Space in PowerShell Custom Action

• Specify Predefined Public Folder

Configure Downloadable Updates for a Suite/Advanced UI Installation

In Installshield 2018 SP1, you can now enable and configure a software downloadable update. The end user can either
download a newer version or skip and proceed with the current installation process.

• Enable Downloadable Update Support

• Configure a Newer Version of Downloadable Updates

• Configure a Prompt Message

• Add Downloadable Update Support

Enable Downloadable Update Support

You can now enable updates for the end users to see the downloadable update support for your Advanced UI or Suite/
Advanced UI setup launcher.

Configure a Newer Version of Downloadable Updates

• The end users receive an option to either download a newer version or skip and proceed with the current installation
process.

• The end users can forcibly download and install the new version of the Suite package (if available).

Configure a Prompt Message

You can now enter a message you want to show the end users to download a newer version or skip and proceed with the
current installation process.

You can also create a new message or select a message from the localized available list of strings.

InstallShield 2020 User Guide ISP-2600-UG00 87

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Note • The end users will see this prompt message with ‘Yes’ and ‘No’ options to download a newer version or skip and
proceed with the current installation process.

Add Downloadable Update Support

In previous releases, you could enter the Absolute Path in an Advanced UI or Suite/Advanced UI installation that you want
to use for the future path to the update setup launcher that you will make available for download to target systems on the
Setup.exe tab of the installer.

In InstallShield 2018 SP1, you could enter the same Absolute Path in an Advanced UI or Suite/Advanced UI installation on
the Updates tab of the installer.

Support Dual Signing using SHA1 & SHA256 Digest

In previous releases, you could choose the signature digest hashing algorithm only based on:

• Certificate Hash

• SHA-1

• SHA-256

In InstallShield 2018 SP1, along with the above signature digest hashing algorithm, you can now choose Dual Signing -
(SHA-1 and SHA-256) digest.

Note • Using both (SHA1 and SHA256) digests are not supported by the Digital signature of msi.

Configure Suite Loading Screen Message

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

In InstallShield 2018, you now have the ability to add a message to the Suite Loading Screen Message for your Advanced UI
or Suite/Advanced UI setup launcher.

The length of the message in the Suite Loading Screen Message is limited to 35 characters.

Customize Update Launcher Name

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• QuickPatch

In InstallShield, a new setting is introduced to customize the name of the Update Launcher. By default, InstallShield uses
Update.exe is the name for the Update Launcher. Now, you can create an Update Launcher with a specified name.

88 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Specify Character Space in PowerShell Custom Action

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

In InstallShield, a new setting is introduced to specify the number of character space(s) to move forward/backward in a
PowerShell custom action.

Specify Predefined Public Folder

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

In InstallShield, a new predefined folder is introduced to hold the full path to the Users Public folder.

What’s New in InstallShield 2018

For information about new features added in InstallShield 2018, refer to the following sections:

• Specify Uninstallation Order of Packages in a Suite Project

• Method to Run a Suite Installation with Minimum UI

• Conditionally Set the Visibility of a Feature at Run Time

• Perform Recursive or Non-Recursive IIS Registration

• Set Forms Authentication on Web Applications

• New Option to Control Whether to Load User Profile for an Application Pool Entity

• Add Kill Process and PowerShell Custom Actions to a Transform Project

• Enhancements

InstallShield 2020 User Guide ISP-2600-UG00 89

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Specify Uninstallation Order of Packages in a Suite Project

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

In InstallShield 2018, you can now specify the uninstallation order of packages in a suite project using the new
Uninstallation Order property on the Setup.exe tab of the Releases view.

You can use this setting to specify the uninstallation order of the packages in a suite project by selecting one of the
following options:

• Same as Packages Order—Uninstall the packages in the same order that packages were installed (as defined in the
project).

• Reverse of Packages Order—Uninstall the packages in the reverse order that packages were installed (as defined in
the project).

New UninstallOrder Method in Automation Interface

You can use the UninstallOrder method in the automation interface to set the Uninstallation Order property. Specify
one of the following values:

• euoForward(0)—Uninstall the packages in the same order that packages were installed (as defined in the project).

• euoReverse(1)—Uninstall the packages in the reverse order that packages were installed (as defined in the project).

Method to Run a Suite Installation with Minimum UI

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

In InstallShield 2018, you can now use a new command line parameter to run a suite installation in minimum UI mode, only
displaying a progress panel.

To run a suite installation in minimum UI mode, use the /passive parameter in the command line:

Setup.exe /passive

To uninstall using a minimum UI mode, use the following command:

Setup.exe /passive /remove

Conditionally Set the Visibility of a Feature at Run Time

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

90 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

In previous releases, you could set the Visible property of a feature in an Advanced UI or Suite/Advanced UI installation to
Yes or No specify whether the feature should be visible on the InstallationFeatures wizard page of the installer.

In InstallShield 2018, you can conditionally show or hide a feature based upon a property at run time using the new
Condition option under the Visible property on the Features view of the Installation Designer.

You can use the Condition setting to specify one or more conditions that the Advanced UI or Suite/Advanced UI installation
should use to evaluate whether the feature should be visible for installation by default on the InstallationFeatures wizard
page.

For example, if you want a particular feature to be visible by default on target systems that have a particular version of
Windows, you can create a condition that specifies that version of Windows.

Task To conditionally display a feature in an Advanced UI or Suite/Advanced UI installation:

1. On the Features view, click in the Condition row under the Visible property. A green plus sign, the New Condition
button, appears at the end of the row.

2. Click the New Condition button. A new row is added under the Condition row.

3. Click the down arrow next to the New Condition button and select the appropriate option—All, Any, or None—from
the list.

4. Then in the same row, click the New Condition button, and select the appropriate option to continue building the
conditional statement.

If one or more conditional statements are configured, the Condition property lists (Condition). If none are
configured, the Condition property lists (Empty).

New Methods in Automation Interface to Support Conditional Visibility

The following new methods have been added to the automation interface to enable you to conditionally set the visibility of
a feature at run time:

Method Syntax

AddVisibleCondition AddVisibleCondition() As ISWiSuiteCondition

DeleteVisibleCondition DeleteVisibleCondition()

VisibleCondition Read-only object property

Perform Recursive or Non-Recursive IIS Registration

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 91

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Merge Module

A new option named ASP.NET Registration has been added to the Application settings on the Internet Information
Services view that enables you to perform recursive or non-recursive ASP.NET registration. Using this feature enables you
to install both ASP.NET applications and ASP.NET Core applications to the same website.

To set the ASP.NET application registration option with Internet Information Services (IIS), set the ASP.NET Registration
property to one of the following options:

• Recursive—Updates script maps and application-pool assignments for the specified application and for all sub-
applications.

• Non Recursive—Updates script maps and application-pool assignments for only the specific application. No sub-
applications are changed.

Set Forms Authentication on Web Applications

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

InstallShield 2018 includes a new option to set forms authentication on web applications. This new option, Forms
Authentication, is displayed under the Authenticated Access section of the Internet Information Services view for a
website.

Set the Forms Authentication option to Yes to enable forms authentication. ASP.NET forms-based authentication works
well for sites or applications on public Web servers that receive many requests. This authentication mode lets you manage
client registration and authentication at the application level, instead of relying on the authentication mechanisms
provided by the operating system.

Important • Forms authentication sends the user name and password to the Web server as plain text. You should use Secure
Sockets Layer (SSL) encryption for the Log On page and for all other pages in your application except the Home page.

New Option to Control Whether to Load User Profile for an Application Pool Entity

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

In InstallShield 2018, there is a new Application Pool settings property on the Internet Information Services view, named
Load User Profile, that controls whether to load the user profile for an application pool entity.

Set the Load User Profile property to one of the following options:

• Yes—IIS will load the user profile for the application pool.

• No—IIS will not load the user profile for the application pool. This is the same behavior that occurred with IIS 6.0.

92 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Add Kill Process and PowerShell Custom Actions to a Transform Project

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Transform

In previous releases, you were unable to add a Kill Process or PowerShell custom action to a Transform project. In
InstallShield 2018, you can now add a New Kill Process or New PowerShell custom action to a Transform project in the
Custom Actions and Sequences view.

Enhancements
InstallShield 2018 includes the following enhancements:

• Save QuickPatch Projects in XML Format

• Localize Product Name Property in Suite Projects

• Include the Value of a Property in a Product Configuration’s Setup File Name

• New MSBuild Parameters to Set Summary Information Stream Comments and to Set Package File Name

• Specify Line Break and Tab Characters in Text File Changes

• Remove or Hide the Suite Loading Screen

• Setting to Always Create Debug Logs for Suite Installers

• New Out-of-the-Box Dialog to Set the IIS Certificate File for SSL Certificate at Runtime

• Specify Absolute or Relative Path When Creating New Child Elements in an XML File

• Setting the Default Keyboard Focus for Dialog Box Controls in Suite Projects

• PowerShell Script Editor in Basic MSI Projects

• New Option to Open Existing Transform File in InstallShield Transform Wizard

• Additional Prerequisites Included

Save QuickPatch Projects in XML Format

Project • This information applies to the following project types:

• Basic MSI
• QuickPatch

In InstallShield 2018, you can now save a QuickPatch project in XML format, and you can also create a QuickPatch project
from projects saved in XML format. In previous releases, QuickPatch projects could only be saved in binary format.

InstallShield 2020 User Guide ISP-2600-UG00 93

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Localize Product Name Property in Suite Projects

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

In InstallShield 2018, suite projects now support localizing the Product Name property.

To localize the Product Name property in a suite project, perform the following steps.

Task To localize a property in a suite project:

1. Open a suite project and go to the User Interface > String Editor view.

2. Create a new string that contains the localized text for each of the languages supported by your suite project, such as
ID_STRING2.

3. Open the Installation Information > General Information view.

4. Click the browse button next to the Product Name field to open the Select String dialog box.

5. Select the name of the string that you created that contains the localized text.

Include the Value of a Property in a Product Configuration’s Setup File Name

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

In InstallShield 2018, you can now include the value of a property from the Property Table in product release configuration
setup and package file names.

For example, you could enter any of the following properties in the Setup File Name or MSI Package File Name field on
the General tab of the Releases > Product Configuration view:

setup[ProductVersion]
setup[CustomVersion]
setup[ProductCode]
setup[ProductCode][ProductVersion]

If you entered setup[ProductVersion] in the Setup File Name field, it would result in a setup named
setup14.10.1234.exe, for example.

New MSBuild Parameters to Set Summary Information Stream Comments and to Set Package File Name
In InstallShield 2018, new MSBuild parameters were added to enable you to set add comments to an installer and to set the
package file name of an installer.

• New Parameter to Set Summary Information Stream Comments

• New Parameter to Set Package File Name

94 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New Parameter to Set Summary Information Stream Comments

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• Merge Module

You can add comments to an installer in the Summary Information Stream Comments field on the General Information
view.

In InstallShield 2018, you also have the option of entering comments at build time. A new parameter has been added to the
MSBuild.exe task, named SummaryInfoComments, to set the Summary Information Stream comments at build time, such
as including the build number, as shown in the following example:

MSBuild.exe c:\installers\Setup.sln /Property:SummaryInfoComments="Insert Comments Here"

The comments that are added using the SummaryInfoComments property can be viewed on the Properties dialog box of the
built installer.

New Parameter to Set Package File Name

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

You can specify the package file name of an installer in the MSI Package File Name field on the General tab for a Product
Configuration field on the Releases view.

In InstallShield 2018, you also have the option of setting the package file name at build time. A new parameter has been
added to the MSBuild.exe task, named MSIPackageFileName, to set the package file name of the built installer at build
time, as shown in the following example:

MSBuild.exe c:\installers\Setup.isproj /Property:MSIPackageFileName="MySetup"

When entering the value for the MSIPackageFileName parameter, you need to enter the file name—without the period or
the file extension—that InstallShield should use for the .msi file.

Specify Line Break and Tab Characters in Text File Changes

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

InstallShield 2020 User Guide ISP-2600-UG00 95

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

In your installer, you can configure search-and-replace behavior for content in text files that you want to modify at run time
on the target system. To do this, you open the System Configuration > Text File Changes view and add a text Change Set
that identifies the text files that will be searched at runtime, and also specifies the text to search for (Find What) and the
text to replace it with (Replace With).

In InstallShield 2018, when adding a text Change Set, you can now enter escape sequence characters in the Replace What
field to specify a line break or a tab.

Character Escape Sequence

Line break \r\n

Tab \t

Note • For the Windows operating system, you must enter both \r\n to insert a line break.

When the search-and-replace action is taken at runtime, a line break will be inserted where \r\n was entered in the
Replace With field, and a tab will be entered where \t was entered.

For these characters to be recognized as escape sequences, you also have to set the Parse Escape Sequences option to
Yes.

Remove or Hide the Suite Loading Screen

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

In InstallShield 2018, you now have the ability to control whether or not the Suite Loading Screen is displayed during
installation.

To control whether this screen is displayed, a new property has been added to the Setup.exe tab of the Releases view
named Show Suite Loading Screen. If you want to hide the Suite Loading Screen for your Advanced UI or Suite/Advanced
UI setup launcher, set this property to No.

Configure Suite Loading Screen Message

In InstallShield 2018, you now have the ability to add a message to the Suite Loading Screen Message for your Advanced UI
or Suite/Advanced UI setup launcher.

The length of the message in the Suite Loading Screen Message is limited to 35 characters.

New ShowSuiteLoadingScreen Method in Automation Interface

You can use the ShowSuiteLoadingScreen method in the automation interface to set the Show Suite Loading Screen
setting on the Setup.exe tab of the Releases view. The default value is True.

96 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Setting to Always Create Debug Logs for Suite Installers

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

In InstallShield 2018, you can now select an option to turn on logging for a suite project without passing debuglog through
the command line.

A new option, Always Create Debug Log, has been added to the Setup.exe tab of the Releases view for Advanced UI and
Suite/Advanced UI projects.

If you want to always create debug logs for your Advanced UI or Suite/Advanced UI setup launcher, set the Always Create
Debug Log option to Yes.

New CreateDebugLog Method in Automation Interface

You can use the CreateDebugLog method in the automation interface to set the Always Create Debug Log setting on the
Setup.exe tab in the Releases view. The default value is False.

New Out-of-the-Box Dialog to Set the IIS Certificate File for SSL Certificate at Runtime

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2018 includes a new out-of-the-box dialog (IISBrowseSSLCertificate) for the installer that enables the end
user to browse to a IIS certificate file that they provide for the SSL Certificate and enter a password at installation runtime.

To add a Configure SSL for IIS dialog to your installer, perform the following steps:

Task To add a “Configure SSL for IIS” dialog to your installer:

1. In the View List under Server Configuration, click Internet Information Services.

2. Right-click the Web Sites explorer and click Add Web Site. InstallShield adds a new Web site.

3. Select the new web site and locate the SSL Certificate and SSL Certificate Password properties under Security >
Secure Communication.

4. Set the SSL Certificate and SSL Certificate Password properties to the following values:

Property Value

SSL Certificate [IS_IIS_WEBCERTPATH]

SSL Certificate Password [IS_IIS_WEBCERTPASSWORD]

5. Open the User Interface > Dialogs view and add the IISBrowseSSLCertificate dialog to the dialog sequences.

InstallShield 2020 User Guide ISP-2600-UG00 97

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The property name for the SSL Certificate and password configured by the user is required to update in the
IISBrowseSSLCertificate dialog for the Edit boxes (IISWebCertPassword and IISWebCertPath) and the push button
(BrowseCertificate) events.

Specify Absolute or Relative Path When Creating New Child Elements in an XML File

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

In previous releases, when using the System Configuration > XML File Changes view to add a new child element to an XML
file that has the same name as a child element in an existing parent element, the XML file change would fail.

The path of a node in an XML document can be either absolute or relative. Absolute paths start at the root. When adding a
new child element to an XML file that has the same name as a child element in an existing parent element, it is necessary to
use the absolute path.

In InstallShield 2018, a new setting has been added to the XML File Changes view named Use Absolute XPath to enable
you to specify that you want to use an absolute path when creating child elements.

The behavior used when creating a child element depends upon the Use Absolute XPath option setting:

• Selected—If this option is selected, Absolute XPath will be used when adding a child element.

• Not selected—if this option is not selected, Generic XPath will be used when adding a child element. By default, the
Use Absolute XPath option is not selected.

Setting the Default Keyboard Focus for Dialog Box Controls in Suite Projects

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

In InstallShield 2018, when defining the wizard pages for a Suite project, you can now specify which control on a wizard
page will have the default keyboard focus.

On the Wizard Interface view, there is a new property under Appearance named Default Focus, which lists all of the
controls defined on that wizard page. Select a control to set the default keyboard focus to that control.

PowerShell Script Editor in Basic MSI Projects

Project • This information applies to the following project types:

98 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Basic MSI
• InstallScript MSI

In InstallShield 2018, the PowerShell script editor is available on the Custom Actions and Sequences > Custom Actions
view for Basic MSI projects, on the new Script tab. In previous releases, the PowerShell Script Editor was only available for
Suite/Advanced UI projects.

New Option to Open Existing Transform File in InstallShield Transform Wizard

Project • This information applies to the following project types:

• Transform

In InstallShield 2018, you can now open an existing transform file in the InstallShield Transform Wizard (as if it were being
opened in the Transform Wizard for the first time), where you will be prompted to select a base MSI package for the
transform file. This enables you to use the same generic transform file for multiple MSI packages.

To open an existing transform file in the InstallShield Transform Wizard, right-click on the transform file in Windows
Explorer and select Open in InstallShield Transform Wizard from the context menu.

Additional Prerequisites Included

InstallShield 2018 includes the following additional prerequisites:

• Visual C++ 2017 x86 and x64 Prerequisites

• Microsoft SQL Server 2014 SP1 and SP2 Prerequisites

• Microsoft .NET Framework 4.7 Prerequisite

Visual C++ 2017 x86 and x64 Prerequisites

Because Microsoft Visual Studio 2017 has been released, InstallShield now includes the prerequisites for Visual C++ 2017
x86 and x64.

Microsoft SQL Server 2014 SP1 and SP2 Prerequisites

Because Microsoft SQL Server 2014 has had 2 Service Packs released, InstallShield now includes the prerequisites for both
Microsoft SQL Server 2014 SP1 and SP2.

Microsoft .NET Framework 4.7 Prerequisite

InstallShield now includes a prerequisite for Microsoft .NET Framework 4.7.

What’s New in InstallShield 2016 SP2

Integration with FlexNet Code Aware
InstallShield now includes integration with FlexNet Code Aware, an automated open source risk assessment and package
discovery solution that enables you to quickly scan your products for security and intellectual property (IP) compliance
risk.

The current release of FlexNet Code Aware supports analysis of the following files:

InstallShield 2020 User Guide ISP-2600-UG00 99

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Java Packages

• Node Packages

• Nuget Packages

• RPM Packages

• Ruby Packages

• EXE & DLL Files

Security vulnerabilities are looked up against the National Vulnerability Database (NVD).

Running FlexNet Code Aware

FlexNet Code requires a separate license from InstallShield. There is also trial/evaluation version. For more information,
refer to the FlexNet Code Aware product page of the Revenera website.

To run FlexNet Code Aware from within InstallShield, click Scan Project using FlexNet Code Aware from the InstallShield
Project menu. This menu option is disabled out if you are not currently in an open InstallShield project. A FlexNet Code
Aware icon is also available on the InstallShield standard toolbar.

When FlexNet Code Aware completes the scan of your project, a summary displays showing the number of files scanned,
and the number of open-source packages and vulnerabilities found. A View report button is provided if you have a fully
licensed version of FlexNet Code Aware. For more information about the details provided in this report, refer to Reading the
FlexNet Code Aware Report.

Reading the FlexNet Code Aware Report

Note • The FlexNet Code Aware Report is not available in trial/evaluation mode. A fully licensed version of FlexNet Code
Aware is required.

To view the FlexNet Code Aware Report, click View report on the summary dialog that appears after FlexNet Code Aware
has scanned your project.

The FlexNet Code Aware report consists of several sections:

• The initial Summary View presents the user with a Scan Summary, Operational Risk assessment, Security
Vulnerability Exposure, and License Exposure.

• The Scan Summary section provides details regarding the codebase that was scanned, including a breakdown of
file types, percent of files analyzed, and number of findings.

• The Operational Risk section provides a composite risk rating based on the combination of packages with
Intellectual Property (IP) issues and packages with Security Vulnerabilities.

• The Security Vulnerability Exposure and License Exposure sections provide a breakdown of the types and
categories of identified issues.

• The Package Inventory View, available by clicking view full package inventory in the Scan Summary section,
provides a complete list of discovered open source and third-party packages with associated licenses, security
vulnerabilities, dependencies, and detected copyright statements.

The Package Inventory View provides filters that you can use to execute targeted queries to refine the list to various
package types of interest.

100 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Viewing Package Details

Click a vulnerability count listed in the Vulnerabilities column of the Package Inventory report page for each package you
want to review. The Vulnerabilities detail page appears, covering a portion of the Package Inventory report.

What’s New in InstallShield 2016 SP1

Support for Microsoft Visual Studio 2017
InstallShield includes support for Visual Studio 2017. You can create InstallShield projects from within this version of Visual
Studio.

What’s New in InstallShield 2016

InstallShield 2016 includes the following new features:

• Support for the Latest Releases of Windows Operating Systems

• Microsoft SQL Server 2016 Support

• Support for Creating Windows App Packages

• SQL Support Added to Suites

• Tile Configurations

• New InstallShield Prerequisites for Microsoft Visual C++ 2015, .NET Framework 4.6, and More

• Predefined System Searches for Adobe Reader, Microsoft Office and the .NET Framework

Support for the Latest Releases of Windows Operating Systems

InstallShield 2016 supports the latest releases of the Windows operating system:

• Windows 10 Anniversary Update

• Windows Server 2016

Not only can you install InstallShield on these operating systems, but you can also create installers that target these
operating systems.

Microsoft SQL Server 2016 Support

Project • Microsoft SQL Server 2016 support is available in the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 101

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

InstallShield now includes support for running SQL scripts on SQL Server 2016 database servers. In addition, InstallShield
includes SQL Server 2016 in the predefined list of database servers that you can select when you are specifying in the SQL
Scripts view the target database servers that your product supports.

If your installation targets SQL Server 2016, the SQLBrowse run-time dialog that is displayed when end users choose to
browse for a database server can now list instances of SQL Server 2016, SQL Server 2016 Express, and SQL Server 2014
Express LocalDB. In addition, the SQLBrowse run-time dialog that is displayed when end users choose to browse for a
database catalog can now list catalogs on the specified SQL Server 2016 database server.

See New InstallShield Prerequisites for Microsoft Visual C++ 2015, .NET Framework 4.6, and More for a complete list of new
InstallShield prerequisites added to InstallShield.

Note • Microsoft SQL Server 2016 is now 64-bit (x64) only.

Support for Creating Windows App Packages

Project • Windows App creation is available in Basic MSI projects.

Important • The Windows 10 Anniversary Update is required for installing and testing a Windows App package (.appx) with
desktop extensions (Desktop Bridge). To digitally sign the Windows App package, InstallShield must be installed on a Windows
10 machine or a machine with the Windows 10 SDK installed.

The Windows App package (.appx) format is the simple and secure packaging format used to distribute and install apps on
Windows 8.x and 10 and is the only format allowed for Universal Windows Platform (UWP) apps. Benefits of Windows App
packages include:

• High availability, reliability, and durability, resulting in applications that operate continuously without failure for
extended periods of time

• A smooth installation experience through static builds that require minimal configuration and no customizable UI

• The option to sell or provide the application through the Windows Store

• The ability to leverage UWP functionality such as live tiles as well as the ability to utilize UWP APIs

• The only package format with native support on Windows Nano Server

InstallShield now supports creating the Windows App package format (.appx) and its desktop and server extensions
through an alternate build output and provides suitability testing to help you identify items unsuitable for the Windows
App package format. Refer to the following subsections for details about new functionality added to InstallShield to
support the creation of Windows App packages.

• Windows App Settings in the Releases View

• Windows App Logo Customization in the Shortcuts View

• MSIX/UWP App Suitability Testing

• New UWP Condition Checks added to Suites

102 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Windows App Settings in the Releases View

When you select a release in the Releases view, a new per-release tab titled Appx/MSIX has been added that includes
settings to create a Windows App package. Here, various core settings can be specified that impact the Windows App
package build process. In particular, the Distribution Method and Include Desktop Extensions or Include Server
Extensions options will affect what warnings or errors are encountered for certain kinds of installer project data.

For complete information on these new settings, see Appx/MSIX Tab for a Release.

Windows App Logo Customization in the Shortcuts View

In addition to the new Windows App settings added to the Releases view, there are new settings to configure the tiles
created in an Windows App package. These settings are located in the new Windows App Package Tile Overrides area of
the Shortcuts view.

For complete information on these new settings, see Shortcut Settings.

MSIX/UWP App Suitability Testing

InstallShield has added the new InstallShield MSIX/UWP App Suitability Suite that scans an .msi package for signs of items
that are unsuitable for the Windows App package format. To access it, on the Build menu, point to Validation, and then
click InstallShield MSIX/UWP App Suitability Suite.

The InstallShield MSIX/UWP App Suitability Suite provides a report in the Releases view that indicates all tests that found
issues and for each issue, an associated column in the report indicates applicability to the known Windows App variants.
For traditional CUBs, these columns are not populated. You can view this report by navigating to the Releases view and
selecting the Validations folder under your release. For complete information, including descriptions of the new ISUWP
validations included, see InstallShield MSIX/UWP App Suitability Suite.

New UWP Condition Checks added to Suites

When you are building a conditional statement for an exit, detection, eligibility, feature, or wizard interface condition in an
Advanced UI or Suite/Advanced UI project, or for an action condition in a Suite/Advanced UI project, you can select from a
number of different types of checks that you want to be evaluated on target systems. The following condition checks have
been added to Suites.

• Windows App Package Eligible—Check target systems for the run time dependencies of the Windows App package to
prevent any attempts to install a Windows App package onto a version of Windows or Windows Server that does not
support it.

Note • This condition is available only for the eligibility condition of a Windows App package. If it is used in any other
package type, it will not function correctly.

• UWP Type Present—Check target systems for the presence of UWP functionality. For example, to create a conditional
statement that checks for the presence of the Desktop Bridge, check for the type
Windows.ApplicationModel.FullTrustProcessLauncher. This can be used to conditionally block installation, or to
choose between installing .msi and Windows App package (.appx).

Note • This always evaluates as false on operating systems before Windows 10. Use of the Type Name subsetting
Windows.ApplicationModel.FullTrustProcessLauncher requires Windows 10 Anniversary Update or newer.

InstallShield 2020 User Guide ISP-2600-UG00 103

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

SQL Support Added to Suites

Project • This information applies to Suite/Advanced UI projects.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

SQL servers are integral to many applications, especially those that benefit from the multiple package support provided by
InstallShield Suite installations. Previously, InstallShield SQL support was limited to Basic MSI, InstallScript, and
InstallScript MSI projects. Now, SQL support has been added to Suite/Advanced UI projects, giving you the ability to:

• Add a New SQLLogin Predefined Wizard Page

• Execute SQL Statements Directly from Suites

To learn more, see the following topics:

• Adding a SQLLogin Predefined Wizard Page in a Suite/Advanced UI Project

• Configuring an Action for an Element in the Wizard Interface

• Predefined Task Pages Panel

Add a New SQLLogin Predefined Wizard Page

InstallShield adds SQL support to Suite/Advanced UI projects by providing a new SQLLogin predefined wizard page that
can be added to your Suite/Advanced UI project. Previously, if you added an .msi package containing SQL support to a
Suite/Advanced UI project, the Advanced UI or Suite/Advanced UI setup launcher automatically suppressed the user
interface of Windows Installer. You were required to manually create a custom SQLLogin wizard page for your Suite/
Advanced UI project installation.

When adding a new predefined page to your project, select the Enter login information for a database server task page
and complete the panels in the wizard as needed. The SQLLogin predefined wizard page is then added to your project. This
SQLLogin wizard page lets end users enter database server login information (database server name, authentication
credentials, database catalog name, etc.) in order to establish a connection to the database server that is targeted by one
or more .msi packages in the suite.

Adding a SQLLogin wizard page to your project allows you to:

• Specify properties that identify the SQL login settings in the Suite project and then select the .msi package that
receives these properties

• Specify the properties that identify the SQL login settings in the .msi package

• Choose the database technology (Microsoft SQL Server, Microsoft Windows Azure, MySQL, or Oracle) and select the
ODBC driver to be targeted

Execute SQL Statements Directly from Suites

Suite/Advanced UI projects now support directly executing SQL statements on SQL database servers from the user
interface, which helps allow SQL database servers to be examined before proceeding with the installation.

104 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The SQL query result can then be accessed in a Suite property. To provide this support, a Run a SQL String option is now
available in the New Action menu of UI events. The SQL statement is executed using properties and database metadata
specified by additional new options available in the New Action menu of UI events: Configure Database Metadata and
Override SQL Login Properties.

Tile Configurations

Project • This information applies to Basic MSI, InstallScript MSI, and InstallScript project types.

Windows 8 introduced a grid of application tiles to the Start screen, replacing the usual list of shortcuts, and also presented
tiles in place of shortcuts. InstallShield supports customizing the appearance of a desktop app’s tile on the Start screen.
The following tile configuration settings are available:

• A toggle between light or dark text when including the app name on medium-sized (150x150) tiles

• Choice of tile background color

• Option to use custom tile images (small: 70x70 and medium:150x150)

• Preference to show or hide the app name on medium-sized tiles

The Tile Configurations node appears in the main Shortcuts view and in each component’s Shortcuts subview. Any
applicable tile configurations are listed.

To learn more, see the following topics:

• Configuring the Appearance of a Desktop App’s Tile on the Start Screen

• Tile Configuration Settings

New InstallShield Prerequisites for Microsoft Visual C++ 2015, .NET Framework 4.6, and
More

Project • InstallShield prerequisites can be added to Advanced UI, Basic MSI, InstallScript, InstallScript MSI, and Suite/
Advanced UI projects.

InstallShield includes the following new InstallShield prerequisites:

• Microsoft .NET Framework 4.6.2 Full

• Microsoft .NET Framework 4.6.1 Full

• Microsoft .NET Framework 4.6.1 Web

• Microsoft ReportViewer 2015

• Microsoft SQL Server 2014 Express System CLR Types (x86)

• Microsoft SQL Server 2016 Express RTM (x64)

• Microsoft SQL Server 2016 Express RTM LocalDB (x64)

• Microsoft Visual C++ 2015 Update 3 Redistributable Package (x86)

• Microsoft Visual C++ 2015 Update 3 Redistributable Package (x64)

InstallShield 2020 User Guide ISP-2600-UG00 105

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Windows Management Framework 4.0 for Windows 7 SP1 and Server 2008 R2 SP1 (x64)

• Windows Management Framework 4.0 for Windows Server 2012 (x64)

• Windows Management Framework 5.0 for Windows 7 SP1 (x86)

• Windows Management Framework 5.0 for Windows 7 SP1 and Server 2008 R2 SP1 (x64)

• Windows Management Framework 5.0 for Windows 8.1 (x86)

• Windows Management Framework 5.0 for Windows 8.1 and Server 2012 R2 (x64)

• Windows Management Framework 5.0 for Windows Server 2012 (x64)

These prerequisites install the appropriate technologies on supported target systems.

Note • The Web prerequisite for the .NET Framework requires an Internet connection. This prerequisite downloads the
required redistributable files if appropriate. The Full prerequisite for the .NET Framework is a stand-alone installation that
does not require an Internet connection.

Predefined System Searches for Adobe Reader, Microsoft Office and the .NET
Framework

Project • Predefined System Searches apply to Basic MSI and InstallScript MSI projects.

InstallShield has new predefined system searches:

• Adobe Reader 11

• Adobe Reader DC

• Microsoft Office 2013

• Microsoft Office 2016

• Microsoft .NET Framework 4.5.1

• Microsoft .NET Framework 4.5.2

• Microsoft .NET Framework 4.6

• Microsoft .NET Framework 4.6.1

• Microsoft .NET Framework 4.6.2

If your installation requires one or both of these, you can use the System Search view or the Installation Requirements page
in the Project Assistant to add these system searches to your project. When end users launch your installation, Windows
Installer checks the target system to see if the requirements are met; if they are not met, the installation displays the error
message that is defined for the system search.

Enhancements
InstallShield 2020 includes the following new enhancements:

• Direct Editor View Enhancements

106 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Suite UI Enhancements

• Kill Process Custom Action Enhanced

• Ability to Set the Default Value Used for Component Attributes

• Ability to Filter Items by Features in Additional Views

• Digital Signature Updates

Direct Editor View Enhancements

Project • The Direct Editor is available in the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• QuickPatch
• Transform

InstallShield now adds several Direct Editor enhancements that provide visual insights into tables, schema information,
and validation errors designed to boost the productivity of setup authors or packagers who use the Direct Editor for
troubleshooting to identify and resolve advanced problems. These enhancements are described in the following sections:

• Directory Table Displays Resolved Target Directory Path

• Column Header Schema Information Tooltips

• Table Record Reference Tracking

• Broken References Indicator

For complete information, see Direct Editor.

Directory Table Displays Resolved Target Directory Path

When showing the Directory table, InstallShield shows a read-only, grayed out column that displays the resolved path of
each row’s directory location. This column is not actually stored in the project file. You can sort by its visible text, but you
cannot insert, update, or delete its values.

Column Header Schema Information Tooltips

InstallShield now provides tooltips added to column headers that display the following schema information to indicate the
column data type allowed:

• nullable—The column can be left empty.

• required—The column must contain a non-empty value.

• char(nn)—Character string with fixed-length nn.

InstallShield 2020 User Guide ISP-2600-UG00 107

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• small integer—Integer numerical (no decimal), containing a value from -32767 to +32767.

• long integer—Integer numerical (no decimal), containing a value from -2147483647 to +2147483647.

• localizable—This column contains a string that can be translated. Columns without this marker are not localized.

• stream—Binary stream, such as the contents of a file.

Tip • The Directory, Binary, and CustomAction Direct Editor tables display several of these column types.

Table Record Reference Tracking

The Direct Editor now includes a Reference Tracking pane that lets you easily visualize relationships between table
records. A Show Reference Tracking button is added to at the top of the Direct Editor that provides a show/hide toggle of
the pane.

Each record may reference one or more other records or be referenced by one or more other records. When a record is
highlighted that refers to other records or is referred from other records, the Reference Tracking pane is populated with a
Reference Tables section showing the tables in which the references reside and an additional section that displays the
actual record references. The record references section includes arrow icons that indicate the direction of the reference,
where:

• A green arrow pointing to the right indicates that the record that is selected in the Direct Editor table references the
record displayed in the Reference Tracking pane.

• A blue arrow pointing to the left indicates that the record selected in the Direct Editor table is referenced by the
record displayed in the Reference Tracking pane.

• Two arrows in both directions (a green arrow pointing right and a blue arrow pointing left) that indicate the record
selected in the Direct Editor table references and is referenced by the record displayed in the Reference Tracking
pane.

Note • When multiple Direct Editor records are selected, only the “focused” record's references are shown. In addition, if
multiple tables appear in the Reference Tables section, this indicates that the record selected in the Direct Editor table
references or is referenced by records in multiple tables. You can click any table in the Reference Tables section to view the
associated records references.

Tip • In the Reference Tracking pane, you can quickly jump between record references by double-clicking within a cell.

Broken References Indicator

There are instances where a Direct Editor table record might reference a foreign key record that no longer exists.
InstallShield now displays the cells of such broken references with a red fill color to call attention to the broken reference.

For example, if the Directory_ column in the in the Component table references a directory name that is not found in the
Directory table, then the Directory_ column is filled in red.

Note • The Direct Editor broken reference indicator is unrelated to the Maintain referential integrity check box on the
Preferences tab of the Options dialog box. While the Maintain referential integrity setting is designed to update the foreign

108 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

keys when you modify a primary key, the purpose of the broken reference indicator is to display broken references to help you
easily identify orphaned records. Therefore, broken references are displayed regardless of the selection of the Maintain
referential integrity setting.

Suite UI Enhancements

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

To better support various use cases, InstallShield has added the following functionality to Advanced UI and Suite/
Advanced UI projects:

• New Close Window and Stop Event UI Actions

• Suite Loading Splash Screen Added

InstallShield 2020 User Guide ISP-2600-UG00 109

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New Close Window and Stop Event UI Actions

InstallShield includes the following new UI actions:

Table 1-2 • New Control Actions

Type of Action Description

Close Window This type of action closes a main wizard page or secondary window, or in some
cases, provides conditional closing of a secondary window.

Close Window accepts parameters corresponding to the following predefined

Return Code IDs: IDOK, IDCANCEL, IDABORT, IDRETRY, IDIGNORE, IDYES, IDNO,
and IDCLOSE.

The behavior of the Close Window action differs slightly on wizard pages and
secondary windows, as noted following:

• For wizard pages, the Close Window action prompts the end user to cancel
if its Return Code parameter is set to IDCANCEL (and then interrupts the
wizard if the end user specifies Yes). For all other Return Code IDs, the
wizard immediately closes.

• For secondary windows, the Close Window action closes the secondary
window and in special cases such as with the ISRMFilesInUse and
ISRMFileInUse secondary windows, the specified Return Code value is
returned.

InstallShield currently provides the following secondary windows that contain

customized behavior that is dependent upon the specified Return Code ID:

• ISDownloadProgress

• ISPromptForSourceMedia

• ISFilesInUse

• ISRMFilesInUse

• ISUpgradeParcel

• ISSQLBrowse

Stop Event This type of action allows you to conditionally stop further actions from being
processed. For example, this action can be used to prevent the default
behavior of a button from occurring.

To learn more, see Configuring an Action for an Element in the Wizard Interface.

Suite Loading Splash Screen Added

During a suite installation where the loading process takes more than half a second, InstallShield will now display a splash
screen to indicate that the program has launched and that a loading process needs to complete before the Install Welcome
dialog appears. For the splash screen, InstallShield utilizes the largest provided version of the setup.exe icon and includes
a progress bar on it.

110 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Kill Process Custom Action Enhanced

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

A new Processes setting has been added to the Kill-Process Custom Action settings that lets you directly enter executable
file names or PIDs of the processes that you want to terminate without having to create a property using the Property
Manager and format its value correctly for the action to work.

To learn more, see Calling a Kill-Process Custom Action.

Tip • The value of the Processes setting may be written to the ISTerminateProcesses property. If you have additional kill-
process custom actions that do not specify a value in the Processes setting, such as those migrated from InstallShield 2015 or
earlier, shared use of the ISTerminateProcesses property may result in undesired behavior.

Ability to Set the Default Value Used for Component Attributes

Support for a new property has been added to the InstallShield table that lets you set the default value used for
component attributes. If a property of MsiComponentAttributes exists in the InstallShield table, its value overrides the
default Attributes column value in the Component table from 8 to whatever is specified.

For example, to make new components 64-bit, add 256 to the MsiComponentAttributes value. You can specify 264 (for 64-
bit shared) or optionally enter 256 (for 64-bit unshared). In doing so, the 64-Bit Component setting and Shared settings
(shown on the in the General area of the Components view) will be updated to Yes or No accordingly.

For more information about the bit values used in calculating the Attributes column of the Component table, refer to the
Component Table page in the MSDN Library.

Note • To set the default value used for component attributes, the MsiComponentAttributes property must be updated
manually in the InstallShield table in the Direct Editor of each project. The Template Summary setting for a product
configuration is ignored for this use case.

Ability to Filter Items by Features in Additional Views

The following views now contain a View Filter that lets you filter the view list by any feature in your project:

• Environment Variables View—You can use the View Filter list at the top of this view to show and hide environmental
variables that are associated to a particular feature in your project. You can also select a feature from the View List in
order to associate only that feature with a subsequent event (e.g., the creation, modification, or removal of an
environmental variable). Lastly, to see all of the environmental variables that are in your project, select the All
Application Data option in the View Filter list. For more information, see Environment Variables View.

• Text File Changes View—You can use the View Filter list at the top of this view to show and hide text file change sets
that are associated to a particular feature in your project. You can select a feature from the View List in order to
associate only that feature with a subsequent event (e.g., the creation, modification, ordering, or removal of change
sets). The resulting modification takes place at run time on the target system when the feature is installed. Lastly, to
see all of the text file change sets that are in your project, select the All Application Data option in the View Filter list.
For more information, see Text File Changes View.

InstallShield 2020 User Guide ISP-2600-UG00 111

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• INI File Changes View—You can use the View Filter list at the top of this view to show and hide initialization (.ini) files
that are associated to a particular feature in your project. You can select a feature from the View List in order to
associate only that feature with a subsequent event (e.g., the creation, importing, modification, or removal of .ini
files). The resulting modification takes place at run time on the target system when the feature is installed. Lastly, to
see all of the .ini files that are in your project, select the All Application Data option in the View Filter list. For more
information, see INI File Changes View.

Digital Signature Updates

Beginning with InstallShield 2015, support was added to enable you to use digital certificates that use the SHA-256 hashing
algorithm for signing your installations and files at build time.

In InstallShield 2016, support for SHA-256 digital certificates has been enhanced for Windows Installer and InstallScript
projects to:

• Give you the ability to specify a digest type using the new Signature Digest drop-down on the Certificate Selection
Dialog Box

• RFC3161 timestamping is now supported and can be specified in settings.xml, noting that:

• DigitalSignature/@Timestamp can be an Authenticode or RFC3161 server for .msi, .exe, and .dll files

• DigitalSignature/@TimestampRFC3161 used for Windows App package files must be an RFC3161 server

• Handle similarly-named certificates in the Certificate Store

Important • Any new signatures created or timestamped after Jan 1, 2016 must be SHA-256-based signatures. Any files
signed with an SHA-1 certificate need to have a timestamp showing a date and time prior to Jan 1, 2016 in order to continue to
be supported. Those files will still be allowed through the 'Mark-of-the-web" system until Jan 14, 2020, when all SHA-1 support
will stop in all current versions of Windows.

What’s New in InstallShield 2015 SP1

InstallShield 2020

New Features
InstallShield includes the following new features.

Support for Windows 10

InstallShield has support for Windows 10.

Support for Microsoft Visual Studio 2015

InstallShield includes support for Visual Studio 2015. You can create InstallShield projects from within this version of Visual
Studio.

Support for Microsoft App-V 5.1

InstallShield and the Microsoft App-V Assistant in InstallShield include support for creating virtual applications that can run
on Microsoft App-V 5.1 clients.

112 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New InstallShield Prerequisite for App-V 5.1

InstallShield includes a new InstallShield prerequisite that can be used when including a Setup.exe for a generated App-V
5.x package. Note that a Setup.exe setup launcher is required if the InstallShield prerequisite needs to be included in the
release:

• Microsoft App-V 5.1 Desktop Client

The redistributable file for this InstallShield prerequisite is not available for download from within InstallShield, since you
must obtain it from Microsoft. Once you obtain the redistributable from Microsoft, place it in the location that is displayed
when you are editing the prerequisite in the InstallShield Prerequisite Editor. For more information on the prerequisites
necessary, see https://technet.microsoft.com/en-us/library/mt346482.aspx.

Windows 10 Added to Operating System Options in App-V Assistant for App-V 5.x Versions

App-V 5.1 introduced support for Windows 10 32-bit and 64-bit operating systems. Accordingly, on the Package
Information page of the Microsoft App-V Assistant, the list of available operating systems that are displayed when App-V 5.x
is selected has been updated to include:

• Windows 10 32-bit

• Windows 10 64-bit

New InstallShield Prerequisites for Microsoft Visual C++ 2015 and .NET Framework 4.6
InstallShield includes new InstallShield prerequisites that you can add to Advanced UI, Basic MSI, InstallScript, InstallScript
MSI, and Suite/Advanced UI projects:

• Microsoft Visual C++ 2015 Redistributable Package (x86)

• Microsoft Visual C++ 2015 Redistributable Package (x64)

• Microsoft .NET Framework 4.6 Full

• Microsoft .NET Framework 4.6 Web

These prerequisites install the appropriate technologies on supported target systems.

New Constant for the DialogSetInfo Function

A new constant is available for the nInfoType parameter of the InstallScript function DialogSetInfo:

DLG_INFO_ALTIMAGE_HIDPI—This constant specifies a high DPI image to be displayed in the dialog. High DPI image types
supported include BMP, GIF, JPEG, PNG, and TIFF. If transparency is required, image types that support transparency (such
as PNG) should be used and szInfoString should specify the name of the image to be displayed (optionally including the
path) in the dialog. This parameter applies to all dialogs that display the standard installation image on the left side of the
dialog.

When DLG_INFO_ALTIMAGE_HIDPI is passed in nInfoType, the following parameter values are expected:

• szInfoString—The name of an image file to display, optionally including the path. If no path to the file is specific, the
file is assumed to be in SUPPORTDIR. If this file does not exist, DialogSetInfo returns ISERR_FILE_NOT_FOUND.

• nParameter—The DPI scaling percentage. For example, pass 200 for a 200% image scale, 150 for a 150% scale, etc. The
minimum supported scaling value is 25. If 0 is passed for this value, no image is displayed. If
DLG_INFO_ALTIMAGE_REVERT_IMAGE is passed, the previous image used is displayed.

This functionality is available in InstallScript events in the following project types: InstallScript and InstallScript MSI.

InstallShield 2020 User Guide ISP-2600-UG00 113

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more information, see DialogSetInfo .

Option Added to Disable Architecture Validation

The None option has been added to the Architecture Validation options in the Releases explorer to specify the bypassing of
build-time architecture validation.

For more information, see Selecting the Appropriate Type of Architecture Validation for Builds.

What’s New in InstallShield 2015

InstallShield 2020

New Features
InstallShield includes the following new features.

Support for Windows 10–Based Systems

InstallShield has support for Windows 10.

Targeting Windows 10

On systems with Windows 10, the Windows Installer properties VersionNT and VersionNT64 indicate 603, which was
originally introduced as the version number of Windows 8.1. Therefore, it is not possible to create conditions in an .msi
package that specifically target Windows 10.

Since Windows Installer 5.0 and Windows 7, DLL custom actions in .msi packages are shimmed to block obtaining the
operating system version; the APIs GetVersion, GetVersionEx, and RtlGetVersion return a Windows version of 6.0.6000,
which was originally the version number of Windows Vista. Therefore, it is also not possible to obtain the actual version
number of Windows from a DLL custom action or from an InstallScript custom action (which is implemented as a DLL).

Because of the aforementioned behavior in Windows Installer, it is not easily possible to detect what version of Windows
on which an .msi package is running. In areas where you can specify target system OS requirements, such as the
Installation Requirements page in the Project Assistant of Basic MSI and InstallScript MSI projects, the Windows 8.1 option
has been renamed as Windows 8.1 or Windows 10 to reflect the new run-time behavior.

InstallScript, Advanced UI, and Suite/Advanced UI projects provide the ability to properly detect which version of Windows
(including Windows 10) is present on a target system. Thus, if your installation needs to target or exclude Windows 10, you
may want to use these types of projects to create conditions under which .msi packages should be run based on the actual
target system platform.

The InstallShield prerequisites that should be installable on Windows 10 have been updated so that they are installed on
those systems if needed. Previously, the prerequisites may not have run by default on those systems.

InstallScript Language Support for Windows 10

The following structure members and predefined constants were added to the InstallScript language:

• SYSINFO.WINNT.bWin10—This is a new SYSINFO structure member. If the operating system is Windows 10, this value
is TRUE. (This is applicable to InstallScript event-driven code; it is not applicable to custom actions.)

• ISOSL_WIN10—This is a new predefined constant that is available for use with the FeatureFilterOS function and the
SYSINFO structure variable. It indicates that the target system is running Windows 10.

114 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more information, see FeatureFilterOS function and the SYSINFO structure variable.

Support for Microsoft Visual Studio 2015

InstallShield includes support for Visual Studio 2015 Preview. You can create InstallShield projects from within this version
of Visual Studio.

Digital Signing Improvements

InstallShield includes several improvements for digitally signing your installations and files at build time.

Support for SHA-256 Digital Certificates

InstallShield now enables you to use digital certificates that use the SHA-256 hashing algorithm for signing your
installations and files at build time.

SHA-256 is favored over SHA-1, which is being deprecated because of the potential for security vulnerabilities. Microsoft
announced that Windows will stop trusting items that were signed and timestamped with SHA-1 certificates after January
1, 2016. In addition, certification authorities—the organizations that issue certificates—are phasing out the creation of
SHA-1 certificates. Thus, it is recommended that you replace any SHA-1 certificates in your InstallShield projects with SHA-
256 certificates. For the latest information and more specific details, check with your certification authority.

In InstallShield, to replace a SHA-1 certificate with a SHA-256 certificate for signing your releases, use the Signing tab in the
Releases view to replace the reference to the current certificate with one for a SHA-256 certificate.

If your project is configured to sign with a SHA-256 certificate, InstallShield uses a SHA-256 hash in the signature of the files
that it signs at build time. If your project is still configured to sign with a SHA-1 certificate, InstallShield uses a SHA-1 hash;
in addition, use of a SHA-1 certificate now triggers build warning -7346 to alert you about the SHA-1 usage.

In earlier versions of InstallShield, InstallShield used a SHA-1 hash in the signature of files when signing with either SHA-1
and SHA-256 certificates.

For details, see Digital Signing and Security.

Ability to Use a Certificate Store for Referencing Certificates

When you are specifying the digital signature information that you want to use for signing your files and installations,
InstallShield now lets you reference a certificate store that contains the certificate that you want to use. This support is
available as an alternative to specifying a .pfx certificate file on your machine.

To specify whether you want to use a certificate store or a .pfx certificate, use the Digital Certificate File setting on the
Signing tab in the Releases view. When you click the ellipsis button (...) in this setting, a new Certificate Selection dialog box
opens, enabling you to specify certificate information such as the store name (Personal, Trusted Root Certification
Authorities, Enterprise Trust, Intermediate Certification Authorities), the store location (user or machine), and the subject
that identifies the specific certificate that you want to use. As an alternative, you can specify on this dialog box the path and
file name of a .pfx file that you want to use.

If you configure your project to use a certificate that was imported with password protection into a store, Windows
prompts for the password at build time when InstallShield is attempting to sign your project’s files. The strong key
protection that Windows uses does not permit InstallShield to provide the password to the cryptographic provider.

Certificate store support is also available for signing patches and QuickPatch packages:

• To specify certificate store or .pfx certificate information for a patch, use the Digital Signing tab for a patch
configuration in the Patch Design view.

InstallShield 2020 User Guide ISP-2600-UG00 115

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• To specify certificate store or .pfx certificate information for a QuickPatch package, use the Build Settings area of the
General Information view in the QuickPatch project. This area includes a Digital Signature tab that includes the new
support.

In addition, the command-line tool iSign.exe, which is available for signing already-built InstallScript releases, has been
updated to include support for using certificates in certificate stores.

To learn more, see:

• Digital Signing and Security

• Certificate Selection Dialog Box

• Signing Tab for a Release (for a release in the Releases view)

• Digital Signature Tab (for a patch configuration in the Patch Design view)

• Digital Signature Tab (in a QuickPatch project)

• iSign.exe

Note that InstallShield no longer has support for signing with .spc and .pvk files. To learn how to convert those files to a .pfx
file, see Digital Signing and Security.

Ability to Specify a Program Name for the UAC Dialog Box

The Signing tab in the Releases view includes a new Signature Description setting. Use this setting to specify the text that
you want to be displayed to the right of the “Program Name:” label on the UAC dialog box for the Setup.exe files, the .msi
file, and other installation files that InstallShield signs at build time. The UAC dialog box opens when an end user launches
the signed file and elevated privileges are required.

If you leave the Signature Description setting blank, InstallShield uses the name of the file without its extension as the text
on the UAC dialog box.

For more information, see Signing Tab for a Release.

Ability to Digitally Sign Media Header Files with a .pfx File or a Certificate in a Certificate Store

InstallShield now has support for using .pfx files to sign media header files (.hdr files), which are used for the One-Click
Install type of installation for InstallScript projects. As an alternative, you can use a certificate in a certificate store to sign
media header files.

Previously, it was necessary to sign with .spc and .pvk files instead of .pfx files.

Automation Interface Support for Specifying Digital Certificate Information

The automation interface has support for specifying the .pfx file and the certificate store information. In addition, it also
has support for specifying the signature description.

In Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, and Merge Module projects, the ISWiReleases object
includes two new read-write string properties.

• DigitalCertificateInfo—This property gets or sets either the path to the .pfx file on your machine, or to a string that
indicates certificate store details.

• SignatureDescription—This property gets or sets the signature description.

To learn more, see ISWiRelease Object.

116 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

In Advanced UI and Suite/Advanced UI projects, the ISWiSuiteReleases object includes these same new properties. For
more details, see ISWiSuiteRelease Object (Advanced UI and Suite/Advanced UI).

Ability to View Both the 32- and 64-Bit Areas of the Source Machine’s Registry on 64-Bit Development
Systems
If you are using InstallShield on a 64-bit development system, the Registry view in InstallShield now displays both the 32-
bit and 64-bit areas of your machine’s registry:

• HKEY_LOCAL_MACHINE\Software

• HKEY_LOCAL_MACHINE\Software\Wow6432Node

This support makes it easier to develop installations on 64-bit machines, since it enables you to drag and drop entries from
those source areas to the appropriate areas in the destination pane of this view.

Previously, if you were using InstallShield on a 64-bit development system, the source panes in the Registry view in
InstallShield did not show any 64-bit data from the HKLM\Software part of the registry; in addition, the source panes
displayed 32-data from the machine’s HKLM\Software\Wow6432Node area in the HKLM\Software area.

Note that if you want your installation to install registry data to a 64-bit area of the registry on 64-bit target systems without
having it redirected to a 32-bit area, you must place the registry data in a component that is marked as 64 bit. Simply
dragging 64-bit data from the source panes in the Registry view to a location in one of the destination panes of the view
does not mark the component as 64 bit.

This feature is available in the following project types: Basic MSI, DIM, InstallScript, InstallScript MSI, InstallScript Object,
Merge Module, MSI Database, MSM Database, and Transform.

For more information, see:

• Developing and Building Installations on 32-Bit vs. 64-Bit Systems

• Dragging and Dropping Registry Entries to Create Registry Keys

• Registry View

Support for Embedding Formatted Expressions in Advanced UI and Suite/Advanced UI Projects for Run-
Time Resolution
In various areas of Advanced UI and Suite/Advanced UI projects, you can now embed object expressions to query target
systems for information about a file, a registry entry, the operating system, or other details. This enables you to
dynamically configure many of the Advanced UI or Suite/Advanced UI settings at run time based on target system–specific
conditions. Object expressions use this convention:

[@Object(Parameters, ...).Property(Parameters, ...)]

Each object expression contains a reference to an object, which is a collection of object-specific properties. Objects and
properties may contain parameters.

For example, the following Platform object expression obtains the architecture (x86, x64, IA64, ARM, or Unknown) of the
machine on which the Advanced UI or Suite/Advanced UI installation is running:

[@Platform.Architecture]

The following Registry object expression obtains the value data of the RegisteredOwner value for the HKLM\Software\My
Company Name\My Product Name registry key:

[@Registry(HKLM\Software\[COMPANY]\[PRODUCT], true).KeyValue(RegisteredOwner)]

InstallShield 2020 User Guide ISP-2600-UG00 117

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

You can embed object expressions within other formatted expressions, such as within property expressions or other object
expressions. In the following expression, a Registry object expression is embedded as part of the parameter to a File object
expression.

[@File([@Registry(HKLM\Software\MyProduct).KeyValue(MyProductPath)]\MyProduct.exe).Version]

If the MyProduct.exe file is in the location that is specified for the MyProductPath value data, the File object expression
returns the version of the file. If the file is not found in that location, or if the registry value does not exist, the File object
expression returns an empty string.

InstallShield also now enables you to pass literal square brackets as part of strings through the command line to packages
in an Advanced UI or Suite/Advanced UI installation. For example, a command line such as [\[]Text[\]] resolves as
[Text] at run time and is passed to the package with the square brackets. Previously, a string enclosed within square
brackets was treated as a property that the installation attempted to resolve at run time. The only work around was to use
a formatted property expression (such as [PropertyForSquareBracketString]) that would be resolved at run time to a
property value that included the square brackets.

To learn more, see:

• Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time

• Writing Object Expressions in Advanced UI and Suite/Advanced UI Projects to Search Target Systems

• Object Reference for Expressions in Advanced UI and Suite/Advanced UI Projects

• Feature Object

• File Object

• Parcel Object

• Platform Object

• Registry Object

Ability to Share Common Packages Among Different Advanced UI and Suite/Advanced UI Installations
When you are configuring a package for an Advanced UI or Suite/Advanced UI installation, you can now mark it as shared.
The shared package functionality helps to ensure that if two or more Advanced UI or Suite/Advanced UI installations are
sharing a package, the package remains on the target system until all of the Advanced UI and Suite/Advanced UI products
are removed.

To mark a package that is selected in the Packages view of an Advanced UI or Suite/Advanced UI project as shared, select
Yes for the new Shared setting. In addition, ensure that the package GUID is the same across all Advanced UI and Suite/
Advanced UI projects that are sharing the package; the Package GUID setting in the Packages view is where you can view
and modify the GUID of a package.

Before this built-in shared support was available, unexpected results may have occurred in various scenarios. For example,
in some scenarios, if two different Advanced UI or Suite/Advanced UI installations installed a shared package on a target
system and then only one was uninstalled, the shared package was removed. The remaining Advanced UI or Suite/
Advanced UI product may have been unusable because of the missing shared package. In other scenarios, the shared
package was erroneously left behind on a target system, even though no Advanced UI or Suite/Advanced UI product
remained.

This feature is available for the following types of packages in Advanced UI and Suite/Advanced UI projects: .msi, .msp,
.exe, .appx, InstallScript, Basic MSI project, and InstallScript project.

For more details, see:

118 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Sharing Common Packages Among Different Advanced UI and Suite/Advanced UI Installations

• Packages View

Ability to Override the Product Name, Product Version, and Suite GUID for a Release in an Advanced UI or
Suite/Advanced UI Project
InstallShield now lets you override the product name, product version, and Suite GUID values that are specified in the
General Information view of your Advanced UI or Suite/Advanced UI project with a new value for a selected release. To
override the General Information view values, use the new settings that are available on the Build tab for a release in the
Releases view: Product Name, Product Version, and Suite GUID.

For details, see Build Tab for a Release.

Ability to Override the Values of Path Variables for a Release in an Advanced UI or Suite/Advanced UI
Project
InstallShield now lets you override the values of your project’s custom path variables (standard path variables,
environment path variables, and registry path variables) for each release in your project. This functionality enables you to
essentially replace certain files and folders in your project with others at build time, depending on the particular release
that you are building.

For example, you might want to use this functionality to swap out UI elements such as images and EULAs for different
releases in your project; this would enable you to easily generate installations for different editions or branded versions of
your product.

To override one or more path variables in your project, use the Path Variables Overrides setting, which is on the Build tab
for a release in the Releases view.

To learn more, see the following:

• Overriding the Value of a Custom Path Variable for a Release

• Path Variable Overrides setting

Automation Interface Support for Advanced UI and Suite/Advanced UI Projects

InstallShield now enables you to automate most development and build processes of Advanced UI and Suite/Advanced UI
projects (.issuite files) through the automation interface without having to directly open the InstallShield interface and
make changes in different views. The automation interface provides programmatic access to various areas of Advanced UI
and Suite/Advanced UI projects; it exposes a COM interface that you can call from many languages to create, edit, and build
Advanced UI or Suite/Advanced UI projects.

The top-level automation object for Advanced UI and Suite/Advanced UI projects is the ISWiProject object. Sample
VBScript code that opens, modifies, saves, and closes a project begins and ends like this:

Dim pProj As ISWiProject

Set pProj = CreateObject("ISWiAutoSuite22.ISWiProject")
pProj.OpenProject "C:\InstallShield 2015 Projects\Project1.issuite"
' perform changes here
pProj.SaveProject
pProj.CloseProject

By calling methods, getting and setting properties, and accessing collections, you can also add features and packages to
your project, configure conditions, and more. For more information, see the following sections of the documentation:

• Automation Objects for Advanced UI and Suite/Advanced UI Projects

InstallShield 2020 User Guide ISP-2600-UG00 119

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Automation Collections for Advanced UI and Suite/Advanced UI Projects

Note that the ProgID for the Advanced UI and Suite/Advanced UI automation interface is ISWiAutoSuiteAutomation
Interface Version.ISWiProject; the ProgID for other project types is simply ISWiAutoAutomation Interface
Version.ISWiProject.

New InstallShield Prerequisites for Microsoft Visual C++ 2015, .NET Framework 4.6, and More
InstallShield includes new InstallShield prerequisites that you can add to your projects:

• Microsoft Visual C++ 2015 Redistributable Package (x64)

• Microsoft Visual C++ 2015 Redistributable Package (x86)

• Microsoft Visual C++ 2013 Redistributable Package (x86)

• Microsoft Visual C++ 2013 Redistributable Package (x64)

• Microsoft .NET Framework 4.6 Full

• Microsoft .NET Framework 4.6 Web

• Microsoft .NET Framework 4.5.2 Full

• Microsoft .NET Framework 4.5.2 Web

• Microsoft SQL Server 2012 Express SP2 (x86)

• Microsoft SQL Server 2012 Express SP2 (x86 & x64Wow)

• Microsoft SQL Server 2012 Express SP2 (x64)

• Microsoft SQL Server 2012 Express SP2 LocalDB (x86)

• Microsoft SQL Server 2012 Express SP2 LocalDB (x64)

• Microsoft SQL Server 2012 Express SP2 Management Objects (x86)

• Microsoft SQL Server 2012 Express SP2 Management Objects (x64)

• Microsoft SQL Server 2012 Express SP2 System CLR Types (x86)

• Microsoft SQL Server 2012 Express SP2 System CLR Types (x64)

• Internet Explorer 11.0 for Windows 7 (x86)

• Internet Explorer 11.0 for Windows 7 and Windows Server 2008 R2 (x64)

• Microsoft ReportViewer 2012

These prerequisites install the appropriate technologies on supported target systems.

The Microsoft SQL Server 2012 Express SP2 prerequisites replace the Microsoft SQL Server 2012 Express SP1 prerequisites.

New Predefined System Searches for Internet Explorer 10 and 11

InstallShield has new predefined system searches that check target systems for Internet Explorer 10 or Internet Explorer
11. If your installation or product requires either of those versions, you can use the System Search view or the Installation
Requirements page in the Project Assistant to add one of these system searches to your project. When end users launch
your installation, Windows Installer checks the target system to see if the requirements are met; if they are not met, the
installation displays the error message that is defined for the system search.

120 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

This change is available in Basic MSI and InstallScript MSI projects.

Support for Creating Virtual Applications for Microsoft App-V 5.0 SP3; Additional App-V Package
Improvements
InstallShield and the Microsoft App-V Assistant in InstallShield include support for creating virtual applications that can run
on Microsoft App-V 5.0 SP3 clients. In addition, the Microsoft App-V Assistant includes new settings and capabilities—some
of which apply to App-V 5.0 SP3, and some of which apply to earlier versions of App-V.

New InstallShield Prerequisites for App-V 5.0 SP3

InstallShield includes new InstallShield prerequisites that you can add to Advanced UI, Basic MSI, InstallScript, InstallScript
MSI, and Suite/Advanced UI projects:

• Microsoft App-V 5.0 SP3 Desktop Client (x86)

• Microsoft App-V 5.0 SP3 Desktop Client (x64)

The redistributable files for these InstallShield prerequisites are not available for download from within InstallShield, since
you must obtain them from Microsoft. Once you obtain one of the redistributables from Microsoft, place it in the location
that is displayed when you are editing the prerequisite in the InstallShield Prerequisite Editor.

Ability to Map Files into the Virtual File System Instead of a Primary Application Directory

The Microsoft App-V Assistant now enables you to configure your App-V package to map files into the virtual file system
(VFS). This support is available for App-V 4.x and 5.x packages.

To specify whether you want to map the files to the VFS or use a primary application directory, use the Files page in the
Microsoft App-V Assistant. The More Options area on this page has a new File Mapping link. When you click this new link, a
new File Mapping dialog box opens, enabling you to select the appropriate option.

The File Mapping link and dialog box replace the Primary Application Directory link and dialog box, which previously
enabled you to specify primary application directory.

To learn more, see File Mapping Dialog Box.

Ability to Create App-V 5.x Packages that Have Full Write Permissions to the Virtual File System

The Microsoft App-V Assistant now enables you to specify whether you want an App-V 5.x package that you are creating to
have full write permissions to the virtual file system (VFS). To specify whether you want to use this support, use the new
Allow full write permission to the VFS check box. This check box is on the File Mapping dialog box, which is available from
the Files page in the Microsoft App-V Assistant when you click the File Mapping link in the More Options area.

To learn more, see File Mapping Dialog Box.

Ability to Configure Advanced COM Isolation Settings for App-V 5.x

The Microsoft App-V Assistant now enables you to configure advanced settings for COM isolation. This support is available
for App-V 5.x packages.

To configure the new settings, use the Package Information page in the Microsoft App-V Assistant. The More Options area
on this page has a new Isolation Settings link. When you click this new link, a new Isolation Settings dialog box opens. This
dialog box enables you to specify whether you want to isolate the COM objects from the local system, or allow them to
interact with the local system. This dialog box also lets you indicate whether you want to isolate named objects from the
local system, or allow them to interact with the local system.

To learn more, see Isolation Options Dialog Box (for a Package).

InstallShield 2020 User Guide ISP-2600-UG00 121

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The Microsoft App-V Assistant is available in the Premier Edition of InstallShield.

Enhancements

Performance Improvement for the Files and Folders View

InstallShield has been enhanced to more quickly load the Files and Folders view of large projects.

Ability to Filter Items in the Files and Folders View by Feature

The Files and Folders view now contains a View Filter that lists each of the features in your project, as well as an All
Application Data option. You can use this filter to show and hide files and folders in the destination panes of this view:

• To see in this view only files and folders that belong to a particular feature, select that feature in the View Filter list.

• To add a file or folder to a specific feature, select that feature in the View Filter list. Then add the file or folder to the
appropriate location in the Destination computer’s folders pane.

• To see all of the files and folders that are in your project, select the All Application Data option in the View Filter list.

The new View Filter replaces the previous Add new components to the feature filter, which did not have support for
showing and hiding files and folders in the view according to the selected feature.

To learn more, see Files and Folders View.

Ability to Access the Installer Session from PowerShell Scripts in Basic MSI and InstallScript MSI
Installations
The PowerShell custom action support has been enhanced. It now includes support for several cmdlets that let you
interact with the running Basic MSI or InstallScript MSI installation at run time. The cmdlets enable you to get and set
Windows Installer properties, expand the value of formatted expressions, and write information to the log file.

With this revised implementation, you can use the Windows Installer property IS_CLR_VERSION to identify a semicolon-
delimited list of .NET Framework versions that the custom action should attempt to load to run your PowerShell script.

To learn more, see Calling a PowerShell Custom Action.

Ability to Configure Major Upgrades in Transform Projects and MSI Databases

Transform projects and MSI Database projects now include the Upgrades view, which you can use to create major
upgrades. To add an upgrade entry in a Transform project or in direct-edit mode for an MSI Database project, open the
Upgrades view. Right-click the Upgrade Windows Installer Setup node and then click Add Major Upgrade Item. Then
configure its settings in the right as needed.

To learn more, see:

• Upgrades View

• Adding a Major Upgrade Item

• Major Upgrades

• Upgrade Considerations

• Preventing the Current Installation from Overwriting a Future Major Version of the Same Product

122 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Improvements to the ISHiddenProperties Property for Preventing Passwords from Being Written in
Advanced UI and Suite/Advanced UI Log Files
The ISHiddenProperties property stores a semicolon-delimited list of case-sensitive property names whose values you do
not want to be written to the debug log files. This property enables you to prevent properties that contain passwords and
other sensitive information from being logged. The ISHiddenProperties property has been improved. You can now use
this property for prevention of logging for values in the following scenarios:

• The end user sets the value of the property through command line when launching the Advanced UI or Suite/
Advanced UI Setup.exe file.

• The property is configured through a command line that the Advanced UI or Suite/Advanced UI installation passes to a
package. This is configurable in the Packages view, on the Common tab, in the Operation area.

Previously, ISHiddenProperties prevented logging only values that would be logged by changing the property value.

For more information, see Preventing a Property Value from Being Written in Advanced UI and Suite/Advanced UI Debug
Log Files.

Improvements to the Interpretation of Ampersands in the Wizard Interface of Advanced UI and Suite/
Advanced UI Installations
The interpretation of ampersands in certain areas of the wizard interface of Advanced UI and Suite/Advanced UI projects
has been modified.

If you use an ampersand (&) in any of the following areas of the wizard interface of your installation, the installation now
displays the ampersand as a literal character instead of interpreting it as a prefix character for a keyboard shortcut. The
change also applies if any of these strings include a property that resolves to a value that contains an ampersand.

• The string in the header area of a wizard page or secondary window—This is configured in the Title setting for a wizard
page or window in the Wizard Interface view.

• The caption bar of wizard pages—This is configured in the Wizard Caption setting for the Wizard Pages node in the
Wizard Interface view.

• The supplemental explanation area of a command link control—This is configured in the Note setting for a wizard
page or window.

• The alternate text for an image control—This is configured in the Alt Text setting of an image control on a wizard page
or window.

For most label controls, True is now selected by default for the SS_NOPREFIX subsetting under the Style setting; previously
False was selected by default. A True value for this subsetting ensures that any ampersands that are included in the string
entries for such controls are not inadvertently interpreted as keyboard shortcuts, and that ampersands in the control’s
strings are displayed as ampersands in the wizard interface. This applies to the built-in default wizard pages and windows,
as well as the predefined wizard pages. The only exceptions to this SS_NOPREFIX subsetting change are label controls that
may contain keyboard shortcuts. For example, the default predefined Web Deploy wizard page has several text boxes with
corresponding labels that may contain keyboard shortcuts. Therefore, False continues to be default value for the
SS_NOPREFIX subsetting of such controls.

The InstallShield Help Library has a new Designating Keyboard Shortcuts and Using Ampersands (&) in the Wizard Interface
help topic that explains how to configure your project to support the use of ampersands and keyboard shortcuts in your
wizard interface.

Note that when you upgrade an InstallShield 2014 or earlier Advanced UI or Suite/Advanced UI project to InstallShield
2020, many of the aforementioned changes for ampersand interpretation are made automatically made; however, some
changes are not made. To learn more, see Upgrading Projects from InstallShield 2014 or Earlier.

InstallShield 2020 User Guide ISP-2600-UG00 123

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Enhanced File-Related Types of Condition Checks Can Search Multiple Target System Paths in Advanced
UI and Suite/Advanced UI Installations
When you are building a conditional statement for an exit, detection, eligibility, feature, or wizard interface condition in an
Advanced UI or Suite/Advanced UI project, or for an action condition in a Suite/Advanced UI project, you can use the
following file-related types of condition checks:

• File Exists—This type checks target systems for the presence of a particular file.

• File Comparison—This type checks target systems for specific information—date, version number, or component—
for a particular file.

Both of these condition checks have been expanded to enable you to define conditions that check for the file in multiple
paths on target systems. Previously, each condition could check only one specific location on target systems.

To enable this support, the existing Path setting for these condition checks has been expanded to let you enter only the
name of the file (that is, optionally now without the path); if you leave out the path, you can use the new Search Path
setting to specify a semicolon-delimited list of paths that you want the installation to check at run time for the specified
file. You can include in this setting one or more formatted expressions that contain property names, environment variable
references, and other special strings; at run time, the installation expands the values of these expressions.

For example, to search for the specified file in all directories that are defined for the PATH environment variable on a target
system, as well as the path that is defined in the registry, enter the following value in the Search Path setting:

[%PATH];[@Registry(HKLM\SOFTWARE\MyPath).KeyValue(MyValue)]

For more details, see:

• File Exists Condition Settings

• File Comparison Condition Settings

Improvements for Importing InstallShield Prerequisites with Certain Types of File-Related Condition
Checks in Advanced UI and Suite/Advanced UI Projects
Advanced UI and Suite/Advanced UI projects now have support for the following conditions that InstallShield prerequisites
support:

• If you use the condition A file does or does not exist or A file with a certain date exists in a prerequisite and if you
reference a registry key within square brackets for part of the path to the file, a Basic MSI, InstallScript, or InstallScript
MSI installation resolves the registry key with the registry value. Now that Advanced UI and Suite/Advanced UI
installations have expanded formatted-expression support for conditions, these types of prerequisite conditions are
properly imported into Advanced UI and Suite/Advanced UI projects and resolved at run time. Previously, the registry
key within square brackets was not resolved at run time; therefore, these types of conditions always evaluated as
false.

• If you use the condition A file does or does not exist or A file with a certain date exists in a prerequisite and if you
omit the path to the file, a Basic MSI, InstallScript, or InstallScript MSI installation searches for the specified file in all
directories that are defined for the PATH environment variable on the target system. Now that Advanced UI and Suite/
Advanced UI installations have expanded formatted-expression support for conditions, these types of prerequisite
conditions are properly imported into Advanced UI and Suite/Advanced UI projects and resolved at run time.
Previously, the path to the file could not be resolved; therefore, this type of condition always evaluated as false.

The InstallShield prerequisites for Oracle Instant Client are examples of prerequisites that use the file-related conditions.
Now if you import these types of InstallShield prerequisites into Advanced UI or Suite/Advanced UI projects, those file-
related conditions are configured properly in the Detection Condition setting of the Packages view.

124 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more information, see Including InstallShield Prerequisites (.prq) in an Advanced UI or Suite/Advanced UI Project.

Ability to Upgrade a Project Through the Automation Interface

The automation interface includes support for upgrading a project from an earlier version of InstallShield to the current
version. To upgrade a project through the automation interface, use the ForceUpgrade method of the ISWiProject object.

This enhancement is available for the following project types: Advanced UI, Basic MSI, DIM, InstallScript, InstallScript MSI,
InstallScript Object, Merge Module, and Suite/Advanced UI.

For more information, see:

• ISWiProject Object

• ISWiProject Object (Advanced UI and Suite/Advanced UI)

Ability to Select the Virtual Machine Configuration for a Release Through the Automation Interface
The automation interface has support for selecting the virtual machine configuration for a given release; this enables you
to specify which configuration you want to use for distributing the selected release to a virtual machine (VM) at build time.

In Basic MSI, InstallScript, and InstallScript MSI projects, the ISWiReleases object includes several new read-write
properties. In Suite/Advanced UI projects, the ISWiSuiteRelease object includes the same new read-write properties.

• VMConfig—This property gets or sets the name of the group of VM configuration settings that you want to use when
distributing a release to a VM.

• VMSnapShot—This property optionally gets or sets the name of the snapshot that you want to use for distributing the
release.

If no snapshot is specified for the VM configuration, InstallShield does not revert to a specific snapshot. InstallShield
powers on the VM without reverting it to a specific snapshot, and copies your installation to the VM.

• VMMachineUserName—This property gets or sets the user name for the VM configuration.

• VMMachinePassword—This property gets or sets the password for the VM configuration.

• VMStageMachineCopyPath—This property gets or sets the location on the VM where the release is to be distributed.
The last subfolder in the path can be a path that InstallShield creates on the VM; the other folders in the path must
already exist.

• VMStagePostBuild—This Boolean property indicates whether you want InstallShield to automatically distribute the
selected release each time that it is successfully built.

This enhancement is available in the Premier edition of InstallShield.

To learn more, see:

• ISWiRelease Object

• ISWiSuiteRelease Object (Advanced UI and Suite/Advanced UI)

Enhancement to ISICE11
InstallShield internal consistency evaluator 11 (ISICE11) has been improved. If an executable file in your project includes a
valid manifest that includes an asm.v2 entry for the trustInfo element, ISICE11 no longer occurs during validation.
Previously, the asm.v3 entry was checked, but not the asm.v2 entry.

To learn more, see ISICE11.

InstallShield 2020 User Guide ISP-2600-UG00 125

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Enhanced Dialogs View in Basic MSI, DIM, and Merge Module Projects: All Behavior Settings for Each
Control Are Shown in a Single Grid
The Dialogs view has been enhanced. All of the settings that are available for configuring the behavior (events,
subscriptions, and conditions) of each user interface control on a run-time dialog are now displayed in a single grid.
Previously, the settings were available through separate Events, Subscriptions, and Conditions tabs that were displayed in
the bottom-right corner of the view.

To add an event, a subscription, or a condition to a control, in the Dialogs view, select the Behavior node under the dialog
that contains the control. The controls that are used on the dialog are displayed in the center pane; select the control that
you want to configure. Then use the Events, Subscriptions, and Conditions settings that are displayed in the right pane to
configure the appropriate behavior.

This enhancement applies to the following project types: Basic MSI, DIM, Merge Module.

To learn more, see:

• Editing Dialog Behavior in Basic MSI Projects

• Using Control Events in Basic MSI Dialogs

• Using Subscriptions in Basic MSI Dialogs

Enhanced Folder Views Show Total Count of Each Item in the Current Project
The folder views in InstallShield now enable you to see a quick summary of the contents of your project.

For example, the Application Data view—which is the folder view that contains the Files and Folders view and the
Redistributables view in some types of projects—indicates the number of files, the number of merge modules, and the
number of InstallShield prerequisites that are in the current project. The System Configuration view—which is the folder
view that contains views such as Shortcuts and Registry— shows summary data such as the number of shortcuts, the
number of registry keys, and the number of registry values.

New Machine-Wide Setting for Removing Unused Components Automatically

The Files View tab on the Options dialog box in InstallShield has a new Clean up unused components check box. This
check box lets you specify whether you want InstallShield to remove unused components from your project automatically.

When this check box is selected, you delete all of the files in a component, and that component is not required elsewhere,
that component is deleted automatically.

This new check box is a machine-wide setting. This check box is cleared by default; therefore, unused components are not
removed automatically by default.

For more information, see Files View Tab.

Enhanced Behavior for Deleting Custom Actions that Use a File in the Binary Table
When you are deleting from your project a custom action that uses a file in the Binary table, InstallShield now determines
whether the file in the Binary table is referenced by any other custom actions in the project. If it is not referenced by any
other custom actions, InstallShield prompts you to specify whether you want to delete the entry from the Binary table
while also deleting the custom action:

• The No button, which is the default selection, enables you to delete only the custom action.

• The Yes button enables you to delete both the custom action and the Binary table entry.

• The Cancel button enables you to avoid deleting the custom action and the Binary table entry.

126 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

If one or more other custom actions in the project reference the file in the Binary table, InstallShield deletes only the
custom action that you chose to delete; it does not delete the Binary table entry. In this scenario, InstallShield does not
display any prompt when you are deleting the custom action.

Previously, when you were deleting a custom action in the aforementioned scenario, InstallShield always displayed a
prompt asking whether you wanted to delete the entry in the Binary table—regardless of whether any other custom
actions in the project referenced it. The default button on this prompt was Yes, which resulted in both the custom action
and the Binary table entry being deleted; this default behavior led to some users inadvertently deleting the Binary table
entry.

This enhancement is applicable to the following project types: Basic MSI, DIM, InstallScript MSI, Merge Module, and
Transform.

New Standalone Build Registry Entries Indicate InstallShield Version Information

The Standalone Build installation now installs the same InstallShield version–related registry values that the InstallShield
installation installs under HKEY_LOCAL_MACHINE\SOFTWARE\InstallShield\VersionNumber\Professional. This makes it
possible to quickly verify whether all of the development and build machines in your environment are using the same
versions of the product. The pertinent registry values are:

• Product Code—This registry value differs, depending on whether the InstallShield IDE or the Standalone Build is
installed. It is updated for major upgrades of these tools.

• MPIndicator—If applicable, this registry value indicates the maintenance pack—for example, Service Pack 1.

• SP—If applicable, this registry value indicates the number of the service pack—for example, 1.

For InstallShield 2020 and the InstallShield 2020 Standalone Build, the registry values are installed under the following key:

HKEY_LOCAL_MACHINE\SOFTWARE\InstallShield\Automation Interface Version\Professional

See Also
Upgrading Projects from InstallShield 2014 or Earlier

What’s New in InstallShield 2014 SP1

InstallShield 2020

InstallShield includes the following improvements.

Updates to Portuguese Run-Time Strings

The default run-time strings for Portuguese (Brazil) and Portuguese (Portugal) have been updated to reflect the Portuguese
Language Orthographic Agreement of 1990 that finishes going into effect at the end of 2014, per a 6-year transition period
starting in 2009.

See Also
What’s New in InstallShield 2014

InstallShield 2020 User Guide ISP-2600-UG00 127

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

What’s New in InstallShield 2014

InstallShield 2020

New Features
InstallShield includes the following new features.

New InstallShield Prerequisites for .NET Framework 4.5.1

InstallShield includes new InstallShield prerequisites that you can add to Advanced UI, Basic MSI, InstallScript, InstallScript
MSI, and Suite/Advanced UI projects:

• Microsoft .NET Framework 4.5.1 Full

• Microsoft .NET Framework 4.5.1 Web

These prerequisites install the .NET Framework 4.5.1 on supported target systems.

Microsoft SQL Server 2014 Support

InstallShield now includes support for running SQL scripts on SQL Server 2014 database servers. In addition, InstallShield
includes SQL Server 2014 in the predefined list of database servers that you can select when you are specifying in the SQL
Scripts view the target database servers that your product supports.

If your installation targets SQL Server 2014, the SQLBrowse run-time dialog that is displayed when end users choose to
browse for a database server can now list instances of SQL Server 2014, SQL Server 2014 Express, and SQL Server 2014
Express LocalDB. In addition, the SQLBrowse run-time dialog that is displayed when end users choose to browse for a
database catalog can now list catalogs on the specified SQL Server 2014 database server.

This support is available in the following project types: Basic MSI, DIM, InstallScript, and InstallScript MSI.

Microsoft SQL Server 2014 Prerequisites

InstallShield includes several new SQL Server 2014–related InstallShield prerequisites that you can add to Advanced UI,
Basic MSI, InstallScript, InstallScript MSI, and Suite/Advanced UI projects:

• Microsoft SQL Server 2014 Express RTM (x64)

• Microsoft SQL Server 2014 Express RTM (x86 & x64Wow)

• Microsoft SQL Server 2014 Express RTM (x86)

• Microsoft SQL Server 2014 Express RTM LocalDB (x64)

• Microsoft SQL Server 2014 Express RTM LocalDB (x86)

These InstallShield prerequisites install the technology on supported target systems.

New InstallShield Prerequisites for App-V 5.0 SP2

InstallShield includes new InstallShield prerequisites that you can add to Advanced UI, Basic MSI, InstallScript, InstallScript
MSI, and Suite/Advanced UI projects:

• Microsoft App-V 5.0 SP2 Desktop Client (x86)

• Microsoft App-V 5.0 SP2 Desktop Client (x64)

128 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The redistributable files for these InstallShield prerequisites are not available for download from within InstallShield, since
you must obtain them from Microsoft. Once you obtain one of the redistributables from Microsoft, place it in the location
that is displayed when you are editing the prerequisite in the InstallShield Prerequisite Editor.

New InstallShield Prerequisites for Microsoft Visual C++ 2012 Update 4

InstallShield includes new InstallShield prerequisites that you can add to Advanced UI, Basic MSI, InstallScript, InstallScript
MSI, and Suite/Advanced UI projects:

• Microsoft Visual C++ 2012 Update 4 Redistributable Package (x86)

• Microsoft Visual C++ 2012 Update 4 Redistributable Package (x64)

These prerequisites install the various technologies on supported target systems.

Support for Checking for Updates from Maintenance Mode of Advanced UI and Suite/Advanced UI
Installations
Advanced UI and Suite/Advanced UI installations now have support for enabling end users to check for updates to your
product by clicking a new Update button on the maintenance wizard page. If an update is available from your Web site and
the end user chooses to obtain it, the installation downloads it, verifies its digital signature, and launches it.

To use this functionality, your Advanced UI or Suite/Advanced UI project must have support for automatic updates. At build
time, InstallShield creates a metadata file called isupdate.xml file and places it in an UpdateMetadata subfolder in your
project’s build folder. This metadata file identifies the different versions of your Advanced UI or Suite/Advanced UI
installation and their download locations. When you are ready to release the update for your product, you upload to your
site this isupdate.xml file as well as your updated Advanced UI or Suite/Advanced UI installation.

At run time, if the end user is running maintenance mode, the Suite engine checks the metadata file for updates. If an
update is available for download, the Suite engine sets the new ISUpdateAvailable property to 1 and displays a new
MaintenanceUpdateWelcome wizard page, a maintenance wizard page that includes an Update button. In addition, the
Suite engine sets the new ISUpdateVersion property equal to the version of the Suite/Advanced UI or Advanced UI
installation that is available for download.

If an update is not available, the Suite engine displays the standard MaintenanceWelcome wizard page that does not have
an Update button.

For more details, see:

• Supporting Downloadable Updates for an Advanced UI or Suite/Advanced UI Installation

• Advanced UI and Suite/Advanced UI Property Reference

Ability to Include Support Files in Subfolders

InstallShield now lets you specify custom folder structures for support files. To add a subfolder under one of the language-
specific nodes or to the language-independent node in the Support Files view, right-click the node and then click New
Folder. InstallShield adds a subfolder and enables you to rename it as needed. You can also add a nested folder structure.
To add files to a subfolder, select it and right-click in the right pane, and then click Insert Files. At run-time, the installation
copies the support folders and files to SUPPORTDIR, a temporary directory on target systems, to make them available during
your product’s installation process. The support folders and files are deleted when the installation is complete.

The improved Support Files view is available in the following project types: Advanced UI, Basic MSI, Suite/Advanced UI,
InstallScript, and InstallScript MSI.

To learn more, see Adding Support Files.

InstallShield 2020 User Guide ISP-2600-UG00 129

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The automation interface also includes subfolder functionality for support files. The ISWiSetupFile object includes a new
read-write Target property that you can use to specify or obtain the path of the support file’s target directory within
SUPPORTDIR. For more information, see ISWiSetupFile Object.

Support for Deploying Web Deploy Packages to IIS Web Servers and the Cloud
Suite/Advanced UI installations now have built-in support for deploying Web Deploy packages to IIS Web servers and the
cloud. The Web Deploy packages can be created through IIS or a Web application development environment such as Visual
Studio.

To add a Web Deploy package to your Suite/Advanced UI project, use the Packages view. When you add a package and
select it in the Packages view, InstallShield displays package-related settings in the right pane. The Configuration area on
the Common tab of the right pane includes several configuration-related settings for Web Deploy, such as the destination—
which is often a remote server—and credentials. In addition, the Configuration area also includes settings for the
parameters that are defined in the Web Deploy package’s parameters XML file. By default, InstallShield uses Suite/
Advanced UI properties for all of the configuration settings so that end users can set them at run time through the wizard
interface or the command line.

When you add a Web Deploy package to your project, InstallShield adds a predefined Web Deploy wizard page to your
project for that package. The Web Deploy wizard page enables the end user to specify whether the package will be
deployed to a local IIS server, a remote server, or a cloud-based server. It also enables the end user to load the
configuration settings from a publisher profile file (.publishsettings). If you want end users to be able to configure the
parameters that are defined in your Web Deploy package’s parameters XML file, you can add controls to the wizard
interface as needed, and associate those controls with the properties that are specified for the corresponding parameter
settings in the Packages view.

Note that Web Deploy packages are typically intended to behave similarly to first-time installations or to install over
existing earlier or identical versions. As a side effect, Web Deploy packages do not handle uninstallation. Thus, Suite/
Advanced UI installations do not offer maintenance for this type of package. It is recommended that you avoid creating a
Suite/Advanced UI installation that combines one or more Web Deploy packages with one or more traditional packages
(that do offer maintenance) as primary packages.

This feature is available in the Premier edition of InstallShield.

For more information, see:

• Adding a Web Deploy Package to a Suite/Advanced UI Project

• Packages View

Support for Including InstallShield Projects as Packages in Suite/Advanced UI Projects

InstallShield now lets you add InstallShield projects (.ism) as packages in Suite/Advanced UI projects. The InstallShield
projects can be either Basic MSI projects or InstallScript projects; the projects must have been saved in the same version of
InstallShield as the Suite/Advanced UI project.

When you start a build of a release for a Suite/Advanced UI project that includes one or more InstallShield project
packages, InstallShield first builds the designated releases in the associated InstallShield projects, and includes them as
packages in the Suite/Advanced UI installation that it generates. InstallShield adds the output of the Basic MSI and
InstallScript projects to the Suite/Advanced UI installation as .msi and .hdr packages.

Use the Packages view to add an InstallShield project as a package in your Suite/Advanced UI project. This view is also
where you identify which product configuration (for a Basic MSI project package) and which release (for both Basic MSI
project packages and InstallScript project packages) that you want to include as a package in the Suite/Advanced UI
project.

130 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

This feature is available in the Premier edition of InstallShield.

For more information, see:

• Adding an InstallShield Project (.ism) as a Package in a Suite/Advanced UI Project

• Packages View

Support for InstallScript Actions in Suite/Advanced UI Installations

Suite/Advanced UI installations now have built-in support for launching InstallScript actions to perform various run-time
tasks that are outside the scope of the packages that you are including in the installation. These Suite/Advanced UI–based
InstallScript actions function much like InstallScript custom actions in Basic MSI projects.

You can use the InstallScript view that is available now in Suite/Advanced UI projects to add InstallScript files (.rul) to your
project and write functions using the InstallScript language. To have your Suite/Advanced UI action call an InstallScript
function, you must prototype the function with the export keyword, just as you would for InstallScript custom actions in
Basic MSI projects.

Once you have added InstallScript code to your project, use the Events view to add an InstallScript action that calls your
code. Next, you can schedule when at run time you want the action to be launched. For example, you can use the Events
view to schedule an InstallScript action to run during one or more of the built-in events that the Suite/Advanced UI engine
manages.

Note that there are some limitations to the use of InstallScript in Suite/Advanced UI projects. For example, InstallScript UI–
related functions and InstallScript run-time path variables (such as PROGRAMFILES and WINDIR) are not available for use in
a Suite/Advanced UI project.

This feature is available in the Premier edition of InstallShield.

To learn more, see:

• Using Actions to Extend the Behavior of a Suite/Advanced UI Installation

• Working with an Action that Runs InstallScript Code in a Suite/Advanced UI Installation

• Configuring a Suite/Advanced UI Action’s Settings

• Scheduling a Suite/Advanced UI Action

• Suite/Advanced UI and Advanced UI Interaction Functions.

Support for Managed-Code Actions in Suite/Advanced UI Installations

Suite/Advanced UI installations now have built-in support for launching managed-code actions to perform various run-
time tasks that are outside the scope of the packages that you are including in the installation. The new action type calls a
public method in a .NET assembly that is written in managed code such as Visual Basic .NET or C#. These Suite/Advanced
UI–based InstallScript actions are functionally equivalent to DLL actions in Suite/Advanced UI installations. That is, Suite
engine looks for one parameter on the managed function that it calls. This parameter is an ISuiteExtension interface
passed as a System.Object. The return type should be of some 32-bit integer type.

To add a managed-code action to a Suite/Advanced UI project, use the Events view.

This feature is available in the Premier edition of InstallShield.

For more information, see:

• Using Actions to Extend the Behavior of a Suite/Advanced UI Installation

InstallShield 2020 User Guide ISP-2600-UG00 131

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Working with a Managed-Code Action in a Suite/Advanced UI Installation

• Configuring a Suite/Advanced UI Action’s Settings

• Scheduling a Suite/Advanced UI Action

Ability to Launch Suite/Advanced UI Event Actions that End Users Trigger When Using Wizard Interface
Controls
Suite/Advanced UI installations include support for run-time actions that are defined in the Events view and that are
launched when an end user clicks or performs some other action on a wizard interface control. For example, this capability
enables your installation to run executable files, call DLL functions, run InstallScript code, call managed methods in a
managed assembly, run PowerShell scripts, or set a Suite/Advanced UI property when an end user clicks a button in the
wizard interface.

To add an action to your project, use the Events view.

To schedule an action to run when a wizard interface control is clicked or used, select the control that you want to
configure in the Wizard Interface view, and then use the Click setting or an action-related setting under the Events setting
to select the action that you want to launch.

This feature is available in the Premier edition of InstallShield.

For more details, see:

• Configuring an Action for an Element in the Wizard Interface

• Using Actions to Extend the Behavior of a Suite/Advanced UI Installation

Ability to Launch Suite/Advanced UI Actions When Wizard Pages and Windows Are Shown or Hidden
Suite/Advanced UI installations include support for run-time actions that are launched when a wizard page or secondary
window is opened or closed. This capability enables your installation to perform any initialization such as dynamically
retrieving values for a combo box. It also lets you schedule actions to occur before the wizard interface is displayed at run
time.

To add an action to your project, use the Events view.

To schedule an action to run when a wizard page opens or closes, select the wizard page that you want to configure in the
Wizard Interface view, and then select the appropriate action in the Page Entered setting or the Page Exited setting.

To schedule an action to run when a secondary window opens or closes, select the secondary window that you want to
configure in the Wizard Interface view, and then select the appropriate action in the Window Entered setting or the Window
Exited setting.

This feature is available in the Premier edition of InstallShield.

For more details, see:

• Configuring an Action for an Element in the Wizard Interface

• Using Actions to Extend the Behavior of a Suite/Advanced UI Installation

132 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New Property for Preventing Passwords from Being Written in Advanced UI and Suite/Advanced UI
Installation Log Files
If you launch an Advanced UI or Suite/Advanced UI Setup.exe file with the /debuglog parameter, the Suite engine
generates a debuglog file. By default, the debug log file includes the values of changed Advanced UI or Suite/Advanced UI
properties.

In some cases, you may want to prevent the Suite engine from writing the values of specific properties to the debug log file.
For example, you may want to prevent properties that contain passwords and other sensitive information from being
logged. To enable this scenario, Advanced UI and Suite/Advanced UI installations support a new property called
ISHiddenProperties. You can set this property to a semicolon-delimited list of case-sensitive property names whose
values you do not want to be written to debug log files.

Note that ISHiddenProperties is useful for prevention of logging only for values that would be logged by changing the
property value. If the property is logged any other way (such as through ISuiteExtension::LogInfo), the Suite engine cannot
prevent the logging. Therefore, any code that you create to write a property value to the log file should read
ISHiddenProperties to see whether the property value should be logged.

For more information, see Preventing a Property Value from Being Written in Advanced UI and Suite/Advanced UI Debug
Log Files.

Enhanced Substitution Syntax for Advanced UI and Suite/Advanced UI Projects

Various areas of Advanced UI and Suite/Advanced UI projects include support for enclosing property names in square
brackets to indicate that the properties should be replaced with appropriate values at run time. The run-time syntax has
been enhanced to support several additional types of substitution:

• Special characters—Preceding a special character with a backslash and enclosing the resulting string in square
brackets resolves the special character at run time. For example, an entry such as [\[]Text[\]] resolves as [Text].

• Null character—A tilde that is enclosed in square brackets—that is, [~]—resolves as a null character embedded in the
string.

• Environment variables—Preceding the name of an environment variable with a percent sign and enclosing the
resulting string in square brackets resolves the environment variable at run time. For example, [%PATH] resolves as the
value of the PATH environment variable.

• Recursive property resolution—Surrounding a property resolution with additional square brackets resolves the
resolved value of a property. For example [[PROPERTY1]] resolves to the value of the property whose name is stored
in PROPERTY1; if PROPERTY1 holds PROPERTY2, the resolved value is the value stored in PROPERTY2.

For more information, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at
Run Time.

Support for Removing Files and Folders

InstallShield now has built-in support that makes it easy to specify files and folders that you want to be removed from
target systems at run time. This file and folder removal capability is useful for scenarios such as removing application-
created files that your installation does not otherwise track.

You can schedule the removal of a file or folder for one of the following events:

• When the file or folder’s component is being installed

• When the file or folder’s component is being uninstalled

• When the file or folder’s component is being installed or uninstalled

InstallShield 2020 User Guide ISP-2600-UG00 133

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Note that if the item to be removed is a folder, that folder is removed only if it is empty.

InstallShield offers different methods for configuring a file or folder removal in a project:

• In the Files and Folders view, select the destination folder that contains the file or folder that you want to be removed.
Then right-click in the Destination computer’s files pane and click Add File Removal.

• In the Setup Design view (in installation projects) or the Components view, expand the node of the component that
contains the file or folder that you want to be removed, and then click the Files subnode. Next, right-click in the Files
pane and click Add File Removal.

With both methods, InstallShield displays a Properties dialog box that lets you configure the available removal settings.

Previously, the only way to indicate which files and folders should be removed was to use the Direct Editor view to
manually author entries in the RemoveFile table.

This feature is available in the following project types: Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM
Database, and Transform.

To learn more, see:

• Removing Files and Folders from Target Systems

• File Removal Properties Dialog Box

The automation interface includes a new ISWiRemoveFile object and a new ISWiRemoveFiles collection for removing files
and folders. In addition, three new member methods are applicable to the ISWiComponent object: AddRemoveFile, which
enables you to add a file removal entry to the current component; RemoveRemoveFile, which enables you to remove a file
removal entry from the current component; and ISWiRemoveFiles, which returns an ISWiRemoveFiles collection that
contains all of the file removal entries that are associated with the current component.

These automation interface improvements are available in the following project types: Basic MSI, InstallScript MSI, and
Merge Module.

For more details, see:

• ISWiRemoveFile Object

• ISWiRemoveFiles Collection

• AddRemoveFile Method

• RemoveRemoveFile Method

• ISWiRemoveFiles Method

• ISWiComponent Object

Support for DPI-Aware Installations

InstallShield now lets you create DPI-aware installations that can scale run-time user interface elements properly across
modern target systems that have various high-DPI display settings, making your installation’s user interface more
consistent and visually appealing. The support that is available and the improvements that have been made vary,
depending on the project type that you are using.

Advanced UI and Suite/Advanced UI Projects

DPI-awareness in Advanced UI and Suite/Advanced UI projects has two parts:

134 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Items that are drawn by the engine are scaled according to the target system’s DPI settings. Thus, if a target system
has a DPI of 200%, the check box control is scaled accordingly.

• The engine considers the scale factor and language when displaying images and other resources that you are
including in the wizard interface.

For example, when the engine determines that the scale factor should be 150 and that the appropriate language is English,
it looks for resources that have the string scale-150 in their path or file name. It searches the following paths in the order
listed when searching for image.png on the target system:

1. [SUPPORTDIR]0409\scale-150\image.png

2. [SUPPORTDIR]0409\image.scale-150.png

3. [SUPPORTDIR]0409\image.png

4. [SUPPORTDIR]scale-150\image.png

5. [SUPPORTDIR]image.scale-150.png

6. [SUPPORTDIR]\image.png

Note that matching the language takes precedence over matching the correct DPI.

InstallShield includes scale-150 and scale-200 images for the built-in default images that are included in Advanced UI and
Suite/Advanced UI projects. If you want to include custom resources in your project, use the Support Files view to add
appropriately scaled images.

InstallScript and InstallScript MSI Projects

DPI-awareness in InstallScript and InstallScript MSI projects has the following parts:

• All of the built-in default dialog images have been replaced with images that scale well to 200%.

• The static dialog controls that have a control ID of 1200 now include support for .png images, which allow for
transparency. This applies to the computer image that is displayed by default on the left side of the exterior skinned
dialogs such as the Welcome dialog. It also applies to the banner images on interior dialogs.

In addition, these same controls support a new format for identifying each image and its associated scale factor:

@@ResourceID;ScaleFactor

ResourceID indicates the resource identifier number that should be used to look up either a .png image (stored as
resource type PNG) or a bitmap image (stored as resource type RT_BITMAP). ScaleFactor indicates the DPI scale
percentage for which the image is intended.

For example, this can be 100% (96 DPI), 125% (120 DPI), 150% (144 DPI), or 200% (192 DPI). If the scale factor that is
specified for an image is 200, the image will be shrunk down for display on target systems that are running less than
200% DPI scaling. On a 200% target system, it will be displayed at 1:1. If the scale factor that is specified for the image
is 100, the image will be scaled up for display on target systems that are running 200% DPI scaling.

The previous format for identifying bitmap images (.bmp) still works, but it does not have support for scaling, or for
.png images:

@BitmapResourceID;TransparentFlag;3-DFlag;<unused>;TransparentColorKey

• The new image string format is now used by default on all ID 1200 static controls for the dialog header banner and for
exterior panel icon images. If you upgrade an InstallScript or InstallScript MSI project to InstallShield 2020 and you

InstallShield 2020 User Guide ISP-2600-UG00 135

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

edited the dialogs in the earlier version of InstallShield, you will need to edit the image string to use the new format for
all of the languages that your project supports.

• The InstallScript function SdOptionsButtons has been updated to include support for the new string format for
identifying images:

@@ResourceID;ScaleFactor

Previously, the following format was used:

@BitmapResourceID;BitmapIconFlag;TransparentColor

• The nItem parameter for the InstallScript function GetSystemInfo includes support for two new constants:

• SYSTEM_DPI—This returns the system DPI value in the nvResult parameter.

• SYSTEM_DPI_SCALING—This returns the system DPI scaling value in the nvResult parameter.

To learn more, see:

• GetSystemInfo

• SdOptionsButtons

• Background About the Default Images on Dialogs in InstallScript and InstallScript MSI Projects

Basic MSI Projects

The built-in images that are displayed on dialogs that the Setup.exe launcher displays at run time have been replaced with
images that scale well to larger areas. This includes images that are displayed on the initialization dialog.

Support for Distributing Your Installation to Virtual Machines that InstallShield Provisions at Build Time
or on Demand
You can configure your projects so that after each successful build of your installation, InstallShield automatically reverts a
virtual machine (VM) to a designated snapshot, powers on the VM, and copies your installation to the VM to make it
available for testing. You can also alternately perform these testing preparation steps on demand at any time. The testing
preparation capability makes it possible to reduce testing time and eliminate manual steps.

The VM can be on a Microsoft Hyper-V Server, a VMware ESX or ESXi Server, or a VMware Workstation.

To specify VM information, use the Virtual Machine area on the Events tab for a release in the Releases view. One of the
settings lets you specify whether you want the release to be distributed to the specified VM each time that it is successfully
built.

To distribute the release to the VM at any time, right-click the release in the Releases view and then click Distribute to VM.

Note that when you use the Configuration setting on the Events tab to configure VM details, InstallShield writes the data
that you specify to a file called VMConfigurations.xml. This VMConfigurations.xml file is a machine-wide file that you can
configure once and then use it in other InstallShield projects, as well as share it with other team members. You can also use
this file with the Standalone Build.

In order to deploy to one of the supported VMs, InstallShield needs to communicate with the virtualization technology that
you are using. If you are using VMware virtualization technology (VMware ESX or ESXi Server or VMware Workstation), the
VMware VIX API needs to be installed on the same machine as InstallShield. You can do this by either installing VMware
Workstation on that machine or by downloading and installing the VMware VIX API from http://www.vmware.com/
support/developer/vix-api.

136 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

If you are using VMware Workstation, it is recommended that you install VMware Workstation on the same machine as
InstallShield so that InstallShield uses the version of the VIX API that was designed for that specific version of VMware
Workstation. Although it is likely that newer versions of the VIX API will also work, it seems that the best approach is for
InstallShield to use the version of the VIX API that was bundled with your version of VMware Workstation.

This feature is available in the following project types: Basic MSI, InstallScript, InstallScript MSI, and Suite/Advanced UI.

This feature is available in the Premier edition of InstallShield.

To learn more, see the following:

• Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand

• Events Tab for a Release

• Edit Virtual Machine Configurations Dialog Box

• Sharing Virtual Machine Settings for Distribution of Releases

Enhancements
InstallShield includes the following enhancements.

Usability Improvements for Populating Combo Box and List Box Controls in Advanced UI and Suite/
Advanced UI Projects
InstallShield lets you add combo box controls and list box controls to wizard pages and secondary windows of Advanced UI
and Suite/Advanced UI projects. The process of creating either one of these types of controls involves the use of two
properties: one that defines the list of options that you want to display in the control, and one that the installation uses to
store the option that the end user selects at run time. Now you can configure both of those properties entirely from within
the Wizard Interface view in InstallShield, instead of having to use the Wizard Interface view and the Property Manager
view.

In the Wizard Interface view, the Content Property setting of the combo box or list box control now contains an ellipsis
button (...) that you can click when you want to define the list of options that you want to display in the control. When you
click this button, a simple Edit List Options dialog box opens, enabling you to specify the list of options that you want to
display in the selected control, as well as an associated value.

Previously, it was necessary to use the Property Manager view to define the property that contained the list of options, as
well as their corresponding property values. The format that was required for defining the property (for example,
ID_Option1\rValue1\nID_Option2\rValue2\nID_Option3\rValue3) was difficult to remember and error-prone.

To learn more, see:

• Populating Combo Box and List Box Controls in the Wizard Interface

• Edit List Options Dialog Box

Run-Time Improvements for Browsing to a File or Folder in Advanced UI and Suite/Advanced UI

Installations
Several improvements for enabling end users to browse to a file or folder are now available in Advanced UI and Suite/
Advanced UI installations:

• A new Browse for New File action is available for controls on wizard pages and secondary windows. If you add this
action to the Click event of a control such as a button and an end user clicks the button, a browse dialog box opens,
enabling the end user to specify a new file and its location.

InstallShield 2020 User Guide ISP-2600-UG00 137

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

When you add this type of action to a control in your project, you can specify the text for the title bar of the dialog box.
You can also specify the file extension filter options that you want to be available for selection, as well as the default
file extension that should be used when creating the file.

• The existing Browse for Folder action has been enhanced. The Browse for Folder dialog box that this action launches
accepts only locations that have file system equivalents. That is, the OK button on this dialog box remains disabled if
the end user selects a location such as This PC or My Computer. Previously, end users were able to select such
locations, and doing so cleared the value of the associated property.

When you add this type of action to a control in your project, you can specify the instructions that you want to be
displayed on this Browse for Folder dialog box.

• The existing Browse for File action has been enhanced to enable you to specify the file extension filter options that you
want to be available for selection on the file browse dialog box.

For more details, see Configuring an Action for an Element in the Wizard Interface.

Support for Offering Printer Selection for the LicenseAgreement Dialog at Run Time
The behavior of the Print button on LicenseAgreement dialogs has been enhanced. Instead of printing directly to the
default printer when an end user clicks the Print button, the printer selection dialog box now opens.

This enhancement is available in the following project types: Basic MSI, InstallScript, InstallScript MSI.

Advanced UI and Suite/Advanced UI projects already have this capability.

Ability to Insert Text in Text Files

The Text File Changes view enables you to configure changes that you want to be made to text files at run time on target
systems. The text files can be part of your installation, or they can be files that are already present on target systems. The
Text File Changes view has been improved to enable you to insert text at the beginning or end of one or more files. It also
now lets you insert text before or after specified text. When you are configuring text file changes in this view, use the new
Action setting to specify whether you want to replace existing text, insert text before or after existing text, or insert text at
the beginning or end of files.

Previously, the Text File Changes view had support for replacing existing text in text files at run time.

This enhancement is available in the following project types: Basic MSI, DIM, InstallScript MSI, Merge Module, MSI
Database, Transform.

For more information, see:

• Modifying Text Files

• Text File Changes View

Support for Enabling End Users to Choose to Which Installed Instances of an Earlier Version of a Product
to Apply a Major Upgrade
The multi-instance support in Basic MSI projects now includes support for major upgrades. At run time, the instance
selection dialog that the Setup.exe setup launcher displays lets end users view a list of all of the currently installed
instances of the product, including different major versions of the product that are installed. End users can now use this
improved instance dialog to install a new instance, maintain an existing instance, or apply a major upgrade for an instance.

Previously, the only instances that the instance selection dialog listed were ones that shared the same product code as the
running multi-instance installation.

138 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

To learn more, see:

• Configuring and Building a Major Upgrade that Includes Multiple-Instance Support

• Setting Properties for an Instance

• Run-Time Behavior for Installing Multiple Instances of a Product

Ability to Create Microsoft App-V 5.x Packages on Additional Platforms

The Microsoft App-V Assistant in InstallShield includes support for creating virtual applications in the Microsoft App-V 5.x
format. The Package Information page in this assistant lets you specify which version of App-V—5.x or 4.x—you want to
target. Now you can build an App-V 5.x package in InstallShield on any version of Windows that InstallShield supports.
Previously, Windows 8 or Windows Server 2012 was required.

For information, see:

• Components of an App-V Package

• Build Output for App-V Packages

Enhanced File Open Run-Time Dialog for Basic MSI Installations

InstallShield includes support for launching the Open dialog from one of the dialogs in your Basic MSI installation. End
users click a browse button in one of your dialogs, and this launches the Open dialog. The Open dialog lets the end user
browse for a file. You can now optionally use the new property IS_BROWSE_INITIALDIR to specify the default path that is
displayed in this dialog at run time. Previously, the dialog displayed the path to which the end user last browsed.

To learn more, see Launching a File Open Dialog.

New FlexNet Connect 13.06 Redistributables Available

InstallShield includes support for FlexNet Connect 13.06 in Basic MSI and InstallScript MSI projects. Use the Update
Notifications view in InstallShield to include one of the two FlexNet Connect 13.06 merge modules—one has the Common
Software Manager, and the other does not.

See Also
Upgrading Projects from InstallShield 2013 or Earlier

What’s New in InstallShield 2013 SP1

InstallShield 2020

InstallShield 2013 Service Pack 1 (SP1) includes changes that offer support for the final released versions of Windows 8.1,
Windows Server 2012 R2, and Visual Studio 2013.

Ability to Target Windows 8.1 and Windows Server 2012 R2 Systems

InstallShield enables you to specify that your installation requires Windows 8.1 or Windows Server 2012 R2. It also lets you
build feature and component conditions for these operating systems.

The InstallShield prerequisites that should be installable on Windows 8.1 and Windows Server 2012 R2 have been updated
so that they are installed on those systems if needed. Previously, the prerequisites were not run by default on those
systems. This applies to the following InstallShield prerequisites:

• FSharp Redistributable Package 2.0

InstallShield 2020 User Guide ISP-2600-UG00 139

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• JRE_SE 1.7.0_02 (x64)

• JRE_SE 1.7.0_02 (x86)

• Microsoft .NET Framework 3.0 OS Component

• Microsoft .NET Framework 3.5 SP1 (Windows Feature)

• Microsoft .NET Framework 4.5 Full

• Microsoft .NET Framework 4.5 Web

• Microsoft App-V 5.0 SP1 Desktop Client (x64)

• Microsoft App-V 5.0 SP1 Desktop Client (x86)

• Microsoft ReportViewer 2010

• Microsoft SQL CE 3.5 SP2

• Microsoft SQL Server 2005 Express SP3 (x86 & x64Wow)

• Microsoft SQL Server 2005 Express SP3 (x86)

• Microsoft SQL Server 2008 Express SP1 (x64)

• Microsoft SQL Server 2008 Express SP1 (x86 & x64Wow)

• Microsoft SQL Server 2008 Express SP1 (x86)

• Microsoft SQL Server 2008 Management Objects 10.00.2531 (IA64)

• Microsoft SQL Server 2008 Management Objects 10.00.2531 (x64)

• Microsoft SQL Server 2008 Management Objects 10.00.2531 (x86)

• Microsoft SQL Server 2008 Native Client 10.00.2531 (IA64)

• Microsoft SQL Server 2008 Native Client 10.00.2531 (x64)

• Microsoft SQL Server 2008 Native Client 10.00.2531 (x86)

• Microsoft SQL Server 2008 R2 Express RTM (x64)

• Microsoft SQL Server 2008 R2 Express RTM (x86 & x64Wow)

• Microsoft SQL Server 2008 R2 Express RTM (x86)

• Microsoft SQL Server 2008 R2 Express SP2 (x64)

• Microsoft SQL Server 2008 R2 Express SP2 (x86 & x64Wow)

• Microsoft SQL Server 2008 R2 Express SP2 (x86)

• Microsoft SQL Server 2008 R2 Native Client 10.50.1600.1 (IA64)

• Microsoft SQL Server 2008 R2 Native Client 10.50.1600.1 (x64)

• Microsoft SQL Server 2008 R2 Native Client 10.50.1600.1 (x86)

• Microsoft SQL Server 2012 Express LocalDB RTM (x64)

• Microsoft SQL Server 2012 Express LocalDB RTM (x86)

• Microsoft SQL Server 2012 Express RTM (x64)

140 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Microsoft SQL Server 2012 Express RTM (x86 & x64Wow)

• Microsoft SQL Server 2012 Express RTM (x86)

• Microsoft SQL Server 2012 Native Client (x64)

• Microsoft SQL Server 2012 Native Client (x86)

• Microsoft SQL Server Compact 4.0 (x64)

• Microsoft SQL Server Compact 4.0 (x86)

• Microsoft SQL Server Native Client 9.00.4035 (IA64)

• Microsoft SQL Server Native Client 9.00.4035 (x64)

• Microsoft SQL Server Native Client 9.00.4035 (x86)

• Microsoft SQL Server System CLR Types 10.00.2531 (IA64)

• Microsoft SQL Server System CLR Types 10.00.2531 (x64)

• Microsoft SQL Server System CLR Types 10.00.2531 (x86)

• Microsoft Visual C++ 2005 SP1 Redistributable MFC Security Update KB2538242(x64)

• Microsoft Visual C++ 2005 SP1 Redistributable MFC Security Update KB2538242(x86)

• Microsoft Visual C++ 2005 SP1 Redistributable Package (x64)

• Microsoft Visual C++ 2005 SP1 Redistributable Package (x86)

• Microsoft Visual C++ 2008 SP1 Redistributable MFC Security Update KB2538243(x64)

• Microsoft Visual C++ 2008 SP1 Redistributable MFC Security Update KB2538243(x86)

• Microsoft Visual C++ 2008 SP1 Redistributable Package (x64)

• Microsoft Visual C++ 2008 SP1 Redistributable Package (x86)

• Microsoft Visual C++ 2010 Redistributable Package (x64)

• Microsoft Visual C++ 2010 Redistributable Package (x86)

• Microsoft Visual C++ 2010 RTM Redistributable MFC Security Update KB2467173 (x64)

• Microsoft Visual C++ 2010 RTM Redistributable MFC Security Update KB2467173 (x86)

• Microsoft Visual C++ 2010 SP1 Redistributable Package (x64)

• Microsoft Visual C++ 2010 SP1 Redistributable Package (x86)

• Microsoft Visual C++ 2012 Redistributable Package (x64)

• Microsoft Visual C++ 2012 Redistributable Package (x86)

• Microsoft Visual C++ 2012 Update 1 Redistributable Package (x64)

• Microsoft Visual C++ 2012 Update 1 Redistributable Package (x86)

• Microsoft VSTO 2010 Runtime (x64)

• Microsoft VSTO 2010 Runtime

InstallShield 2020 User Guide ISP-2600-UG00 141

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Enhancements to the InstallScript Language for Windows 8.1 and Windows Server 2012
R2
The following structure members and predefined constants were added to the InstallScript language:

• SYSINFO.WINNT.bWin81—This is a new SYSINFO structure member. If the operating system is Windows 8.1 or
Windows Server 2012 R2, this value is TRUE.

• ISOSL_WIN81—This is a new predefined constant that is available for use with the FeatureFilterOS function and the
SYSINFO structure variable. It indicates that the target system is running Windows 8.1 or Windows Server 2012 R2.

For more information, see FeatureFilterOS function and the SYSINFO structure variable.

Automation Interface Enhancement: OSFilter Property Value for Windows 8.1 and
Windows Server 2012 R2
The following constants are now available for use with the OSFilter member of the ISWiComponent and ISWiRelease
objects in the automation interface:

eosWin81 = &H8000000 (134217728)—These are for Windows 8.1 and Windows Server 2012 R2.

In addition, the value for the eosAll constant is now &HFD100D0 (265355472); previously, it was &7D100D0 (131137744).

The OSFilter member applies to the ISWiComponent object in InstallScript and InstallScript MSI projects. The OSFilter
member applies to the ISWiRelease object in InstallScript projects.

For more information, see the following:

• ISWiComponent Object

• ISWiRelease Object

Support for Microsoft Visual Studio 2013

InstallShield includes support for Visual Studio 2013. You can create InstallShield projects from within this version of Visual
Studio.

New InstallShield Prerequisites for Microsoft SQL Server 2012 Express SP1
InstallShield includes several new SQL Server–related InstallShield prerequisites that you can add to Basic MSI,
InstallScript, and InstallScript MSI projects:

• Microsoft SQL Server 2012 Express SP1 LocalDB (x64)

• Microsoft SQL Server 2012 Express SP1 LocalDB (x86)

• Microsoft SQL Server 2012 Express SP1 (x64)

• Microsoft SQL Server 2012 Express SP1 (x86 & x64Wow)

• Microsoft SQL Server 2012 Express SP1 (x86)

• Microsoft SQL Server 2012 Express SP1 Management Objects (x64)

• Microsoft SQL Server 2012 Express SP1 Management Objects (x86)

• Microsoft SQL Server 2012 Express SP1 System CLR Types (x64)

• Microsoft SQL Server 2012 Express SP1 System CLR Types (x86)

142 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

These InstallShield prerequisites install the technology on supported target systems.

Support for Defining Custom Themes for the Controls on Wizard Pages and Windows in
Suite/Advanced UI and Advanced UI Installations
Suite/Advanced UI and Advanced UI projects now enable you to define themes for wizard interface controls. A control
theme is a collection of colors for various parts of controls—text color, background color, and border color—and for various
states of controls—such as clicked and hovered. You can specify the control theme that you want to use for the controls in
your user interface by default. You can also override the theme for specific controls on wizard pages and windows in your
user interface. Control themes give buttons and other items in your installation’s user interface a flat look (without the
three-dimensional effects) that is reminiscent of the style of Windows Store apps.

The following types of controls support the use of control themes:

• Buttons, including the navigation buttons

• Check boxes

• Radio buttons

• Command links

To add a control theme to your project, right-click the Control Themes node in the Wizard Interface view, and then click
Add Control Theme. Then configure the theme’s settings as needed.

To specify the theme that you want to use by default for the controls in your user interface, select the appropriate theme in
the new Default Control Theme setting that is displayed in the Wizard Interface view when the Wizard Pages node is
selected. This setting is blank by default.

To override the control theme for a specific control, select the appropriate theme in the Control Theme setting for that
control.

For details, see:

• Using Styles, Brushes, and Control Themes to Customize the Wizard Interface

• Defining a Custom Control Theme for the Wizard Interface

• Applying a Theme to a Control in the Wizard Interface

New Predefined Path Variable for the Visual Studio Solution Folder
A new predefined path variable called VSSolutionFolder is available in projects to reference a higher-level base directory.
This support enables you to have in your InstallShield projects static links to files in sibling projects that are within the
Visual Studio solution folder; if you work on the projects on a different machine, the static links that use the
VSSolutionFolder path variable can reference the correct paths for the files in sibling projects.

The VSSolutionFolder path variable is defined automatically whenever an InstallShield project is opened from within a
Visual Studio solution. It is also defined automatically if you are using MSBuild to build a solution that contains an
InstallShield project. However, in other scenarios, when the InstallShield project is opened without the Visual Studio
solution, VSSolutionFolder cannot be defined automatically. For example, if you open the InstallShield project in
InstallShield directly, without having Visual Studio open, VSSolutionFolder is not defined. Similarly, if you use the
command-line tool IsCmdBld.exe, or if you use MSBuild with an .isproj file, VSSolutionFolder is not defined. If you are using
IsCmdBld.exe to build a release in InstallShield project, use the -L command-line parameter to set the value of
VSSolutionFolder. If you are using MSBuild, use the PathVariables parameter to set the value of VSSolutionFolder. This
parameter is exposed as the ItemGroup InstallShieldPathVariableOverrides when the default targets file is used.

InstallShield 2020 User Guide ISP-2600-UG00 143

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

If you include in your InstallShield project a source file whose path includes the VSSolutionFolder path variable and build it
in an environment that does not support the VSSolutionFolder path variable, build errors such as the following ones may
occur:

• -6103: Could not find file <VSSolutionFolder>\MyFile.exe

• -6271: File <VSSolutionFolder>\MyFile.exe not found. An error occurred building the MsiFileHash table record for this
file. Verify that the file exists in the specified location.

This functionality is available in the following project types: Advanced UI, Basic MSI, InstallScript, InstallScript MSI, Merge
Module, Suite/Advanced UI.

To learn more, see:

• Using the VSSolutionFolder Path Variable with Visual Studio Solutions

• Predefined Path Variables

• Microsoft Build Engine (MSBuild)

• ISCmdBld.exe

Ability to Easily Update the Product Codes of Instances in a Multi-Instance Project

If you are creating major upgrades for a project that includes multi-instance support, it is necessary to update the product
code of each instance. InstallShield now enables you to easily update the product code of a specific instance that is defined
in your project. InstallShield also now lets you easily update the product code of all instances that are defined for a product
configuration in your project.

To update the product code of a specific instance, use the new Generate a new GUID command that is available when you
right-click the value in the ProductCode setting for an instance that is defined on the Multiple Instances tab for a product
configuration in the Releases view.

To update the product code of each instance that is defined for a product configuration in your project, use the new
Change ProductCode of Each Instance command that is available when you right-click the Instances node on the Multiple
Instances tab for a product configuration in the Releases view.

This functionality is available in Basic MSI projects.

For details, see Updating the Product Code of One or More Instances.

See Also
What’s New in InstallShield 2013

What’s New in InstallShield 2013

InstallShield 2020

New Features
InstallShield includes the following new features.

144 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Ability to Create Run-Time Actions That Extend the Behavior of a Suite/Advanced UI Installation
You may require your Suite/Advanced UI installation to perform various run-time tasks that are outside the scope of the
packages that you are including in the installation. For example, you may need the Suite/Advanced UI installation to do
one or more of the following:

• Install an application before the user interface of the Suite/Advanced UI installation is displayed.

One sample scenario in which this may be necessary is when one of the packages in your Suite/Advanced UI
installation runs SQL scripts to install an Oracle database. Before this package is run, you may want the Suite/
Advanced UI interface to display a wizard page that lets end users select the appropriate server from a list of servers
that are available on the network. This type of UI support requires that ODBC drivers be installed on the target system.

• Search the target system for the presence or absence of a particular product, technology, folder, file, registry entry, or
other item.

• Configure the target system before or after running a package in the Suite/Advanced UI installation.

To extend the capabilities of a Suite/Advanced UI installation and make it possible to perform those sorts of tasks and
more, you can use the new Events view in your Suite/Advanced UI project to create actions that run executable files, call
DLL functions, run PowerShell scripts, or set Suite/Advanced UI properties at run time.

When you add an action to your project, you can schedule when at run time you want it be launched:

• Use the Events explorer in the Events view to schedule the action to run during one or more of the built-in events that
the Suite/Advanced UI manages. This area of the view lists the events and the actions that occur during each event in
chronological order from top to bottom.

• Use the settings in the Events area of the Packages view to schedule an action to run before or after the Suite/
Advanced UI engine installs, removes, modifies, or repairs a package.

When you schedule an action, you can build conditional statements that control whether the action should be run. You can
use the same types of condition checks that are available in other areas of a Suite/Advanced UI project, as well as two
additional new types of condition checks:

• Package Operation—Check the state (for example, install or remove) in which a particular package in the Suite/
Advanced UI installation is running.

• Feature Operation—Check the state (for example, install or remove) in which a particular feature in the Suite/
Advanced UI installation is running.

These types of conditions are available only for actions that are associated with an event in the Events view, or with a
package in the Packages view.

Note that the PowerShell action support requires PowerShell 2.0 or later on target systems.

This new feature is available in the Premier edition of InstallShield.

For more information, see:

• Using Actions to Extend the Behavior of a Suite/Advanced UI Installation

• Working with an .exe File for an Action in a Suite/Advanced UI Installation

• Working with a DLL File for an Action in a Suite/Advanced UI Installation

• Working with a PowerShell Script for an Action in a Suite/Advanced UI Installation

• Adding an Action to a Suite/Advanced UI Project

InstallShield 2020 User Guide ISP-2600-UG00 145

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Configuring a Suite/Advanced UI Action’s Settings

• Scheduling a Suite/Advanced UI Action

• Types of Events in a Suite/Advanced UI Installation

• Events View

• Packages View

• Package Operation Condition Settings

• Feature Operation Condition Settings

Support for Enabling Windows Roles and Features During a Suite/Advanced UI Installation
If a particular package in your Suite/Advanced UI installation requires that one or more Windows roles and features be
enabled on target systems, you can specify this requirement through the new Windows Features setting in the Packages
view when you are configuring the package in your Suite/Advanced UI project. At run time, if an eligible package that is
being installed requires one or more Windows roles or features that are disabled, the Suite/Advanced UI installation
enables those roles and features before launching the package.

For example, your Suite/Advanced UI project may have a package that installs an IIS Web site that requires that the Internet
Information Services feature in Windows be turned on. Another package in the same project may require that the
PowerShell feature be turned on. When you are configuring the settings of those packages in your project, you can specify
the Windows features that are required; at run time, if a package is eligible to be installed on a target system but any of its
required Windows features are disabled, the Suite/Advanced UI installation enables those disabled Windows features
before launching it. If the package is not eligible, its required Windows features are not enabled.

InstallShield has built-in support for enabling several Windows features:

• Internet Information Services

• PowerShell

• .NET Framework 3.x

InstallShield also lets you specify additional Windows roles and features that a package requires.

This new feature is available in the Premier edition of InstallShield.

To learn more, see:

• Enabling Windows Roles and Features During a Suite/Advanced UI Installation

• Packages View

Ability to Create Advanced UI and Suite/Advanced UI Project Templates

InstallShield has support for using Advanced UI and Suite/Advanced UI projects as templates. A project template contains
default settings and design elements that you want to use as a starting point when you create a new Advanced UI or Suite/
Advanced UI project.

You can designate any Advanced UI or Suite Advanced UI project to be a template. Project files and template files have the
same file extension: .issuite.

To designate that an .issuite project file is a template file and make the template available for selection in the New Project
dialog box, right-click in the All Types tab on the New Project dialog box and then click Add New Template. InstallShield lets
you browse to the .issuite file that you want to use as a template, and it adds a new icon for it to the All Types tab.

146 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

To create a new Advanced UI or Suite/Advanced UI project using your .issuite file as a template, select the template’s icon
on the All Types tab of the New Project dialog box when you are creating the new project.

For instructions, see:

• Creating Project Templates

• Basing New Projects on Templates

New Built-in Template Available for Creating Installations that Install Multi-tier Applications
InstallShield includes a new Multi-tier Application template that helps you get started with creating a Suite/Advanced UI
installation for cloud-based multi-tier applications. You can create this sort of installation to enable end users to easily
manage the installation of tiers that install Web sites, databases, and applications. They can use the wizard pages in the
Suite/Advanced UI installation to select which tiers they want to install, or they can use the command-line support to
select the appropriate features.

The new Multi-tier Application template contains three tiers that are exposed as features. You can customize these features
to include the tiers of your product, adding or removing features as needed. The template also contains four releases in the
Releases view: one flagged for each of the three predefined features, and one that includes all of the features. This enables
you to build separate installations—one for each tier, and one that lets end users install all available tiers.

This feature is available in the Premier edition of InstallShield.

New InstallShield Prerequisites for .NET Framework 3.5 SP1, Microsoft Visual C++ 2012, and SQL Server
2008 R2 Express SP2
InstallShield includes the following InstallShield prerequisites that you can add to Advanced UI, Basic MSI, InstallScript,
InstallScript MSI, and Suite/Advanced UI projects:

• Microsoft .NET Framework 3.5 SP1 (Windows Feature)

• Microsoft SQL Server 2008 R2 Express SP2 (x64)

• Microsoft SQL Server 2008 R2 Express SP2 (x86 & x64Wow)

• Microsoft SQL Server 2008 R2 Express SP2 (x86)

• Microsoft Visual C++ 2012 Update 1 Redistributable Package (x64)

• Microsoft Visual C++ 2012 Update 1 Redistributable Package (x86)

These prerequisites install the various technologies on supported target systems.

New Application Virtualization Suitability Tests

Several new validation suites are available in InstallShield for helping you to determine how ready your products are for
virtualization. The InstallShield virtualization internal consistency evaluators (ISVICEs) that are included in these suites let
you check suitability for Microsoft App-V, Microsoft Server App-V, VMware ThinApp, and Citrix XenApp. The validation suites
can enable you to make more informed decisions about how you build your product if you are considering offering your
customers a virtualized version.

If you want to configure InstallShield to perform validation with these validation suites each time that a Basic MSI release is
successfully built: On the Tools menu, click Options. On the Validation tab, select the appropriate check boxes.

If you want to perform validation separately from the build process: On the Build menu, point to Validation, and then click
the appropriate new suite.

InstallShield 2020 User Guide ISP-2600-UG00 147

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The virtualization suites are available in the Premier Edition of InstallShield.

This feature is available in the following project types: Basic MSI and InstallScript MSI.

For more information, see:

• InstallShield Virtualization Suitability Suite

• Validating Projects

Support for Creating Microsoft App-V 5.x Packages

The Microsoft App-V Assistant in InstallShield includes support for creating virtual applications in the Microsoft App-V 5.x
format. The Package Information page in this assistant lets you specify which version of App-V—5.x or 4.x—you want to
target.

If you are targeting App-V 5.x, a new version of the App-V Launcher tool is available for testing App-V 5.x packages before
moving them to the deployment server. The new version of this tool is capable of launching a Command Prompt window
within the virtual environment of the App-V package. Thus, it is no longer necessary to inject diagnostic tool shortcuts for
Cmd.exe or Regedit.exe directly into an App-V package beginning with App-V 5.x.

The name of the directory in which InstallShield saves an App-V package at build time varies, depending on which version
of App-V you are targeting. For App-V 5.x packages, the directory is ProductName, and it is placed in a folder called App-
VPackage. For App-V 4.x packages, InstallShield includes the product version number to the ProductName folder; that is,
ProductName_vN, (where N is the product version number).

Note that although you can configure settings for an App-V 5.x package on any version of Windows that InstallShield
supports, building an App-V 5.x package from within InstallShield requires Windows 8 or Windows Server 2012. Attempting
to build an App-V 5.x package on an earlier version of Windows causes build error -9424.

The Microsoft App-V Assistant is available in the Premier Edition of InstallShield.

For information, see:

• Components of an App-V Package

• Build Output for App-V Packages

New Property Comparison Type of Condition Check; New Property for Determining the Install Mode for
Suite/Advanced UI and Advanced UI Projects
When you are building a conditional statement for an exit, detection, eligibility, or feature condition in a Suite/Advanced UI
or Advanced UI project, or for an action in a Suite/Advanced UI project, you can select from a number of different types of
checks that you want to be evaluated on target systems. Use the new Property Comparison type of condition check to
check the value of a particular built-in Advanced UI or Suite/Advanced UI property, or a property that is defined in the
Property Manager view.

In addition, a new read-only property called ISInstallMode is now available. This property stores a value that indicates the
mode (first-time installation, maintenance/UI maintenance selection, modify, remove, repair, or stage only) in which the
Suite/Advanced UI or Advanced UI installation is running. You can use this property in conditional statements that you
configure in your project.

For more information, see:

• Types of Condition Checks in Advanced UI and Suite/Advanced UI Projects

• Property Comparison Condition Settings

148 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Advanced UI and Suite/Advanced UI Property Reference

Ability to Build Pure 64-Bit .msi and .msm Packages; New Build-Time Architecture Validation
Windows Server Core supports disabling 32-bit Windows-on-Windows (WOW64) support. As this configuration becomes
more popular, you may want to ensure that your 64-bit applications can install without any reliance on 32-bit functionality.
To make this possible, InstallShield now enables you to build pure 64-bit .msi packages; these can be run on 64-bit
Windows-based systems that do not have WOW64 functionality. You can also build pure 64-bit merge modules and include
them in InstallShield projects that have 64-bit support. If your installation or merge module project targets a pure 64-bit
environment and includes support that requires any built-in InstallShield custom action DLLs, InstallShield includes new
64-bit versions of these DLLs in your releases at build time.

InstallShield now has architecture validation that you can use when building a release in InstallShield. Architecture
validation enables you to detect potentially problematic cases in which your installation may try to install product files or
use run-time binaries that may not match the architecture of a target system.

For example, if end users may run your installation on 64-bit target systems that do not have WOW64 support, architecture
validation can help you identify any 32-bit product files or 32-bit custom action files in your installation. In addition, if you
are mixing 64-bit and 32-bit product files (or 64-bit and 32-bit custom actions) in a single project and generating separate
32-bit and 64-bit .msi packages, you can use architecture validation to identify any 64-bit product or custom action files in
your 32-bit releases, since these files cannot be loaded on 32-bit target systems.

To specify what type of architecture validation you want to use and identify whether you want to build a pure 32-bit or 64-
bit package, use the new Architecture Validation setting, which is available on the General tab when you select a product
configuration in the Releases view. Two types of validation are available: strict and lenient.

Strict validation may trigger build errors if the architecture that the Template Summary property specifies does not match
the architecture for one or more of the custom action files that are being included in the release. This type of validation
may also trigger build warnings if the architecture that the Template Summary property specifies does not match the
architecture for one or more of the product files that are being included in the release.

Lenient architecture validation, which is the default type of validation, does not trigger build errors or warnings if the
architecture that the Template Summary property specifies does not match the architecture for one or more of the product
files or the custom action files that are being included in the release.

The automation interface includes support for the new architecture validation support. The ISWiProductConfig object
includes a new read-write ArchitectureValidation property that lets you specify the type of architecture validation that you
want to use for a product configuration.

This feature is available in the following project types: Basic MSI and Merge Module.

To learn more, see:

• Selecting the Appropriate Type of Architecture Validation for Builds

• Targeting 64-Bit Operating Systems

• Using the Template Summary Property

• ISWiProductConfig Object

Validation for the Windows 8 Logo Program

InstallShield includes two new validation suites: InstallShield Validation Suite for Windows 8 and InstallShield Merge
Module Validation Suite for Windows 8. These validation suites contain several new InstallShield internal consistency
evaluators (ISICEs): ISICE21 through ISICE26. The suites can help you verify whether your Windows Installer–based

InstallShield 2020 User Guide ISP-2600-UG00 149

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

installation or merge module meets the installation requirements of the Windows 8 Desktop App Certification Program. If
you want to be able to use the Windows 8 logo artwork, your product’s installation must meet the program’s requirements.
These suites can also help you verify that your installation or merge module will work on Windows Server 2012 systems.

If you want to configure InstallShield to perform validation with these validation suites each time that a release is
successfully built: On the Tools menu, click Options. On the Validation tab, select the appropriate check boxes.

If you want to perform validation separately from the build process: On the Build menu, point to Validation, and then click
the appropriate new suite.

For more information, see the following:

• Validating Projects

• ISICEs

• Requirements for the Windows Logo Program

Improvements for Configuring Shortcuts on the Latest Platforms; InstallScript Language Improvements
for Shortcut Creation
InstallShield offers enhancements for configuring shortcuts in your projects.

Support for Preventing a Shortcut from Being Pinned to the Windows 8 Start Screen

InstallShield lets you specify whether you want each shortcut in your installation to be pinned by default to the Start screen
on Windows 8 target systems. You may want to disable pinning for shortcuts that are for tools and secondary products that
are part of your installation. If you disable pinning for a shortcut, the shortcut is still available in the Apps list that contains
shortcuts to all of the applications on the system.

To prevent Start Screen pinning for a shortcut, use the new Pin to Windows 8 Start Screen setting for a shortcut in the
Shortcuts view.

This feature is available for the following project types: Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI
Database, MSM Database, and Transform.

The automation interface includes support for specifying whether you want a shortcut to be pinned to the Windows 8 Start
screen. The ISWiShortcut object includes a new read-write Boolean EnableWin8StartPin property that indicates whether
the shortcut is configured to be pinned by default to the Start screen on Windows 8 target systems.

To learn more, see:

• Suppressing Initial Pinning of a Shortcut to the Windows 8 Start Screen

• Shortcuts View

• ISWiShortcut Object

Support for Preventing End Users from Pinning a Shortcut to the Taskbar or Start Menu

For each shortcut in your installation, InstallShield lets you specify whether you want to let end users pin the shortcut to
the taskbar or to the Start menu. If you want to prevent this type of pinning, the installation sets a property that hides the
context menu commands for pinning the shortcut to the taskbar and the Start menu. You may want to prevent pinning for
shortcuts that are for tools and secondary products that are part of your installation.

Support for preventing end users from pinning a shortcut to the taskbar or Start menu varies, depending on the project
type that you are using.

150 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects: To prevent
taskbar and Start menu pinning for a shortcut, use the Shell Properties setting for a shortcut in the Shortcuts view. This
setting has a new Prevent Pinning option that lets you disable pinning for the selected shortcut. Windows Installer 5
includes support for this shortcut setting. Previously, it was necessary to manually enter the appropriate property name
and value to configure this behavior.

In InstallScript projects: To prevent taskbar and Start menu pinning for a shortcut, use the new Prevent Pinning setting in
the Shortcuts view. Windows 7 and later include support for this shortcut setting. Previously, InstallShield did not have
support for configuring this functionality in InstallScript projects.

The automation interface includes support for specifying whether you want the context menu commands for pinning a
shortcut to the taskbar and to the Start menu to be displayed after end users install your product. The ISWiShortcut object
includes a new read-write Boolean PreventPinning property that indicates whether the shortcut is configured to hide the
context menu commands for pinning.

For more information, see:

• Specifying Whether End Users Should Be Able to Pin a Shortcut to the Taskbar or Start Menu

• Shortcuts View

• ISWiShortcut Object

Support for Preventing a Shortcut on the Start Menu from Being Highlighted as Newly Installed

InstallShield lets you optionally prevent a shortcut on the Start Menu from being highlighted as newly installed after end
users install your product. This has the same effect as clearing the Highlight newly installed programs check box in the
Customize Start Menu dialog box for an individual item on a target system. You may want to set this property for shortcuts
that are for tools and secondary products that are part of your installation.

Support for the highlighting behavior varies, depending on the project type that you are using.

In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects: To prevent the
highlighting behavior for a shortcut, use the Shell Properties setting for a shortcut in the Shortcuts view. This setting has a
new Do Not Highlight as New option that lets you disable highlighting for the selected shortcut. Windows Installer 5
includes support for this shortcut setting. Previously, it was necessary to manually enter the appropriate property name
and value to configure this behavior.

In InstallScript projects: To prevent the highlighting behavior for a shortcut, use the new Do Not Highlight as New setting in
the Shortcuts view. Windows 7 and later include support for this shortcut setting. Previously, InstallShield did not have
support for configuring this functionality in InstallScript projects.

The automation interface includes support for specifying whether you want a shortcut to be highlighted on the Start menu
as new after end users install the product. The ISWiShortcut object includes a new read-write Boolean
DoNotHighlightAsNew property that indicates whether you want to prevent the highlighting.

To learn more, see:

• Preventing a Shortcut on the Start Menu from Being Highlighted as Newly Installed

• Shortcuts View

• ISWiShortcut Object

InstallShield 2020 User Guide ISP-2600-UG00 151

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Built-in Support for Configuring Additional Windows Shell Properties for a Shortcut

InstallShield lets you specify one or more additional shortcut properties that need to be set by the Windows Shell at run
time. The properties that the Shell can set are defined in propkey.h, which is part of the Windows SDK.

To configure additional properties for a shortcut, use the Shell Properties setting for a shortcut in the Shortcuts view. This
setting has a new Custom Property option that lets you specify additional properties and their corresponding values for the
selected shortcut.

Windows Installer 5 includes support for configuring Shell properties.

The automation interface includes a new ISWiShellProperty object for custom Windows Shell properties for a shortcut. In
addition, the ISWiShortcut object includes two new methods and a collection that let you add a Shell property
(AddShellProperty), delete a Shell property (DeleteShellProperty), and retrieve the collection of Shell properties
(ISWiShellProperties) for a shortcut.

This support is available in the following project types: Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM
Database, and Transform.

To learn more, see:

• Setting Custom Shell Properties

• Shortcuts View

• ISWiShellProperty Object

• AddShellProperty Method

• DeleteShellProperty Method

• ISWiShellProperties Collection

• ISWiShortcut Object

InstallScript Language Improvements for Setting a Shortcut Property, and for Other Shortcut Functionality

A new InstallScript function called SetShortcutProperty is available. You can use this function in your InstallScript code to
set Windows Shell properties for a shortcut. The function lets you prevent end users from pinning a shortcut to the
Windows 8 Start screen, prevent end users from pinning a shortcut to the taskbar or Start menu on Windows 7 or later
systems, or prevent a shortcut on the Start menu from being highlighted as newly installed on Windows 7 or later systems.
You can also use this function to specify additional Shell properties that are defined in propkey.h, which is part of the
Windows SDK.

The InstallShield Cabinet and Log File Viewer has been updated to reflect the state of the aforementioned Shell properties.

To reflect the current operating system terminology, some of the existing shortcut functions have been renamed. Note that
the old function names will continue to compile and run as they did with earlier versions of InstallShield. The new
InstallScript functions are:

• CreateShortcut—This function supersedes AddFolderIcon. CreateShortcut accepts the same parameters as

AddFolderIcon but adds or replaces the following options for the nFlag parameter:

• CS_OPTION_FLAG_REPLACE_EXISTING

• CS_OPTION_FLAG_RUN_MAXIMIZED

• CS_OPTION_FLAG_RUN_MINIMIZED

• CS_OPTION_FLAG_PREVENT_PINNING

152 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• CS_OPTION_FLAG_NO_NEW_INSTALL_HIGHLIGHT

• CS_OPTION_FLAG_NO_STARTSCREEN_PIN

• CreateShortcutFolder—This function supersedes CreateProgramFolder. Both functions use the same parameters.

• DeleteShortcut—This function supersedes DeleteFolderIcon. Both functions use the same parameters.

• DeleteShortcutFolder—This function supersedes DeleteProgramFolder. Both functions use the same parameters.

• GetShortcutInfo—This function supersedes QueryProgItem. Both functions use the same parameters.

• ReplaceShortcut—This function supersedes ReplaceFolderIcon. ReplaceShortcut accepts the same parameters as

ReplaceFolderIcon but adds or replaces the same options for the nFlag parameter as CreateShortcut.

For more details, see the following:

• CreateShortcut

• CreateShortcut Examples

• CreateShortcutFolder

• CreateShortcutFolder Example

• DeleteShortcut

• DeleteShortcut Example

• DeleteShortcutFolder

• DeleteShortcutFolder Example

• GetShortcutInfo

• GetShortcutInfo Example

• ReplaceShortcut

• ReplaceShortcut Example

• SetShortcutProperty

• SetShortcutProperty Example

Usability Improvements for Customizing the Wizard Interface in Advanced UI and Suite/Advanced UI
Projects

No More Confusing Syntax Requirements

Various UI settings in the Wizard Interface view in Advanced UI and Suite/Advanced UI projects have been improved to
make it much easier to customize the wizard interface of Advanced UI and Suite/Advanced UI installations. For example,
the following settings, which are displayed when a wizard page or wizard control is selected in the Wizard Interface view,
have been improved:

• Visible—This setting lets you specify one or more conditions that the Advanced UI or Suite/Advanced UI installation
should use to evaluate whether the selected page or control should be displayed.

• Enabled—This setting lets you specify one or more conditions that the Advanced UI or Suite/Advanced UI installation
should use to evaluate whether the selected control should be enabled.

InstallShield 2020 User Guide ISP-2600-UG00 153

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Validate—This setting lets you specify one or more validation statements that the Advanced UI or Suite/Advanced UI
installation should use to validate an end user’s response to a control. For example, you can use this setting to specify
the format that end users should use for entering a serial number in a text box control.

• Action—Each instance of this setting has been renamed to better reflect the specific type of trigger that is applicable
to the selected control. For example, the Action setting for a list box control has been renamed Selection Changed.
The Action setting for a button has been renamed Click. The renamed settings let you select one or more actions that
you want to be triggered when an end user uses the selected control.

Now those settings contain drop-down lists and buttons that are similar to the ones that are available in other areas of
Advanced UI and Suite/Advanced UI projects for quickly building conditional statements. These settings now make it easy
to quickly configure visible/hidden status, enabled/disabled status, validation, and action responses for various parts of
the UI, and to build conditional statements for that behavior if appropriate. Previously, these settings were edit fields that
required manually entry of statements using a difficult-to-remember syntax.

For more information, see:

• Configuring Validation for a Control on a Wizard Page or Window

• Configuring an Action for an Element in the Wizard Interface

• Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects

Built-In Support for Using Only One Background for the Header, Body, and Navigation Areas of the Wizard Interface

The Wizard Pages node in the Wizard Interface view has a new Full Wizard Background setting. This setting lets you specify
a single background that you want to use across the header, body, and navigation areas of your wizard pages. Previously,
the only built-in way to specify backgrounds in InstallShield was to use separate background styles in the Default Body
Background, Header Background, and Navigation Background settings. If you wanted to use a single background across all
three areas of the wizard interface, you had to use the process that was documented in an InstallTalk blog article; the
process involved modifying the InstallShield project file (.issuite) in a text editor.

Note that if you select a background in this new Full Wizard Background setting, you should delete any values from the
other background settings: Default Body Background, Header Background, and Navigation Background.

To learn more, see Specifying the Background Brush for the Header, Body, and Navigation Areas of the Wizard Interface.

Ability to Specify a Global Text Style for All Navigation Buttons

The Wizard Pages node in the Wizard Interface view has a new Navigation Text Style setting. This setting lets you select a
single text style that you want to use for the text on all of the navigation buttons. You can override the global text style for
individual navigation buttons as needed.

Logically Organized Setting Grids

In the Wizard Interface view, the setting grids for wizard pages, secondary windows, and wizard controls have been
reorganized to make it easier to find the settings that are needed for customizing the wizard interface.

Support for Defining Font Sets with Optional Language-Specific Choices for Advanced UI and Suite/
Advanced UI Projects
Advanced UI and Suite/Advanced UI projects have support for a new kind of wizard interface style: a font set. A font set is a
collection of fonts (including attributes such as font name, size, and weight). For each font in a font set, you can specify to
which language the font is applicable. This enables you to select a different font for each language that your project
supports.

154 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Font sets work in conjunction with text styles. Text styles, which are styles that define text attributes such as text color and
alignment, now reference a font set but can optionally override various font attributes that are defined at the font set level.

Thus, for example, when you are specifying font information for the body text of your wizard interface, you can use a font
set called BodyFonts, and specify a different font for each of the languages that your project supports. You can then select
the BodyFonts font set for various text styles—Body, Header, and BodyBold—but with special overrides for smaller sizes
and bold where necessary. This enables you to specify a large set of possible fonts once, and change attributes such as text
size or color for specific wizard interface uses.

To learn more, see:

• Using Styles, Brushes, and Control Themes to Customize the Wizard Interface

• Defining a Custom Style for the Wizard Interface

Enhancements
InstallShield includes the following enhancements.

New Services View

InstallShield has a new Services view—under the System Configuration node of the View List—that lets you specify the
required information about a Windows service that you are installing, starting, configuring, stopping, or deleting at run
time.

This new Services view has been added to make it easier for new users to configure services. The view provides the same
functionality as the following existing areas:

• The Services area under the Advanced Settings node for a component in the Setup Design view (of installation
projects)

• The Services area under the Advanced Settings node for a component in the Components view

If you configure service information in any of the three views (the Services view, the Setup Design view, or the Components
view), the other views are updated automatically.

The Services view is available in the following project types: Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database,
MSM Database, and Transform.

For more information, see:

• Installing, Controlling, and Configuring Windows Services

• Services View

New Wizard Format for the Suite/Advanced UI and Advanced UI Wizard Interface
A new Glass wizard format is available for the wizard interface of Suite/Advanced UI and Advanced UI installations. This
new format is similar to the existing Aero format. For both formats, the installation uses user-chosen system colors (instead
of brush styles that you defined in your project) to display the caption bar, header, and navigation areas of the wizard
interface. It also may use the glass effect (translucency) for these same areas of the wizard interface on target systems that
have the translucency support that was introduced in Windows Vista.

In some scenarios, an installation uses the Wizard 97 format instead of the Glass or Aero formats:

• Windows 8 and Windows Server 2012 systems do not have translucency support. On these systems, a Glass-formatted
wizard interface uses the Wizard 97 format. However, an Aero-formatted wizard interface uses Aero (which includes
user-chosen system colors), but without the glass effect.

InstallShield 2020 User Guide ISP-2600-UG00 155

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Windows 7, Windows Vista, Windows Server 2008 R2, and Windows Server 2008 have translucency support that end
users can enable or disable. On these systems, Glass-formatted wizard interfaces and Aero-formatted wizard
interfaces use the Wizard 97 format if translucency is disabled. These wizard interfaces also use the Wizard 97 format if
the desktop composition feature on the target system is disabled.

• On Windows XP and Windows Server 2003, Glass-formatted wizard interfaces and Aero-formatted wizard interfaces
use the Wizard 97 format.

To configure the format, use the Wizard Format setting that is displayed in the Wizard Interface view when the Wizard
Pages node is selected. The Glass format is the default option for all new Suite/Advanced UI and Advanced UI projects.

For more information, see Selecting the Format for the Wizard Interface.

Automation Interface Enhancement: New OnUpgrade Property for Minor Upgrades and Small Updates
A new read-write OnUpgrade property has been added to the ISWiProject object in the automation interface. You can set
this property to one of the supported values to specify whether you want the installation to display a prompt before
installing a minor upgrade or a small update.

This property corresponds with the Small/Minor Upgrade Settings options on the Common tab in the Upgrades view.

For more information, see ISWiProject Object.

See Also
Upgrading Projects from InstallShield 2012 Spring or Earlier
What’s New in InstallShield 2013 SP1

What’s New in InstallShield 2012 Spring SP1

InstallShield 2020

InstallShield 2012 Spring Service Pack 1 (SP1) includes changes that offer support for the final released versions of
Windows 8, Windows Server 2012, and Visual Studio 2012. It also includes additional changes.

Important • If you want to open an InstallShield 2012 Spring Advanced UI or Suite/Advanced UI project (.issuite) in
InstallShield 2012 Spring SP1, you must allow InstallShield to upgrade your project to InstallShield 2012 Spring SP1.
InstallShield 2012 Spring SP1 Advanced UI and Suite/Advanced UI projects include support for functionality that was not
available in these project types in InstallShield 2012 Spring, and this support needs to be added during the upgrade. Note that
it is not possible to open InstallShield 2012 Spring SP1 Advanced UI or Suite/Advanced UI projects in earlier versions of
InstallShield (including InstallShield 2012 Spring without SP1). Therefore, if multiple users need to open and modify your
InstallShield projects, ensure that all of you apply the SP1 patch at the same time.

If you open an InstallShield 2012 Spring Advanced UI or Suite/Advanced UI project in InstallShield 2012 Spring SP1,
InstallShield 2012 Spring SP1 displays a message box that asks you if you want to convert the project to the new version. If you
reply that you do want to convert it, InstallShield creates a backup copy of the project before converting it.

Support for Adding Sideloading Windows App Packages (.appx) to Suite/Advanced UI

Projects
InstallShield now lets you add sideloading Windows App packages (.appx) to a Suite/Advanced UI project. You can add this
package type through the Packages view of the Suite/Advanced UI project just as you would add other types of packages to
the project.

156 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Sideloading an app is the process of installing an app without obtaining it through the Windows Store. This type of app is
sometimes distributed to enterprise environments. Windows 8 and Windows Server 2012 include support for sideloading
apps.

This support is available in the Premier edition of InstallShield.

Note that support for creating and building Suite/Advanced UI installations that include sideloading Windows App
packages requires Windows Vista or later or Windows Server 2008 or later on the machine that has InstallShield or the
Standalone Build.

For more information, see:

• Adding a Sideloading Windows App Package (.appx | .msix) to a Suite/Advanced UI Project

• Packages View

New Windows App Package Type of Condition Check in Suite/Advanced UI and

Advanced UI Projects
When you are building a conditional statement for an exit, detection, eligibility, or feature condition in a Suite/Advanced UI
or Advanced UI project, you can select from a number of different types of checks that you want to be evaluated on target
systems. Use the new Windows App Package type of condition check to check target systems for the presence of a
particular Windows App package. The condition checks for a particular app name, and it can also check other information,
such as the version.

For more information, see:

• Types of Condition Checks in Advanced UI and Suite/Advanced UI Projects

• Windows App Package Condition Settings

• Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects

Support for Visual Studio 2012, .NET Framework 4.5, and Visual C++ 2012
InstallShield includes changes that offer support for the final released version of Visual Studio 2012, enabling development
of installations and products within this version of the Visual Studio interface.

In addition, InstallShield includes two updated InstallShield prerequisites for the .NET Framework and two new
InstallShield prerequisites for Visual C++:

• Microsoft .NET Framework 4.5 Full

• Microsoft .NET Framework 4.5 Web

• Microsoft Visual C++ 2012 Redistributable Package (x86)

• Microsoft Visual C++ 2012 Redistributable Package (x64)

You can add any of these prerequisites to Advanced UI, Basic MSI, InstallScript, InstallScript MSI, and Suite/Advanced UI
projects.

The Web prerequisite for the .NET Framework requires an Internet connection. This prerequisite downloads the required
redistributable files if appropriate. The full prerequisite is a stand-alone installation that does not require an Internet
connection.

InstallShield 2020 User Guide ISP-2600-UG00 157

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Additional Changes
For a list of issues that are resolved in InstallShield 2012 Spring SP1, see the release notes. The release notes are available
from the Help menu in InstallShield.

What’s New in InstallShield 2012 Spring

InstallShield 2020

New Features
InstallShield includes the following new features.

Ability to Target Windows 8 and Windows Server 2012 Systems

InstallShield enables you to specify that your installation requires Windows 8 or Windows Server 2012. It also lets you build
feature and component conditions for these operating systems.

The InstallShield prerequisites that should be installable on Windows 8 and Windows Server 2012 have been updated so
that they are installed on those systems if needed. Previously, the prerequisites were not run by default on those systems.
This applies to the following InstallShield prerequisites:

• FSharp Redistributable Package 2.0

• Microsoft ReportViewer 2010

• Microsoft SQL CE 3.5 SP2

• Microsoft SQL Server 2005 Express SP3

• Microsoft SQL Server 2008 Express SP1

• Microsoft SQL Server 2008 Management Objects 10.00.2531

• Microsoft SQL Server 2008 Native Client 10.00.2531

• Microsoft SQL Server 2008 R2 Express RTM

• Microsoft SQL Server 2008 R2 Native Client 10.50.1600.1

• Microsoft SQL Server Native Client 9.00.4035

• Microsoft SQL Server System CLR Types 10.00.2531

• Microsoft Visual C++ 2005 SP1 Redistributable MFC Security Update KB2538242

• Microsoft Visual C++ 2005 SP1 Redistributable Package

• Microsoft Visual C++ 2008 SP1 Redistributable MFC Security Update KB2538243

• Microsoft Visual C++ 2008 SP1 Redistributable Package

• Microsoft Visual C++ 2010 Redistributable Package

• Microsoft Visual C++ 2010 RTM Redistributable MFC Security Update KB2467173

• Microsoft Visual C++ 2010 SP1 Redistributable Package

• Microsoft VSTO 2010 Runtime

158 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Support for a New Contemporary, Customizable End-User Interface in InstallShield Professional Edition
The new Advanced UI project type lets you create a new end-user interface, with redesigned, contemporary wizard pages,
for a Windows Installer package or an InstallScript package. This new project type is available in the Professional edition of
InstallShield, and it is based on the technology that was previously introduced as the Suite project type (now known as the
Suite/Advanced UI project type) in the Premier edition of InstallShield.

The new Advanced UI project type includes built-in wizard pages that you can include and customize in your Advanced UI
installations. The wizard page editor in this project type lets you add, sequence, and remove pages as needed; it also lets
you modify the layout of any page—adding, moving, and removing a variety of different kinds of controls. All of the new UI
functionality that was previously available only through the Premier edition is now available through Advanced UI projects.

Like Suite/Advanced UI projects, an Advanced UI project uses the next-generation setup launcher (Setup.exe) for
launching a package on target systems. Also like Suite/Advanced UI projects, an Advanced UI project includes flexible
options for specifying the run-time source location of the package that you are including in the Advanced UI installation.
The available location options are:

• On the Web, available for download by Setup.exe if needed

• Embedded in Setup.exe and extracted to the target system if needed

• Uncompressed and stored on the Advanced UI source media

Your end users can quickly download a small Advanced UI Setup.exe file, and the Setup.exe file can download and launch
the Windows Installer–based or InstallScript package if needed.

Note that the Advanced UI project type includes support for including only one primary .msi package, one primary .msp
package, or one primary InstallScript package. The Suite/Advanced UI project type that is available in the Premier edition
of InstallShield includes support for packaging multiple primary installations (including .exe packages) as a single
installation.

To learn more, see the following:

• Creating Advanced UI and Suite/Advanced UI Installations

• Advanced UI Projects vs. Suite/Advanced UI Projects

• Adding an .msi Package, an .msp Patch, or a Transaction to an Advanced UI or Suite/Advanced UI Project

• Working with the Wizard Interface

Microsoft Windows Azure SQL Database Support

InstallShield now includes support for running SQL scripts on Microsoft Windows Azure SQL database servers. In addition,
InstallShield includes Microsoft Windows Azure in the predefined list of database servers that you can select when you are
specifying in the SQL Scripts view the target database servers that your product supports.

If your installation targets Windows Azure, the SQLBrowse run-time dialog that is displayed when end users choose to
browse for a database catalog can now list catalogs on the specified SQL database server.

This support is available in the following project types: Basic MSI, DIM, InstallScript, and InstallScript MSI.

To learn more, see:

• Connecting to a Microsoft Windows Azure Database Server and Running SQL Scripts

• Configuring SQL Support

• SQL Scripts View

InstallShield 2020 User Guide ISP-2600-UG00 159

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

This support is available in the following project types: Basic MSI, DIM, InstallScript, and InstallScript MSI.

Beta Support for Microsoft Visual Studio 2012

InstallShield includes support for the beta of Visual Studio 2012. You can create InstallShield projects from within this
version of Visual Studio.

Microsoft .NET Framework 4.5 Prerequisites

InstallShield includes two new .NET-related InstallShield prerequisites that you can add to Basic MSI, InstallScript, and
InstallScript MSI projects:

• Microsoft .NET Framework 4.5 Full

• Microsoft .NET Framework 4.5 Web

These InstallShield prerequisites install the beta versions of the .NET Framework 4.5 on supported target systems.

The Web prerequisite requires an Internet connection. This prerequisite downloads the required redistributable files if
appropriate. The full prerequisite is a stand-alone installation that does not require an Internet connection.

Microsoft SQL Server 2012 Support

InstallShield now includes support for running SQL scripts on SQL Server 2012 database servers. In addition, InstallShield
includes SQL Server 2012 in the predefined list of database servers that you can select when you are specifying in the SQL
Scripts view the target database servers that your product supports.

If your installation targets SQL Server 2012, the SQLBrowse run-time dialog that is displayed when end users choose to
browse for a database server can now list instances of SQL Server 2012, SQL Server 2012 Express, and SQL Server 2012
Express LocalDB. In addition, the SQLBrowse run-time dialog that is displayed when end users choose to browse for a
database catalog can now list catalogs on the specified SQL Server 2012 database server.

To learn more, see:

• Requirements for Connecting to Instances of SQL Server Express LocalDB

• Configuring SQL Support

• SQL Scripts View

This support is available in the following project types: Basic MSI, DIM, InstallScript, and InstallScript MSI.

Microsoft SQL Server 2012 Prerequisites

InstallShield includes several new SQL Server 2012–related InstallShield prerequisites that you can add to Basic MSI,
InstallScript, and InstallScript MSI projects:

• Microsoft SQL Server 2012 Express

• Microsoft SQL Server 2012 Express LocalDB

• Microsoft SQL Server 2012 Native Client

InstallShield also includes InstallShield prerequisites that install Microsoft .NET Framework 3.5 SP1 Update KB956250,
which is a dependency of Microsoft SQL Server 2012 Express.

These InstallShield prerequisites install the technology on supported target systems.

160 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New InstallShield Prerequisites for App-V 4.6 SP1, SQL Server Compact 4.0, and JRE SE 1.7
InstallShield includes new InstallShield prerequisites that you can add to Basic MSI, InstallScript, and InstallScript MSI
projects:

• Java Runtime Environment Second Edition (JRE SE) 1.7

• Microsoft App-V 4.6 SP1 Desktop Client (The redistributable files for these InstallShield prerequisites—available in 32-
bit and 64-bit versions—are not available for download from within InstallShield, since you must obtain them from
Microsoft. Once you obtain them from Microsoft, place them in the location that is displayed when you are editing
these prerequisites in the InstallShield Prerequisite Editor.)

• SQL Server Compact 4.0

These InstallShield prerequisites install the technology on supported target systems.

Support for the Configuring System Center 2012 Configuration Manager Application Model Data
Accurate identification of deployment metadata is necessary for migrating applications into the System Center 2012
Configuration Manager application model. InstallShield includes several new settings in the General Information view that
let you specify some of the application model metadata for an application through a software identification tag. When
AdminStudio users import a package into the AdminStudio Application Catalog, AdminStudio Application Manager mines
package elements for deployment data such as detection methods, dependencies, requirements, as well as information in
the software identification tag. AdminStudio makes this information available to users for review and tests before
publishing to Microsoft System Center 2012 Configuration Manager.

This feature is available in Basic MSI projects.

To learn more, see Including Microsoft System Center Configuration Manager Application Model Data About Your Product.

Support for PowerShell Custom Actions

Windows PowerShell is a .NET Framework–based command-line shell and script language that enables system
administrators to automate system configuration tasks. InstallShield now has support for custom actions that run
PowerShell scripts. You may want to add this type of custom action to a project to perform system configuration tasks at
installation run time.

Note that in order for an installation to run a PowerShell custom action, Windows PowerShell must be installed on target
systems. InstallShield includes a new predefined PowerShell system search that checks for the presence of PowerShell on
target systems. You can include this system search in your project and configure your PowerShell custom action to run only
if the system search determines that PowerShell is installed.

The PowerShell execution policy, which determines whether PowerShell scripts can be run on a target system, is set to
restricted by default, which does not permit PowerShell scripts to be run. If you want your installation to override the
target system’s execution policy with an appropriate one for your installation’s PowerShell custom actions, you can use
the new Windows Installer property IS_PS_EXECUTIONPOLICY to indicate the appropriate execution policy.

This feature is available in the following project types: Basic MSI and InstallScript MSI.

To learn more, see Calling a PowerShell Custom Action.

Automatic Update Check and Download Support for Suite/Advanced UI and Advanced UI Installations
Suite/Advanced UI and Advanced UI installations now have the ability to automatically check for an updated Suite/
Advanced UI or Advanced UI Setup.exe file that you host on your Web site, and download and launch it if it is available. The
updated Suite/Advanced UI or Advanced UI Setup.exe file can be used to deploy upgrades and patches for your latest
Suite/Advanced UI and Advanced UI packages.

InstallShield 2020 User Guide ISP-2600-UG00 161

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The Update tab in the Releases view of Suite/Advanced UI and Advanced UI projects has a new Update URL setting that lets
you specify the absolute path (including the file name) for an updated Suite/Advanced UI or Advanced UI setup launcher. If
the base Suite/Advanced UI or Advanced UI setup launcher is running a non-maintenance operation, the Suite/Advanced
UI or Advanced UI setup launcher checks the update URL for a download. If a download is available, the base Suite/
Advanced UI or Advanced UI setup launcher downloads it and then verifies its digital signature. If the digital signature in
the update setup launcher matches that in the base setup launcher, the update setup launcher runs automatically. If the
digital signature does not match, or if the base setup launcher is not digitally signed, a security warning is displayed,
allowing the end user to choose whether to proceed with the update setup launcher.

To learn more, see Supporting Downloadable Updates for an Advanced UI or Suite/Advanced UI Installation.

Ability to Detect Whether a Specific Version of a Suite/Advanced UI or Advanced UI Installation Is Already

Installed
Suite/Advanced UI and Advanced UI projects now include support for determining whether a particular version of a Suite/
Advanced UI or Advanced UI installation is already installed on target systems. This type of condition check is called a Suite
Installed condition.

InstallShield now includes two Suite Installed conditions in each Suite/Advanced UI and Advanced UI project by default:

• A new Suite Installed exit condition prevents end users from being able to install the current version of the Suite/
Advanced UI or Advanced UI installation over a future newer version of the same Suite/Advanced UI or Advanced UI
installation.

• A new Suite Installed mode condition may prevent the installation from running in first-time installation mode if the
same version of the Suite/Advanced UI or Advanced UI installation is already installed.

These new default conditions are available in all new Suite/Advanced UI and Advanced UI projects. If you upgrade an
InstallShield 2012 Suite project to InstallShield 2020, InstallShield automatically adds these default conditions to the
project.

You can edit the default Suite Installed conditions if necessary. You can also add your own Suite Installed conditions to a
project as needed.

For more information, see:

• Detecting Whether a Specific Version of an Advanced UI or Suite/Advanced UI Installation Is Already Installed

• Triggering Install Mode or Maintenance Mode of an Advanced UI or Suite/Advanced UI Installation

• Suite Installed Condition Settings

• Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects

Ability to Configure Network Sharing of Folders in an Installation

InstallShield now lets you create, modify, and delete network shares to enable file sharing over networks. When you are
configuring a folder in your project, you can indicate that you want to enable network sharing, which is disabled by default.
You can also configure other options such as the name of the share, as well as the maximum number of simultaneous users
who can access the share.

To enable sharing, use the new Sharing tab on the Properties dialog box, which is displayed when you right-click a folder in
the Files and Folders view and then click Properties.

This feature is available in the following project types: Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, and
MSM Database.

162 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more information, see Folder Properties Dialog Box.

New Built-In Custom Action that Terminates Specific Processes

InstallShield includes support for a new kill-process type of custom action. If you add this type of custom action to your
project, you can specify the name or process identifier (PID) of one or more processes that you want to be terminated at
run time, and you can schedule the custom action for immediate or deferred mode.

The procedure for creating this type of custom action involves adding and configuring the custom action in the Custom
Actions and Sequences view of your project, and using the Property Manager view to define a property with the names or
PIDs of the appropriate processes.

This feature is available in the following project types: Basic MSI and InstallScript MSI.

For detailed instructions, see Calling a Kill-Process Custom Action.

Ability to Create Predetermined User Accounts and Groups at Run Time

InstallShield now has built-in support for creating multiple user accounts and corresponding groups at run time without
using logon dialogs. To configure the accounts and groups, define values for the properties ISNetApiLogonUsername,
ISNetApiLogonGroup, and ISNetApiLogonPassword in your project with the user names, groups, and passwords,
respectively. Separate multiple names, groups, or passwords with a tilde enclosed by square brackets: [~].

This feature is available in the following project types: Basic MSI and InstallScript MSI.

To learn more, see Creating Predetermined User Accounts at Run Time.

Ability to Include InstallShield Prerequisites as Packages in Suite/Advanced UI and Advanced UI Projects

InstallShield now lets you import InstallShield prerequisites as .msi and .exe packages into Suite/Advanced UI and
Advanced UI projects. You can import the InstallShield prerequisites that are included with InstallShield, as well as any
custom InstallShield prerequisites that you have created. When you right-click the Packages explorer in the Packages view
and then click the new Import Prerequisite (.prq) command, InstallShield adds to your project an .msi package or an .exe
package, depending on the type of file that is configured to run for the prerequisite. InstallShield also automatically
configures default values for each of the prerequisite package’s settings, based on the settings that are configured in the
.prq file. You can change these settings as needed, just as you can change the settings for packages in your Suite/Advanced
UI or Advanced UI project.

If an InstallShield prerequisite has dependencies (that is, if one or more other .prq files are specified as dependencies in the
InstallShield prerequisite that you are adding to the Suite/Advanced UI or Advanced UI project), InstallShield automatically
adds the dependency prerequisites as separate packages in the Packages explorer.

Previously it was necessary to add the .msi and .exe installations as packages in a Suite project and then manually
configure all of the conditions and settings for each of those packages.

For more information, see Including InstallShield Prerequisites (.prq) in an Advanced UI or Suite/Advanced UI Project.

Ability to Include InstallScript Installations as Packages in Suite/Advanced UI and Advanced UI Projects;

New Suite/Advanced UI– and Advanced UI–Specific InstallScript Events and Functions
InstallShield now lets you add InstallScript installations as packages in Suite/Advanced UI and Advanced UI projects. When
a Suite/Advanced UI or Advanced UI installation launches an InstallScript package, the Suite/Advanced UI or Advanced UI
installation displays its own user interface (UI) while automatically suppressing the UI of the InstallScript package. This
enables you to provide a contemporary UI experience for the installation. The Suite/Advanced UI or Advanced UI
installation also displays progress information for the InstallScript package.

InstallShield 2020 User Guide ISP-2600-UG00 163

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

To make these changes possible, Suite/Advanced UI and Advanced UI installations use several new Suite/Advanced UI–
and Advanced UI–specific InstallScript events and functions by default, and ignores some of the standard InstallScript
events and functions.

New InstallScript Package Support in Suite/Advanced UI and Advanced UI Projects

InstallShield lets you add an InstallScript package to a Suite/Advanced UI or Advanced UI project if the InstallScript
package meets the following requirements:

• The InstallScript package is uncompressed.

• InstallShield 2012 Spring or later is used to build the InstallScript package and the Suite/Advanced UI or Advanced UI
installation.

• The InstallScript package uses an event-based script; it should not use the program...endprogram style script.

For more information, see Adding an InstallScript Package to an Advanced UI or Suite/Advanced UI Project.

New Suite/Advanced UI– and Advanced UI–Specific InstallScript Events and Functions

In a standard InstallScript installation that is launched via the InstallScript Setup.exe file (that is, not launched from a
Suite/Advanced UI or Advanced UI installation), most events are called directly from the OnShowUI event. In a Suite/
Advanced UI or Advanced UI installation that launches an InstallScript package, OnShowUI is replaced with
OnSuiteShowUI. Depending on the installation state (first-time installation, maintenance, or update), OnSuiteShowUI
ignores the UI events such as OnFirstUIBefore and OnFirstUIAfter and instead calls the following events:

• First-time installation—OnSuiteInstallBefore, OnSuiteInstallAfter

• Maintenance—OnSuiteMaintBefore, OnSuiteMaintAfter

• Update—OnSuiteUpdateBefore, OnSuiteUpdateAfter

The InstallScript language includes some new Suite/Advanced UI– and Advanced UI–specific functions that enable
interaction between an InstallScript package and the Suite/Advanced UI installation or the Advanced UI installation that is
running it. For example, InstallScript includes new functions that let you log InstallScript package information to Suite/
Advanced UI and Advanced UI debug logs, set and retrieve Suite/Advanced UI and Advanced UI properties, and pass data
from Suite/Advanced UI and Advanced UI installations to the InstallScript package.

To determine whether the InstallScript installation is running as an InstallScript package in a Suite/Advanced UI or

Advanced UI installation, use the new SUITE_HOSTED variable in your InstallScript code.

New InstallScript Package Type of Condition Check in Suite/Advanced UI and Advanced UI Projects
When you are building a conditional statement for an exit, detection, eligibility, or feature condition in a Suite/Advanced UI
or Advanced UI project, you can select from a number of different types of checks that you want to be evaluated on target
systems. Use the new InstallScript package type of condition check to check target systems for the presence of a product
that was installed by a particular InstallScript installation. The condition checks for a particular product code, and it can
also check other information, such as the product version.

To learn more, see the following:

• Types of Condition Checks in Advanced UI and Suite/Advanced UI Projects

• InstallScript Package Condition Settings

• Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects

164 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Dynamic File Link Support for Package Files in Suite/Advanced UI and Advanced UI Projects
When you are adding or configuring an .msi, .msp, or .exe package in an Advanced UI or Suite/Advanced UI project, you can
indicate whether the package requires additional files that are located near the package file. For example, if a package that
you are adding is an uncompressed .msi package, you may need to include other files—such as .cab files and
uncompressed data files in nearby subfolders—along with the package file.

InstallShield now lets you use dynamic links for the additional package files. Dynamic links are useful if the list of additional
files that the package requires is likely to change between builds. InstallShield scans the source folder before every build
and automatically incorporates any new or changed package files in your release.

InstallShield also lets you define filters that control which additional files InstallShield should include in the dynamic link at
build time, and which ones InstallShield should exclude. You can change the order in which InstallShield evaluates any
filter criteria that you have defined for a dynamic link. Each time that you build your Advanced UI or Suite/Advanced UI
installation, InstallShield includes the appropriate additional files based on the dynamic link’s filters.

Previously, only static links could be used for additional files. If the list of additional files changed between builds, it was
necessary to manually update the list of package files.

For more information, see:

• Static vs. Dynamic Files for Packages in an Advanced UI or Suite/Advanced UI Project

• Creating a Dynamic Link in an Advanced UI or Suite/Advanced UI Project

• Defining Filters for a Dynamically Linked Folder in an Advanced UI or Suite/Advanced UI Project

Ability to Give Enhanced Feedback When Validating End-User Input During a Suite/Advanced UI or
Advanced UI Installation
Suite/Advanced UI and Advanced UI installations now have support for providing enhanced feedback when validating end-
user input at run time. Various interface controls in the Wizard Interface view of a Suite/Advanced UI project and an
Advanced UI project have three new subsettings under the existing Text Style setting: Default, Valid, and Invalid. You can
configure these subsettings to select different text styles that you want the Suite/Advanced UI or Advanced UI installation
to use under different circumstances.

Support for Creating Package Log Files When Launching a Suite/Advanced UI or Advanced UI Installation
from the Command Line
When you are configuring the settings for a package in a Suite/Advanced UI or Advanced UI project, you can use the new
Enable Logging Support setting to specify whether you want the package to generate a log file if the Suite/Advanced UI or
Advanced UI installation is launched from the command line with the new /log command-line parameter. Depending on
the type of package (.msi package, .msp package, or some other type of package), you can also configure one or two other
settings to specify information such as which log options you want the Suite/Advanced UI or Advanced UI installation to
pass to the package when the log file is being created.

The new /log command-line parameter for the Suite/Advanced UI or Advanced UI Setup.exe file lets you specify the path
to the directory that contains the package log files. If a path is not specified with the /log parameter, the Suite/Advanced
UI or Advanced UI installation creates the package log files in the %TEMP% directory.

The new property ISLogDir in Suite/Advanced UI and Advanced UI installations stores the path to that directory that
contains the package log files.

Previously, the only way to enable logging for a Windows Installer–based package in a Suite installation was to use the
logging system policy or the MsiLogging property.

For more information, see:

InstallShield 2020 User Guide ISP-2600-UG00 165

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Supporting the Creation of Package Log Files for Command-Line Launching of an Advanced UI or Suite/Advanced UI
Installation

• Advanced UI and Suite/Advanced UI Setup.exe Command-Line Parameters

• Advanced UI and Suite/Advanced UI Property Reference

Support for 64-Bit Components in InstallScript Installations

InstallScript projects now have support for installing files to WINSYSDIR64 (the InstallScript variable that maps to the 64-bit
System32 folder), and for installing registry data to the 64-bit registry locations, without requiring you to modify your
InstallScript code. If you have files or registry data that need to be installed to these 64-bit locations, you can add the files
and registry data to a component, and select Yes for that component’s new 64-Bit Component setting. At run time, the
installation automatically disables file system redirection for the component’s System32 files, and it prevents redirection
for the component’s 64-bit registry data.

Previously, to install files to WINSYSDIR64, it was necessary to override the Installing and Installed events for features that
contained components that installed to that location. In the Installing event, it was necessary to use the
WOW64FSREDIRECTION constant with the Disable function to disable file system redirection; in the Installed event, it was
necessary to use WOW64FSREDIRECTION with the Enable function to re-enable file system redirection for other parts of
the installation. The same sort of disabling and enabling was necessary for the UnInstalling and UnInstalled events to
ensure that those files were removed correctly during uninstallation.

If file system redirection is not disabled when an InstallScript installation installs to WINSYSDIR64, 64-bit Windows
automatically redirects the file transfers to the 32-bit System32 folder (SysWOW64).

Also previously, to install registry data to a 64-bit area of the registry, it was necessary to use the InstallScript registry
functions to create registry data with REGDB_OPTION_WOW64_64KEY set in REGDB_OPTIONS. Then it was necessary to
use REGDB_OPTION_USE_DEFAULT_OPTIONS with REGDB_OPTIONS to re-enable registry redirection for other parts of
the installation.

If registry redirection is not disabled when an InstallScript installation installs to a 64-bit registry location
(HKEY_LOCAL_MACHINE\Software), 64-bit Windows automatically redirects the registry changes to the equivalent 32-bit
registry location (HKEY_LOCAL_MACHINE\Software\Wow6432Node).

The InstallScript log files (.ilg) that InstallScript installations create at run time when installing a product now use a new
OPTYPE_FILE64 type to identify files that are installed when file system redirection is disabled. The InstallScript log files
use the existing OPTYPE_REGISTRY64 type to identify registry data that are installed when registry redirection is disabled.
You can see these OPTYPE_FILE64 and OPTYPE_REGISTRY64 types when viewing an .ilg file in the InstallShield Cabinet and
Log File Viewer.

For more information, see the following:

• Targeting 64-Bit Operating Systems with InstallScript Installations

• Component Settings

• WINSYSDIR64

• REGDB_OPTIONS

• InstallShield Cabinet and Log File Viewer

166 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New Locale Type of Condition Check in Suite/Advanced UI and Advanced UI Projects

When you are building a conditional statement for an exit, detection, eligibility, or feature condition in a Suite/Advanced UI
or Advanced UI project, you can select from a number of different types of checks that you want to be evaluated on target
systems. Use the new locale type of condition check to check for matching one or more locale-related settings on target
systems.

To learn more, see:

• Using Locale Conditions in Advanced UI and Suite/Advanced UI Projects

• Types of Condition Checks in Advanced UI and Suite/Advanced UI Projects

• Locale Condition Settings

• Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects

New Wizard Interface Toolbar for Editing the Layout in Suite/Advanced UI and Advanced UI Projects,
with Support for Switching Languages in Suite/Advanced UI Projects
If you select a wizard page or secondary window in the Wizard Interface view of a Suite/Advanced UI project, the toolbar
that InstallShield shows directly above the wizard interface preview pane includes several different buttons and other
controls that let you modify the layout of the selected page or window. InstallShield also displays this toolbar in the Wizard
Interface view if you select one or more controls on a wizard page or a secondary window.

The new toolbar has buttons that let you add labels, text boxes, check boxes, and other controls to the installation’s user
interface. The toolbar also has buttons that let you easily align selected controls, resize them, and position them in relation
to each other. In Suite/Advanced UI projects, the Default Languages list in the new toolbar enables you to switch the strings
that InstallShield displays on the wizard pages and secondary windows in this view to those in a different language in your
project.

For more information, see:

• Adding a Control to a Wizard Page or Secondary Window

• Wizard Interface View Toolbar

Support for Adding Languages to Suite/Advanced UI Projects

The InstallShield Premier edition includes default run-time strings in 35 supported languages. When you add a supported
language to a Suite/Advanced UI project, that language is made available in various language-related settings throughout
InstallShield. In addition, InstallShield adds translated string entries for that language to your project. The string entries
are for the default wizard pages, messages, and other end-user interface elements.

InstallShield now lets you add unsupported languages, beyond the built-in 35 languages, to Suite/Advanced UI projects
through the New Language Wizard. An unsupported language is one in which none of the default run-time strings are
translated. When you add an unsupported language to a Suite/Advanced UI project, that language is made available in
various language-related settings throughout the project. In addition, InstallShield uses the strings from your project’s
default language as placeholders for the strings in that newly added unsupported language; you can use the String Editor
view to provide translated strings for the unsupported languages.

To launch the New Language Wizard in a Suite/Advanced UI project, on the Tools menu, click Add New Language.

To learn more, see the following:

• New Language Wizard

• Run-Time Language Support in InstallShield

InstallShield 2020 User Guide ISP-2600-UG00 167

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Ability to Create and Configure Scheduled Tasks on Target Systems at Run Time
InstallShield has a new Scheduled Tasks view that lets you configure one or more tasks that you want to be created
through the Windows task scheduler at run time on target systems. The view lets you specify information such as the file
that you want to be launched for a task, as well as the start date and time. The file that you want to be launched can be part
of your installation, or it can be a file that is already present on target systems.

This feature is available in the following project types: Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database,
Transform.

For more information, see:

• Scheduling Tasks

• Scheduled Tasks View

New FlexNet Connect 13.03 Redistributables Available

InstallShield includes support for FlexNet Connect 13.03 in Basic MSI and InstallScript MSI projects. Use the Update
Notifications view in InstallShield to include one of the two FlexNet Connect 13.03 merge modules—one has the Common
Software Manager, and the other does not.

Enhancements
InstallShield includes the following enhancements.

Enhancements to the InstallScript Language for Operating Systems

The following structure members and predefined constants were added to the InstallScript language:

• SYSINFO.WINNT.bWin8—This is a new SYSINFO structure member. If the operating system is Windows 8 or Windows
Server 2012, this value is TRUE.

• ISOSL_WIN8—This is a new predefined constant that is available for use with the FeatureFilterOS function and the
SYSINFO structure variable. It indicates that the target system is running Windows 8 or Windows Server 2012.

For more information, see FeatureFilterOS function and the SYSINFO structure variable.

Automation Interface Enhancement: OSFilter Property Value for Windows 8 and Windows Server 2012
The following constants are now available for use with the OSFilter member of the ISWiComponent and ISWiRelease
objects in the automation interface:

eosWin8 = &H4000000 (67108864)—These are for Windows 8 and Windows Server 2012.

In addition, the value for the eosAll constant is now &7D100D0 (131137744); previously, it was &3D100D0 (64028880).

The OSFilter member applies to the ISWiComponent object in InstallScript, InstallScript MSI, and InstallScript Object
projects. The OSFilter member applies to the ISWiRelease object in InstallScript and InstallScript Object projects.

For more information, see the following:

• ISWiComponent Object

• ISWiRelease Object

168 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Ability to Easily Move Conditions in Suite/Advanced UI and Advanced UI Projects

When you have more than one conditional statement for an exit, detection, eligibility, or feature condition in a Suite/
Advanced UI or Advanced UI project, you now can move the conditional statements to reorder conditions or change the
hierarchy of a condition tree. For example, if you have a platform conditional statement in a None condition group, and the
None condition group is in an All condition group, you can move the platform conditional statement left, so that it is only
part of the All condition group.

To move a conditional statement or group, click the new Move Condition button in the setting of the item that you want to
move, and then click the appropriate option (Move Up, Move Down, Move Left, or Move Right).

Previously, it was necessary to manually create the new conditional statement in the new location and delete the one in
the old location. Or, as an alternative, you could edit the .issuite file in a text editor and change the order of the conditional
statements.

For more information, see Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects.

New Extension Condition Support and Enhanced Condition Settings in Suite/Advanced UI and Advanced
UI Projects
In Suite/Advanced UI and Advanced UI projects, new extension condition functionality is available. This type of condition
lets you browse to a C/C++ DLL that you have created to check for your own custom conditions on target systems.

In addition, many of the condition-related settings that are available in Suite/Advanced UI and Advanced UI projects have
been enhanced to make it easier to build conditional statements. For example, instead of manually trying to enter a
product code, upgrade code, patch code, or other various types of data in any one of several of the condition settings, you
can now click a new ellipsis button (...) in the setting; when you do this, InstallShield displays a browse dialog box that lets
you browse to and select the appropriate package. Once you have selected a package, InstallShield enters the appropriate
information from that package in the setting of the Suite/Advanced UI or Advanced UI project.

When you are configuring an eligible package condition, you can now select from a list of packages in your Suite/Advanced
UI or Advanced UI project instead of having to manually enter the package GUID of the appropriate package.

For more information, see:

• Creating a Custom Condition for an Advanced UI or Suite/Advanced UI Installation

• Creating an Extension Condition DLL for an Advanced UI or Suite/Advanced UI Project

• Adding an Extension Condition DLL to an Advanced UI or Suite/Advanced UI Project

• Extension Condition Settings

Enhancements for Configuring Validation and Actions for a Control on a Wizard Page or Window in Suite/
Advanced UI and Advanced UI Projects
In Suite/Advanced UI and Advanced UI projects, the Validation and Action settings for various controls on the wizard
interface have been enhanced to make it easier to define validation and trigger various actions. These settings now contain
drop-down lists of sample statements that you can enter in these settings; these settings are also still text boxes that let
you enter statements manually. For example, the Validation setting lets you specify a format that end users must match
when they enter a serial number in a control. As an alternative to manually entering the entire validation statement, you
can now select the mask type of validation in the Validation setting and then override the default format in the setting.

Similarly, the Action setting lets you define—for example—a print action for a button control; when an end user clicks the
Print button, the Print dialog box opens, enabling the end user to print the license agreement. As an alternative to
manually entering the action statement, you can now select the print action in the Action setting and then override the file
name with the name of the file that you want to be printed.

InstallShield 2020 User Guide ISP-2600-UG00 169

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The drop-down lists in the Validation and Action settings also now include C/C++ DLL files that you have created and added
to your project through the Support Files view. This functionality lets you trigger your own validation or your own action for
various controls on the wizard interface.

To learn more, see:

• Configuring Validation for a Control on a Wizard Page or Window

• Configuring an Action for an Element in the Wizard Interface

Ability to Use Custom Folder Names for Packages in Suite/Advanced UI and Advanced UI Releases
When you build an Suite/Advanced UI or Advanced UI installation, InstallShield creates a folder for each package that is
included in the installation; these folders are created in the same folder that contains the Suite/Advanced UI or Advanced
UI setup launcher. By default, the name of each folder is a GUID that InstallShield generates.

The Packages view in InstallShield now lets you override the GUID name with a user-friendly name for each package folder.
To enter a custom folder name in this view, find a Package Files folder under the package whose folder name you want to
customize. Right-click that folder, click Rename, and enter a new name. If you customize more than one folder name,
ensure that each folder name is different.

Previously, InstallShield used a GUID for the name of each folder and did not have support for customizing the names.

For instructions, see Using Custom Folder Names for Packages in Advanced UI and Suite/Advanced UI Installations.

New Formatted Support for Properties Whose Values Reference Other Properties in Suite/Advanced UI
and Advanced UI Projects
Each property that is defined in the Property Manager view in a Suite/Advanced UI or Advanced UI project has a new
Formatted check box. This new check box lets you indicate whether you want the properties that are referenced in a
property’s value to be resolved and replaced by their property values at run time.

To replace properties that are enclosed within square brackets (such as [PropertyName]) at run time, select this check box.
To leave square brackets and the content within them as is, clear this check box.

For more information, see Property Manager View.

Improved Timing for UAC Prompts of Downloaded Packages that Require Elevation for Suite/Advanced
UI and Advanced UI Installations that Have an Invoker Manifest
If you build an Advanced UI or Suite/Advanced UI release with an Invoker manifest, and if Yes is selected in the Require
Elevated Privileges setting for any of the installation’s packages that need to be downloaded and launched on the target
system, the installation triggers the UAC prompt soon after end users click the Install button—before the download occurs.

Previously, the installation triggered the UAC prompt after the download occurred. Thus, if package staging was slow (for
example, if the package download took a long time), there could be a big gap between the moment that an end user
clicked the Install button and the moment that Windows displayed the UAC prompt for elevation for the package. If an end
user did not provide consent or credentials quickly enough, the UAC prompt timed out, and the installation failed.

In some previous cases, using an Administrator manifest was a possible workaround, since the UAC prompt was displayed
soon after end users clicked the Install button. However, with this workaround, the entire installation had elevated
privileges.

170 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Support for Specifying the Alignment for Text in the Wizard Interface of Suite/Advanced UI and
Advanced UI Installations
InstallShield has a number of built-in text styles that define text attributes such as color, size, and font name for the text on
the wizard interface of Suite/Advanced UI and Advanced UI projects. You can edit any of the settings for these built-in styles
or define your own styles, through the Wizard Interface view in your Advanced UI or Suite/Advanced UI project.

Each built-in or custom text style includes a new Text Alignment setting that lets you select the type of alignment that you
want to use for the text in controls that use that particular style.

To learn more, see Using Styles, Brushes, and Control Themes to Customize the Wizard Interface.

Enhanced Combo Box Controls for the Wizard Interface of Suite/Advanced UI and Advanced UI
Installations
InstallShield lets you add a combo box control to a wizard page or a secondary window in Suite/Advanced UI and Advanced
UI projects. This type of control is a combination of two controls by default:

• A box that contains a drop-down list of predefined values

• A text box that lets end users enter a custom value

Previously, if you added a new combo box control, the control contained a drop-down list, but it was not also a text box;
that is, end users could not enter a custom value.

To change this control to a drop-down list without the text box (that is, if end users should be able to select a predefined
value but not enter a custom value), set the CBS_DROPDOWNLIST style for this control to True.

Enhancements and Changes to the Aero Format for the Suite/Advanced UI and Advanced UI Wizard
Interface
Some enhancements and changes have been made to Aero-formatted wizard pages in Suite/Advanced UI and Advanced UI
installations:

• The header and navigation areas of wizard pages are now displayed with the Aero glass effect, or translucency.
Previously, only the caption bar of wizard pages were displayed with the Aero glass effect.

• The Aero-formatted wizard pages now use the same layout as Wizard 97–formatted wizard pages. That is, the caption
bar on Aero-formatted wizard pages is no longer extra tall; it is the same height as the caption bar on Wizard 97–
formatted wizard pages. In addition, the Back button on Aero-formatted wizard pages is now displayed in the
navigation area, which is consistent with the placement on Wizard 97–formatted wizard pages. Previously, the top-left
corner of the caption bar in Aero-formatted wizard pages contained the Back button.

Ability to Remove a String Value and Its Identifier from a Setting

When you are entering the value of a setting in one of the views in InstallShield and that value is a text string that can be
presented to end users, InstallShield automatically uses a string identifier for that setting. InstallShield places the string
identifier in curly brackets before the string value. These types of settings now contain a new Delete this string reference
button.

If you want to remove the string identifier and its value from a setting, you can now click this new button. The button lets
you clear the entry in the setting. Note that if you want to delete the string identifier and its value from your project, you
must use the String Editor view.

See Also
Upgrading Projects from InstallShield 2012 or Earlier
Upgrading from Earlier InstallShield Versions

InstallShield 2020 User Guide ISP-2600-UG00 171

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

What’s New in InstallShield 2012 SP1

InstallShield 2020

Enhancements
InstallShield includes the following enhancement.

Support for Digitally Signing Software Identification Tags

If you configure your project to include a software identification tag and you also configure the release in the Releases view
to use a .pfx file to digitally sign your release, InstallShield digitally signs the tag at build time. Note that the .NET
Framework 2.0 or later must be installed on your build machine in order to sign a tag file.

For more information, see Including a Software Identification Tag for Your Product.

What’s New in InstallShield 2012

InstallShield 2020

New Features
InstallShield includes the following new features.

Ability to Create Suite Installations that Run Multiple Packages; New Contemporary, Customizable End-
User Interface; Ability to Build Hybrid 32-Bit/64-Bit Installations
The Premier edition of InstallShield now lets you build a Suite installation that uses the next-generation setup launcher
(Setup.exe) to conditionally run multiple installations and apply Windows Installer patches (.msp) as needed on target
systems. This support is available through a new Suite project type. Suite installations can be run on systems with Windows
XP and later and with Windows Server 2003 and later.

Following are some highlights of this functionality.

Ability to Package Multiple Installations as a Single Installation

The new Suite project type contains a Packages view that lets you specify one or more of the following types of packages:

• Executable files (.exe), including Windows Installer–based and non-Windows Installer–based installations that you
want to be run on target systems

• Windows Installer packages (.msi) that you want to be run on target systems

• Windows Installer patches (.msp) that you want to be applied on target systems

The Packages view also lets you include multiple .msi and .msp packages that you want to be run using transaction
processing, a feature of Windows Installer 4.5 and later. The packages are chained together and processed as a single
transaction. Each Suite installation can have multiple separate transactions. If one or more of the packages in a transaction
cannot be installed successfully or if the end user cancels the installation, Windows Installer initiates rollback for all of the
chained packages within the current transaction to restore the system to its earlier state.

The Suite installation launches the appropriate packages at run time based on conditions that you have defined and the
order in which you listed the packages in the Packages view.

172 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Contemporary, Customizable User Interface for the Installation; New Editor for Customizing Suite Setup.exe Wizard
Pages

The Suite project type in InstallShield includes an entirely new end-user interface, with redesigned, contemporary built-in
wizard pages that you can include and customize in your Suite installations. The new wizard page editor in this project type
lets you add, sequence, and remove pages as needed; it also lets you modify the layout of any page—adding, moving, and
removing a variety of different kinds of controls.

Support for Combining 64-Bit and 32-Bit Windows Installer Packages Into a Single Installation

As more and more users move to 64-bit versions of Windows, you may need to now, or in the near future, deliver to
customers a single installation that installs to 32-bit locations on 32-bit systems and to 64-bit locations on 64-bit systems.
The Suite project type lets you include both 32-bit packages and 64-bit packages in one Suite installation, and run only the
appropriate packages on each target system. Previously, other alternatives required delivering two separate installations
(one for 32-bit systems and one for 64-bit systems) or creating a custom launcher, a bootstrap application, or an
InstallScript installation.

Support for Displaying a Single Progress Bar that Shows the Overall Status of the Entire Suite of Packages

The progress bar on the progress wizard page in a Suite installation shows the status of the entire suite of packages. This
integrated progress bar presents end users with a clear visual indication of how far along the Suite installation is overall. To
ensure that end users see only the integrated progress bar, you must include only .exe installations for which you have
specified command-line parameters that hide the user interface (that is, run silently), .msi packages, and .msp patches.

Optional Add or Remove Programs Entry for the Suite Installation

Suite projects let you specify whether you want to have an entry in Add or Remove Programs for your Suite installation.
This entry lets end users perform maintenance for your Suite, modifying or removing if needed. The General Information
view in a Suite project has a Show Add or Remove Programs Entry setting that lets you indicate the appropriate behavior.

If you want to show only a single entry for the entire Suite, ensure that you hide the entries from the packages that you
include in the Suite project.

Support for Running Suite Installations Without a User Interface

End users can run your Suite installations with a user interface or silently, without a user interface. Silent installations run
without user intervention; end users can avoid monitoring the installation and providing input through run-time wizard
pages.

Default Setup.exe User Interface Strings Included for All 35 Supported Languages; Ability to Edit the Suite Run-Time
Strings

Translations of all of the default strings that are displayed in the built-in wizard pages of Suite projects are available in all
35 of the run-time languages that InstallShield supports. All of these Suite strings are displayed in the String Editor view of
a Suite project. This String Editor view offers the same robust support that other types of projects offer, giving you
complete and centralized control over the text strings that are displayed at run time during the Suite installation process.

Small Base Setup.exe File with the Ability to Download Only the Required Packages As Needed

Suite projects include flexible options for specifying the run-time source location of each package in the Suite installation.
When you define the packages that you are including in a Suite project, you can specify the location of each individual
package. The available options are:

• On the Web, available for download by Setup.exe if needed

• Embedded in Setup.exe and extracted to the target system if needed

InstallShield 2020 User Guide ISP-2600-UG00 173

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Uncompressed and stored on the Suite source media

The base Setup.exe file that is used for Suite installations is much smaller than the base Setup.exe files that are used for
Basic MSI, InstallScript MSI, and InstallScript installations. Thus, your end users can quickly download a small Suite
Setup.exe file, and the Setup.exe file can download and launch one or more required packages as needed.

For more information, see:

• Creating Advanced UI and Suite/Advanced UI Installations

• Adding an .msi Package, an .msp Patch, or a Transaction to an Advanced UI or Suite/Advanced UI Project

• Adding an Executable Package (.exe) to a Suite/Advanced UI Project

• Working with the Wizard Interface

• Advanced UI and Suite/Advanced UI Setup.exe Command-Line Parameters

• Advanced UI and Suite/Advanced UI Property Reference

• Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects

Redesigned, Expanded Support for Modularizing Installation Projects to Enable Reuse and Distribute
Development Work
InstallShield includes a new project type called DIM, which is known as a developer installation manifest. A DIM project is a
feature-sized collection of related items such as product files, shortcuts, registry entries, text file changes, IIS Web sites,
and other elements that together make up a discrete portion of a product installation. Some benefits of using DIMs are as
follows:

• DIMs include support for virtually the same functionality that is available in Basic MSI projects. This gives authors of
DIMs all of the flexibility that they need to develop their portions of an installation.

• Release engineers can reuse DIMs in multiple Basic MSI projects, enabling efficiency.

• Working with DIMs enables multiple team members to contribute to the development of the installation
simultaneously. Each software developer or other team member can work on a separate DIM that the release engineer
can reference in one or more Basic MSI projects.

Once you have created a DIM, you can add it to a Basic MSI project in one of two ways:

• By reference—You can add a reference for a DIM project to your Basic MSI project through the Setup Design view or
the DIM References view. With this method, the DIM elements are merged into the Basic MSI project at build time. Each
time that you build the Basic MSI installation, InstallShield references the latest version of the DIM project and
includes it in the installation that it generates. This method is the more commonly performed method.

• By import—You can import a DIM project into your Basic MSI project by using the new Import DIM Wizard. This
method is a one-time, irreversible import that merges the DIM data into the Basic MSI project at design time.

This redesigned, expanded DIM support replaces the previous support that required users to create DIMs in a separate tool
called InstallShield Collaboration, and then import the DIM files into InstallShield Basic MSI projects. The new DIM support
is more robust than the previous support. The new DIM project type lets you have virtually the same complete level of
authoring flexibility that is available for Basic MSI projects. For example, the new DIM project type lets you have full control
over component creation: you can add components to a new DIM project, set the key file of a component, and configure
the component’s settings. The new DIM project type also lets you configure IIS Web sites. InstallShield Collaboration did
not have that sort of flexibility over component design, and it did not have any built-in support for configuring IIS Web sites.

174 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The ability to create DIM projects is available in the Premier edition of InstallShield. This support is also available in the
InstallShield Developer Installation Manifest Editor, a new collaboration add-on. The ability to add DIM files to Basic MSI
projects is available in the Premier edition of InstallShield.

For more information, see the following:

• Modularizing Installation Projects to Distribute Development Work and Enable Reuse

• Including DIMs in a Project

• Determining the Appropriate Method for Incorporating DIMs in Installation Projects

• Using Path Variables in a DIM

• DIM References View

• Import DIM Wizard

New InstallShield Prerequisites for Internet Explorer 9, SQL Server 2008 R2 Native Client, Windows
Identity Foundation, and Other Redistributables
InstallShield includes several new InstallShield prerequisites that you can add to Basic MSI, InstallScript, and InstallScript
MSI projects:

• Internet Explorer 9.0

• Microsoft SQL Server 2008 R2 Native Client 10.50.1600.1

• Windows Identity Foundation

• Microsoft VSTO 2010 Runtime (x64)

• Microsoft Office 2010 PIA (This prerequisite installs the Microsoft Office 2010 Primary Interop Assemblies. To use this
prerequisite, download the PrimaryInteropAssembly.exe file from Microsoft’s Web site and run it to extract the .msi
file.)

Support for 64-Bit Dependency Scanning

The Static Scanning Wizard and the Dynamic Scanning Wizard—dependency scanners in InstallShield—now include
support for identifying 64-bit dependencies of the 64-bit files in your project. If you are using InstallShield on a 64-bit
version of Windows Vista or later or a 64-bit version of Windows Server 2008 or later, the scanners can detect the 64-bit
dependencies. The wizards let you specify whether you want to include each detected potential dependency in your
project.

In addition, if you use InstallShield on a 64-bit version of Windows Vista or later or a 64-bit version of Windows Server 2008
or later, and you use either of the following built-in methods for detecting dependencies, InstallShield can scan for 64-bit
dependencies of the 64-bit .NET assemblies in your project:

• The Static Scanning Wizard helps you identify a 64-bit .NET assembly’s possible dependencies on demand. This wizard
displays a list of the dependencies that it finds, and it lets you specify whether you want to include each one in your
project.

• A component’s .NET Scan at Build setting lets you specify whether you want InstallShield to identify a 64-bit .NET
assembly’s dependencies each time that you build your project. For InstallScript projects, the component’s .NET
Assembly setting must also be set to Local Assembly. If InstallShield detects any possible missing dependencies at
build time, InstallShield incorporates them into the release that it generates.

InstallShield 2020 User Guide ISP-2600-UG00 175

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

InstallShield must be installed on a 64-bit operating system in order to scan 64-bit files for 64-bit dependencies. Note that if
you use InstallShield on a 32-bit version of Windows, these built-in scans can check for only 32-bit dependencies of the 32-
bit files in your project. If your project includes 64-bit files, you can manually add any dependencies to the project as
needed.

To learn more, see:

• Developing and Building Installations on 32-Bit vs. 64-Bit Systems

• Scanning for 64-Bit Dependencies

• Identifying Application Dependencies

• Scanning 64-Bit .NET Assemblies for Dependencies

• Identifying Properties and Dependencies of .NET Assemblies

Support for Setting Permissions for Files, Folders, and Registry Keys in 64-Bit Locations
InstallShield has support for setting permissions for files, folders, and registry keys in 64-bit locations. The support varies,
depending on which project type you are using.

Using the Custom InstallShield Handling Method in Windows Installer–Based Projects

If you are using the custom InstallShield handling method to set permissions for files, folders, and registry keys, you can
now set permissions for these items when they are in 64-bit locations; this includes 64-bit locations in the registry, as well
as the 64-bit System32 folder on 64-bit systems. The file, folder, or registry key must be included in a component that is
marked as 64 bit (that is, Yes is selected for its 64-Bit Component setting). Previously, if the component was marked as 64
bit, permissions could not be set, and a run-time error was displayed.

This custom InstallShield handling support is available in the following project types: Basic MSI, InstallScript MSI, Merge
Module, MSI Database, MSM Database, and Transform. The Locked-Down Permission setting in the General Information
view lets you specify which method you want to use for setting permissions: either the custom InstallShield handling
method or the traditional Windows Installer handling method.

Using the InstallScript Function SetObjectPermissions in InstallScript-Based Projects and Windows Installer–Based
Projects

If the REGDB_OPTION_WOW64_64KEY option is enabled and you use the InstallScript function SetObjectPermissions to
set permissions for a 64-bit registry key, the function can set its permissions correctly. To force SetObjectPermissions to
set permissions for a 64-bit registry key regardless of whether the REGDB_OPTION_WOW64_64KEY option is enabled, you
can use the new IS_PERMISSIONS_OPTION_64BIT_OBJECT constant; pass this constant in the nOptions parameter of
SetObjectPermissions. Note that the IS_PERMISSIONS_OPTION_64BIT_OBJECT constant should not be passed on 32-bit
target systems.

If file system redirection is disabled using the WOW64FSREDIRECTION constant when SetObjectPermissions is called to
set permissions for a file or folder in the 64-bit System32 folder, the function can set the permissions correctly. If file system
redirection is not disabled, the permissions cannot be set.

You can use the SetObjectPermissions function in InstallScript events in InstallScript and InstallScript MSI projects. You
can also use this function in InstallScript custom actions in the following project types: InstallScript, Basic MSI, InstallScript
MSI, and Merge Module.

For more information, see SetObjectPermissions.

176 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Improvements for COM Extraction

InstallShield supports a new monitoring method for COM extraction. If you are using InstallShield on a Windows Vista or
later system or a Windows Server 2008 or later system, this new method is used by default. The method uses a kernel driver
to monitor the areas of the registry that are modified during dynamic COM extraction at build time and static COM
extraction at design time. It combines the advantages that the earlier methods provided, allowing the DLL to read existing
registries entries and preventing changes to the build machine.

If necessary, you can switch between the three different COM extraction methods by setting the value data of the
UseAPIRegistryHooks registry value, which is in the registry key HKEY_LOCAL_MACHINE\SOFTWARE\InstallShield\RegSpy
(on 32-bit machines) or HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\InstallShield\RegSpy (on 64-bit machines).
Possible REG_DWORD value data are:

• 0—Use API hooking to read existing registry entries for the DLL.

• 1—Use registry redirection to prevent making changes to the registered DLLs on the build machine. If the value is not
set, this is the default behavior on Windows XP and Windows Server 2003 systems.

• 2—Use the new kernel mode monitoring, which combines the advantages of both of the other methods. If the value is
not set, this is the default behavior on Windows Vista and later systems and on Windows Server 2008 and later
systems.

This feature applies to the following project types: Basic MSI, DIM, InstallScript MSI, and Merge Module.

Predefined System Searches for Adobe Reader 10, Internet Explorer 9, and Microsoft Office
InstallShield has new predefined system searches:

• Adobe Reader 10

• Internet Explorer 9

• Microsoft Office 2010

• Microsoft Office 2007

• Microsoft Office 2003

If your installation requires one or more of these, you can use the System Search view or the Installation Requirements
page in the Project Assistant to add these system searches to your project. When end users launch your installation,
Windows Installer checks the target system to see if the requirements are met; if they are not met, the installation displays
the error message that is defined for the system search.

This feature applies to Basic MSI and InstallScript MSI projects.

Support for Software Identification Tagging

ISO/IEC 19770-2 is an international standard for the creation of software identification tags. A software identification tag is
an XML-based file that contains descriptive information about the software, such as the product name, product edition,
product version, and publisher. Software asset management tools collect the data in the tags to provide accurate
application identification for software that is installed in an enterprise.

Software identification tagging is evolving as an industry standard, enabling independent software vendors to create
smarter applications that give you better information for software asset management and license optimization initiatives.
Including the identification tag in your product’s installation makes it possible for your customers to use tools that can
monitor their internal usage of your product, allowing them to manage and optimize the number of licenses of your
product that they obtain from you, and stay in compliance with your licensing policies.

InstallShield 2020 User Guide ISP-2600-UG00 177

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

InstallShield includes several new settings in the General Information view that let you specify information that is required
to create an identification tag for your product. This view also contains a new Use Software Identification Tag setting that
lets you specify whether you want InstallShield to create the tag at build time and include it in your installation; the default
value of this setting is Yes.

Note that if Yes is selected for the Use Software Identification Tag setting but you have not entered values in one or more of
the required identification settings (the Unique ID, Tag Creator, and Tag Creator ID settings in the General Information
view), build warning -7235 occurs, once for each of the settings that are blank. This build warning explains that the
software identification tag could not be created and included in the installation because a specific required setting was left
blank. To resolve this warning, enter appropriate value in each specific setting, or select No for the Use Software
Identification Tag setting.

The automation interface includes support for the new tag settings. The ISWiProject object includes a new EnableSwidtag
property that lets you enable or disable the creation of a software identification tag in a project. It also includes a new
SwidtagProperty property that you can use to configure various tag-related settings that are also configurable in the
General Information view.

This feature applies to Basic MSI projects.

For more information, see:

• Including a Software Identification Tag for Your Product

• General Information View Settings

• ISWiProject Object

Enhancements
InstallShield includes the following enhancements.

Merge Module Projects Now Include Built-In Support for IIS, Text File Changes, and XML File Changes
Several existing views are now available in Merge Module projects in InstallShield:

• Internet Information Services—This view enables you to create and manage new IIS Web sites, applications, virtual
directories, application pools, and Web service extensions.

• Text File Changes—This view lets you configure search-and-replace behavior for content in text files—for example,
.txt, .htm, .xml, .config, .ini, and .sql files—that you want to modify at run time on the target system.

• XML File Changes—This view lets you add references for nodes and node sets of XML files that you want to change at
run time.

Use these views in Merge Module projects to configure IIS, specify text file changes, and specify XML file changes. The same
procedures that were used for configuring these changes in installation projects are now supported in Merge Module
projects. When you build a merge module that contains project information in these views, add the merge module to an
installation project, and then build a release in the installation project, InstallShield includes the applicable run-time
support in the installation.

Previously, these views were available only in installation projects.

To learn more, see:

• Managing Internet Information Services

• Modifying Text Files

178 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Modifying XML Files

New Application Pool Identity Option for IIS 7.x

A new ApplicationPoolIdentity option is available in the Identity setting for an application pool that is configured in the
Internet Information Services view. If you want a virtual identity account that is unique to the selected application pool to
be used for running the application pool’s worker process, select this option. Support for this option is available on target
systems that have IIS 7 and later. If this new option is selected in an installation that is run on a system that has IIS 6, the
NetworkService account is used instead for the application pool’s identity.

This feature applies to the following project types: Basic MSI, InstallScript, InstallScript MSI, and Merge Module.

For more information, see Application Pool Settings.

Automation Interface Enhancement: New RequiredExecutionLevel Property for Specifying the Required
Execution Level for Setup.exe
The read-write RequiredExecutionLevel property has been added to the ISWiRelease object. This property corresponds
with the Required Execution Level setting on the Setup.exe tab for a release in the Releases view. This property is available
for Basic MSI, InstallScript, and InstallScript MSI projects.

See Also
Upgrading Projects from InstallShield 2011 or Earlier
Upgrading from Earlier InstallShield Versions

What’s New in InstallShield 2011

InstallShield 2020

New Features
InstallShield includes the following new features.

Unicode Support in InstallScript

InstallShield now lets you create InstallScript installations and InstallScript custom actions that support the use of Unicode
in run-time strings, files, paths, registry entries, and other installation data. In addition, the InstallScript compiler and the
InstallScript engine now let you pass pointers to Unicode strings to functions that are implemented outside script code;
they also let you store Unicode strings in structures that are passed outside script code. Other changes in InstallScript offer
additional benefits for fully supporting modern multilanguage installations.

As a result of these changes, any language displays correctly on a system that has support for it installed. End users no
longer need to match the language that is used on their systems for non-Unicode programs with the language that is used
in the installation. Note that the font must be installed on the target system. On some versions of Windows, the fonts for
some languages are not installed by default. For example, Japanese fonts are not installed on a Windows XP English system
by default; in order for an installation to use Japanese characters on such a system, the fonts would need to be installed.

Unicode Setup Launchers for InstallScript and InstallScript MSI Projects

Now all Setup.exe and Update.exe files that are built in InstallShield are Unicode. Previously, all Setup.exe and
Update.exe files that were built in InstallScript and InstallScript MSI projects were ANSI.

InstallShield 2020 User Guide ISP-2600-UG00 179

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

A Unicode setup launcher can correctly display characters in the user interface of the setup launcher, regardless of whether
the target system is running the appropriate code page for the language. ANSI setup launchers correctly displayed
characters in the setup launcher dialogs if the target system was running the appropriate code page. However, it may have
displayed garbled characters in those dialogs if the target system was not running the appropriate code page.

End users can launch Setup.exe and Update.exe files from within Unicode paths, regardless of the language on the target
system. For example, end users can now launch the installation in the following path on an English system:
C:\Users\Japanese characters\Desktop\Setup.exe. Previously, the installation would fail.

Unicode Support for Files, Folders, Registry Entries, and Support Files

Unicode support has been added to key parts of the installation run time, enabling you to use characters from any
languages simultaneously in file names, folder names, registry entries, and support file names. This enables you to install,
for example, a file that has Japanese characters in its name or target path on an English system. Mixing languages works
correctly regardless of the current language of the target system.

Pointer Support

The InstallScript engine and compiler now support a new pointer type called WPOINTER; wpointer and LPWSTR are
equivalent names that are also available. Thus, for example, if you have a DLL function that accepts pointers to Unicode
strings in its parameters, you can use this new pointer type; when the DLL function is called in the script at run time, the
InstallScript engine passes a pointer to a Unicode copy of the strings instead of an ANSI version. Previously, it was possible
to pass a pointer to only an ANSI copy of the strings.

Note that passing Unicode strings with the WSTRING data type that was introduced in an earlier version of InstallShield is
still supported.

For more information, see:

• Pointers

• Data Types and Predefined Structures

Structure Support

Structures in InstallScript can contain any basic data type, including strings and pointers, or other structures. Now if a
structure needs to contain a Unicode string and the structure is passed to an external DLL, the InstallScript engine can
distinguish between string member types in that structure, and then size the structure and calculate member offsets
correctly. String members that need to be stored and passed as Unicode can be declared with the WSTRING type.

Previously, if a structure needed to contain a Unicode string and the structure was passed to an external DLL, the
InstallScript engine assumed that any strings in the structure were ANSI. As a result, the size of the structure and member
offsets in the structure could have been wrong, causing the DLL to incorrectly read or write data related to the structure.
Attempting to use WSTRING for string members of a structure did not have any effect.

You can leave existing strings as STRING types; the InstallScript engine will continue to treat these as ANSI strings when
passing them outside of script code.

Pointer members in structures can also now be declared as WPOINTER. This enables you to store pointers to Unicode
strings in a structure.

For more information, see:

• Data Structures

• Data Types and Predefined Structures

180 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

String Table Support

InstallShield now uses Unicode encoding to build the string tables for InstallScript projects. Because of this support, string
tables for InstallScript projects can now contain multiple languages, and they are not affected by a target system’s code
page settings. In addition, string tables can now include strings for languages—such as Hindi—that have no code page.

It is recommended that any strings that will be displayed in the user interface of an installation be stored in the string table.
Although strings can be written directly in InstallScript code, they are not stored as Unicode; thus, they are displayed
correctly only when the installation is run on systems that have the correct code page. Storing strings in the string table
and referencing them from InstallScript code eliminates this issue.

For more information, see:

• Using String Entries in InstallShield

• String Constant Operator (@)

Unicode InstallScript Dialogs

InstallScript dialogs now include support for Unicode. This enables you to mix, for example, Japanese and German, or
Russian and Polish, on InstallScript dialogs. These mixed languages work correctly regardless of the current language of
the target system.

This feature is available in the following project types: InstallScript and InstallScript MSI.

Unicode Support in the InstallScript Debugger

The InstallScript Debugger now has support for Unicode. Thus, for example, if you are debugging a line of InstallScript code
such as szMsg = @ID_MSG, you can now see the value in szMsg, regardless of what language operating system you are using
and what language is used for the strings. If the value of ID_MSG contains Chinese characters or characters from mixed
languages, you can now see the appropriate characters instead of question marks in various areas of the InstallScript
Debugger: in the variable window, in the watch window, and in the tooltip that appears for the variable in the script
window.

For information on the InstallScript Debugger, see Debugging InstallScript-Based Installations in the InstallScript Debugger
User Guide.

Unicode Support in InstallShield Cabinet and Log File Viewer

The InstallShield Cabinet File Viewer and the InstallShield Log File Viewer have been combined into one new tool—the
InstallShield Cabinet and Log File Viewer—which lets you open and review InstallScript cabinet files (.cab), InstallScript
header files (.hdr), and InstallScript log files (.ilg). This tool now includes Unicode support. Thus, the tool can correctly
display the characters in each file name, registry key, shortcut, and other data in the .cab, .hdr, or .ilg file, regardless of
what language operating system you are using and what language is used for the strings. Previously, in some cases, some
of the characters were displayed as question marks.

The cabinet and header file support applies to the following project types: InstallScript and InstallScript Object.

The log file support applies to the following project types: InstallScript and InstallScript MSI.

To learn about this tool, see:

• InstallShield Cabinet and Log File Viewer

• Viewing InstallScript Cabinet Files (.cab) and Header Files (.hdr)

• Viewing InstallScript Log Files (.ilg)

InstallShield 2020 User Guide ISP-2600-UG00 181

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Integration with Team Foundation Server (TFS)

InstallShield has enhanced support for integrating with Team Foundation Server (TFS) 2010.

Now when you are using InstallShield from within Visual Studio 2010, you can access the Source Control Explorer to
integrate your InstallShield project with Team Foundation version control and manage changes to your InstallShield
projects and your Visual Studio solutions.

You can also use Team Foundation Build to compile, test, and deploy your InstallShield projects and your Visual Studio
solutions on a regular basis, or on demand. Your installation is automatically updated with your latest source files every
time that your solution is built.

In addition, if you install Team Explorer on the same machine that has InstallShield and Visual Studio, you can use Team
Explorer from within your InstallShield projects that are open in Visual Studio. This enables you to perform tasks such as
the following:

• Use Source Control Explorer when you are working on your InstallShield projects.

• Configure builds for your InstallShield projects and Visual Studio solutions.

• Queue new builds.

• Track work items such as bugs and tasks for your InstallShield projects and your Visual Studio solutions.

For more information, see:

• Integrating with Microsoft Visual Studio Team Foundation Server

• Adding InstallShield Projects to Team Explorer

Microsoft SQL Server 2008 R2 Support

InstallShield now includes support for running SQL script on SQL Server 2008 R2. In addition, InstallShield includes SQL
Server 2008 R2 in the predefined list of database servers that you can select when you are specifying in the SQL Scripts view
the target database servers that your product supports.

This feature is available in the following project types: Basic MSI, InstallScript, and InstallScript MSI.

New InstallShield Prerequisites for SQL Server 2008 R2 Express, SQL Server Native Client, Visual C++
2010, and Other Redistributables
InstallShield includes a number of new InstallShield prerequisites that you can add to Basic MSI, InstallScript, and
InstallScript MSI projects:

• Microsoft SQL Server 2008 R2 Express

• Microsoft SQL Server 2008 Native Client 10.00.2531

• Microsoft SQL Server Native Client 9.00.4035

• Microsoft SQL Server System CLR Types 10.00.2531

• Microsoft SQL Server 2008 Management Objects 10.00.2531

• Microsoft Visual C++ 2010 Redistributable Package

• Microsoft Visual C++ 2008 SP1 Redistributable Package

• Microsoft Visual C++ 2005 SP1 Redistributable Package (x64)

• Windows Installer 3.1 - Japanese

182 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• MSXML 6.0 SP1 - Japanese

• Microsoft .NET Framework 4.0 Client Japanese Language Pack

• Microsoft .NET Framework 4.0 Full Japanese Language Pack

Improved Script Editors for Creating and Modifying InstallScript Code, SQL Scripts, VBScript Custom
Actions, and JScript Custom Actions
Several views in InstallShield have an improved script editor that you can use to write code for your projects. The script
editors include the following improvements:

• Expanded auto completion—When you are typing in a script editor, InstallShield displays a pop-up list of
alphabetically ordered functions, keywords, and constants that begin with the letters that you are typing. Instead of
manually typing the entire word, you can select it in the pop-up list, and InstallShield adds it to your script.

If you are using the script editor in the InstallScript view, you can enter the string constant operator (@) to see a pop-
up list of the available string identifiers. You can select the appropriate one in the list, and InstallShield adds it to your
script.

If auto completion for local variables is also enabled, the pop-up list in the script editor of the InstallScript view also
contains local variables.

Auto completion can increase your efficiency because it can reduce the time that you spend typing code. It can also
help you avoid typographical errors in your code.

The script editor in the InstallScript view of earlier versions of InstallShield is the only script editor that provided some
auto completion support; thus, auto completion functionality was not available for SQL scripts, VBScript code, or
JScript code. In addition, the available pop-up list was limited to InstallScript functions; none of the keywords,
constants, local variables, or string identifiers were available for auto completion.

• Detailed InstallScript Function Call Tips—If function call tips are enabled, InstallShield shows InstallScript function
call tips—a type of tooltip—when you are entering function calls in your script in the InstallScript view. A function call
tip shows a built-in function’s parameter information. It also shows a description of the built-in function, as well as a
description of the parameter that you are entering. The detailed call tips enable you to see help information about a
function without switching from the script editor to the help library, and then back to the script editor.

The InstallScript view in earlier versions of InstallShield included support for call tips, but the call tips did not display
as much information. The call tips showed a function call with all of the function’s parameters; however, the call tips
did not include a description of the function, or of the parameter that you are entering.

• Syntax folding—InstallShield now lets you specify whether you want the script editors in various views in
InstallShield to include support for syntax folding. When syntax folding is enabled, InstallShield adds a plus sign (+) or
a minus sign (–) in the margin next to each line of code that starts an expandable or collapsible block of script. You can
click a plus sign to expand hidden code, or a minus sign to hide visible code.

Syntax folding can help you minimize the clutter of large scripts and focus on the code that is relevant to the work that
you are currently doing. It can also help you see the overall structure of a script.

The views that contain the improved script editor are the InstallScript view, the SQL Scripts view, and the Custom Actions
and Sequences view (when you are viewing a VBScript or JScript file in this view).

By default, syntax folding is disabled in the script editors; auto completion, local variable auto completion, and function
call tips are enabled. To enable or disable any of the aforementioned functionality, use the Script Editor Properties dialog
box. This dialog box also lets you modify other settings in the script editors, such as font, syntax colors, and line numbering.
To access this dialog box, right-click in a script editor and then click Properties.

InstallShield 2020 User Guide ISP-2600-UG00 183

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more information, see the following:

• Working with the Script Editor Pane in Various Views

• Using Auto Completion when Writing Code in the Script Editors

• Viewing Function Call Tips for an InstallScript Function in the Script Editor

• Changing Colors for Syntax Highlighting in the Script Editors

• Enabling or Disabling Syntax Folding in the Script Editors

• Keyboard Shortcuts for the Script Editors

• Script Editor Properties Dialog Box

Ability to Create 64-Bit Microsoft App-V Packages

The Microsoft App-V Assistant in InstallShield includes support for converting a 64-bit Windows Installer package into a 64-
bit Microsoft App-V package, which can be deployed on 64-bit Windows systems with the 64-bit Microsoft App-V 4.6 client.
This, in combination with the new 64-bit repackaging support that is available with the Repackager, enables you to convert
any 64-bit installation into a 64-bit App-V package.

It is recommended that you perform the conversion of 64-bit Windows Installer packages to App-V packages on a 64-bit
Windows system. If you attempt the conversion on a 32-bit system, it could result in a failure to extract COM information for
64-bit binaries. Also, in some cases, Windows Installer packages contain shortcuts that target executable files that are not
found in the package itself. If these shortcuts target executable files are found in 64-bit locations, these shortcuts are not
handled correctly on 32-bit systems.

The Microsoft App-V Assistant is available if you purchase the Premier Edition of InstallShield.

Ability to Specify a Search Path for InstallShield Prerequisites; Path Variable and Relative Path Support
for Source Locations of Prerequisite Files
InstallShield now lets you specify the folders where InstallShield should search for InstallShield prerequisite files (.prq
files). This functionality makes it easier for teams of users to share InstallShield prerequisites with each other, and for
storing prerequisites in source code control. Previously, InstallShield searched for .prq files in the following location only:
InstallShield Program Files Folder\SetupPrerequisites.

InstallShield offers several ways for specifying the folders:

• If you are editing or building from within InstallShield, use the new Prerequisites tab on the Options dialog box—which
is displayed when you click Options on the Tools menu—to specify a comma-delimited list of machine-wide folders
and current-user folders. This tab is similar to the Merge Modules tab on the Options dialog box, which lets you specify
search paths for merge modules.

• If you are building from the command line with ISCmdBld.exe, use the new -prqpath parameter to specify a comma-
delimited list of folders.

If you use an .ini file to specify ISCmdBld.exe parameters, you can use the new PrerequisitePath parameter in the
[Mode] section of your .ini file to specify a comma-delimited list of folders.

• If you are building through MSBuild or Team Foundation Server (TFS), use the new PrerequisitePath parameter on the
InstallShield task. This parameter is exposed as the ItemGroup InstallShieldPrerequisitePath when the default targets
file is used. To specify multiple paths, use an ordered array of paths.

184 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

When you are using the Files to Include tab in the InstallShield Prerequisite Editor to add files to an InstallShield
prerequisite, the editor now uses predefined path variables such as <WindowsFolder> and <ISProductFolder> if
appropriate. In addition, if the files that you are adding are stored in the same folder as the InstallShield prerequisite’s .prq
file—or a subfolder of the folder that contains the .prq file—the InstallShield Prerequisite Editor uses a relative path for the
file in the .prq file. Note that if you view the file’s path on the Files to Include tab, the InstallShield Prerequisite Editor lists
the full path, not the relative path.

Note that if you use the Save As command in the InstallShield Prerequisite Editor to change the location of a .prq file, the
InstallShield Prerequisite Editor updates the paths of the prerequisite’s files if appropriate.

To learn more, see:

• Specifying the Directories that Contain InstallShield Prerequisites

• Prerequisites Tab

• ISCmdBld.exe

• Passing Command-Line Build Parameters in an .ini File

• Microsoft Build Engine (MSBuild)

New Hyperlink Control for Windows Installer–Based Dialogs

The Controls toolbar includes a new hyperlink control that you can use in the Dialogs view for Windows Installer–based
dialogs. The hyperlink control displays an HTML link; clicking the link at run time opens a page in the default browser on
the target system.

Windows Installer 5 includes support for this new hyperlink control. If this control is used on a dialog that is displayed on a
system that has an earlier version of Windows Installer, run-time error 2885 occurs, and the installation aborts. Therefore, if
you want to use the hyperlink control on a dialog but your installation targets systems that have Windows Installer 4.5 or
earlier, it is recommended that you include two versions of the dialog in your project: one with the hyperlink control, and
one without it. Add conditions to the dialogs to show or hide them, depending on the version of Windows Installer that is
present.

This feature is available in the following project types: Basic MSI and Merge Module.

To learn more, see Hyperlink Control.

Ability to Specify a Custom Icon and Custom Version Resource Properties for Setup.exe and Update.exe
InstallShield now lets you use a custom icon and custom version resource properties for Setup.exe files that you create at
build time. The icon and the version resource properties are displayed on the Properties dialog box for Setup.exe; this
Properties dialog box opens when end users right-click the Setup.exe file and then click Properties. End users can also see
the icon when they view your Setup.exe file in Windows Explorer. This support is available in Basic MSI, InstallScript, and
InstallScript MSI projects.

The same functionality (the ability to specify a custom icon and custom version resource properties) is also now available
for Update.exe files that you create in Basic MSI, InstallScript MSI, and QuickPatch projects.

Custom Icon for Setup.exe and Update.exe

The Setup.exe tab in the Releases view has a Setup.exe Icon File setting that lets you specify the icon that should be used
for your Setup.exe setup launcher. The icon can be in an .exe, .dll, or .ico file. If you do not specify an icon, InstallShield
uses a default icon for your Setup.exe file.

InstallShield 2020 User Guide ISP-2600-UG00 185

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Previously, support for specifying a custom Setup.exe icon was available for InstallScript projects if the Setup.exe file that
you were building was a self-extracting, single-file setup launcher. The support was not available in Basic MSI or
InstallScript MSI projects. In addition, it was not available for uncompressed InstallScript installations.

A new Icon setting lets you specify the icon that should be used for your Update.exe launcher. This setting is available on
the Advanced tab for a patch configuration in the Patch Design view of Basic MSI and InstallScript MSI projects. It is also
available on the Advanced tab of the Build Settings area in the General Information view of QuickPatch projects. If you do
not specify an icon, InstallShield uses a default icon for your Update.exe file.

Previously, InstallShield did not include any support for specifying a custom icon for Update.exe files.

Custom Version Resource Properties for Setup.exe and Update.exe

When InstallShield is configuring the following version resources of your Setup.exe setup launcher at build time, it now
uses the custom information that you entered in the General Information view and the Releases view:

• Company name

• Product name

• Product version

• Copyright

• File version

• File description

To use a custom copyright notice and a custom file description, ensure that you select Yes in the Use Custom Version
Properties setting for the release in the Releases view.

Previously, InstallShield did not use any custom information in many cases. For example, the InstallScript Setup.exe files
that InstallShield previously created contained details that pertained to the version of InstallShield that was used to build
the Setup.exe file. Thus, the product name that was displayed in the Setup.exe Properties dialog box was InstallShield,
rather than the name of your product.

Several new settings—Company Name, Product Name, Product Version, Description, and Copyright—let you specify the
custom information that you want InstallShield to use when you build an Update.exe file. These settings are available on
the Advanced tab for a patch configuration in the Patch Design view of Basic MSI and InstallScript MSI projects.They are
also available on the Advanced tab of the Build Settings area in the General Information view of QuickPatch projects.

Previously, InstallShield did not use any custom version resource information for Update.exe files.

To learn more, see:

• Specifying the Icon for the Setup Launcher

• Customizing File Properties for the Setup Launcher

• Setup.exe Tab for a Release

• Specifying the Icon for the Update Launcher

• Customizing File Properties for the Update Launcher

• Advanced Tab (in the Patch Design view)

• Advanced Tab (for a QuickPatch project)

186 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Ability to Specify Commands that Run Before, During, and After Builds
The Premier edition of InstallShield includes new release settings that you can use to specify commands that you want to
be run at various stages of the build process. These new settings are available on a new Events tab when you select a
release in the Releases view:

• Prebuild Event—Use this setting to specify the command that you want to be run before InstallShield starts building
the release. This event runs after InstallShield creates the release folder and log file, but before InstallShield starts
building the release.

This setting is available in the following project types: Basic MSI, InstallScript, InstallScript MSI, and Merge Module.

• Precompression Event—Use this setting to specify the command that you want to be run after InstallShield has built
the .msi package and the .cab files (if your product’s data files are to be stored in .cab files). Note that this event occurs
after .cab files are streamed into the .msi package, but before the .msi package has been digitally signed and streamed
into the Setup.exe file.

This setting is available in the following project types: Basic MSI and InstallScript MSI.

• Postbuild Event—Use this setting to specify the command that you want to be run after InstallShield has built and
signed the release.

This setting is available in the following project types: Basic MSI, InstallScript, InstallScript MSI, and Merge Module.

The new Events tab replaces the previously available Postbuild tab. Note that the settings that were previously available
on the Postbuild tab are now displayed on the new Events tab. In addition, the publish-related settings that were
previously available on the Build tab in Merge Module projects have been moved to the Events tab.

The automation interface now includes support for the new build event settings. The ISWiRelease object includes three
new properties that let you specify commands for various stages of the build process:

• PrebuildEvent

• PrecompressionEvent

• PostbuildEvent

To learn more, see:

• Specifying Commands that Run Before, During, and After Builds

• Events Tab for a Release

• ISWiRelease Object

Ability to Set an Expiration Date for Setup.exe

InstallShield now lets you set an expiration date, as well as an expiration message, for Setup.exe. If end users try to run
Setup.exe on or after the date that you have specified in your project, the expiration message is displayed, and the
installation exits.

To set an expiration date and a message for your Setup.exe file, use the new Expiration Date and Expiration Message
settings on the Setup.exe tab for a selected release in the Releases view. By default, no expiration date is configured for
Setup.exe. If you specify an expiration date, you can use the default expiration message, or specify your own custom
message.

The automation interface now includes support for these new settings. The ISWiRelease object includes two new
properties that let you set the expiration date and message: ExpirationDate and ExpirationMessage.

InstallShield 2020 User Guide ISP-2600-UG00 187

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

This feature is available in the following project types: Basic MSI and InstallScript MSI.

For more information, see:

• Setup.exe Tab for a Release

• ISWiRelease Object

Ability to Import Visual Studio Setup and Merge Module Projects into Existing InstallShield Projects;
Improvements for the Project Converter
InstallShield now lets you import a Visual Studio setup project (.vdproj) into an InstallShield Basic MSI or Merge Module
project (.ism), or import a Visual Studio merge module project (.vdproj) into an InstallShield Basic MSI or Merge Module
project (.ism). These tasks enable you to develop InstallShield installation and merge module projects that contain the
same data and settings that were in your Visual Studio project. The wizard imports the project outputs, files, registry keys,
file extensions, custom actions, target system searches, and launch conditions from your Visual Studio project into your
existing InstallShield project.

To import a Visual Studio project into an existing InstallShield project, use the new Visual Studio Deployment Project
Import Wizard in InstallShield. The wizard lets you choose whether to import or ignore certain settings in the Visual Studio
project.

The existing support for converting a Visual Studio project into a new InstallShield project has been expanded. If your
Visual Studio project contains predefined prerequisites, InstallShield now converts them to equivalent InstallShield
prerequisites during the conversion process. This same prerequisite conversion functionality is available if you use the new
wizard to import a Visual Studio project into an InstallShield project.

If your Visual Studio project contains one or more project outputs, use the import wizard instead of the conversion process.
The InstallShield project must be in the same Visual Studio solution that contains the Visual Studio setup or merge module
project and all of its project dependencies. Note that you must be using InstallShield from within Visual Studio when you
use the import wizard in order for the wizard to import the project outputs into your InstallShield project.

To learn more, see the following:

• Converting or Importing Visual Studio Projects into InstallShield Projects

• Visual Studio Deployment Project Import Wizard

Unicode and UTF-8 Support for SQL Scripts

InstallShield now has design-time and run-time support for SQL scripts that have either Unicode BOM encoding or UTF-8
BOM encoding. You can use the SQL Scripts view to add SQL scripts with either of these encoding types to your project. You
can also edit those SQL scripts from within that view as necessary. At run time, the SQL scripts are executed during
installation and uninstallation when needed.

Previously, InstallShield had run-time support but not design-time support for SQL scripts with Unicode BOM encoding.
Thus, when you added a script with this encoding to the SQL Scripts view of your project, InstallShield prompted you to
specify whether you wanted to convert the script to ANSI format. If you allowed InstallShield to convert it to ANSI, you
could edit it from within the SQL Scripts view. However, in some cases, it might have displayed and used garbled
characters at design time and at run time. If you did not allow InstallShield to convert it to ANSI, the file remained with
Unicode BOM encoding. Although this encoding allowed your installation to properly use strings in languages that did not
match the code page of the target system at run time, you could not view or edit the script from within InstallShield.

188 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

In addition, InstallShield previously did not have adequate support for SQL scripts with UTF-8 BOM encoding. If you added
a SQL script with this encoding type to your project and the script contained strings in a language that did not match the
code page of the development system, the SQL Scripts view treated the file as an ANSI file, and it may have displayed
garbled characters. In addition, garbled characters were used when your SQL script was executed at run time. Also, the
byte order mark was represented as garbled characters.

If you create a new SQL script from within the SQL Scripts view, InstallShield uses Unicode BOM encoding for the file. If you
prefer to use ANSI or UTF-8 BOM encoding for the SQL scripts view, it is recommended that you create an .sql file with the
proper encoding in a different tool, and then import or insert the script in the SQL Scripts view of your project.

This feature is available in the following project types: Basic MSI, InstallScript, and InstallScript MSI.

Predefined System Searches for SQL Server 2008 Express SP1 and Adobe Reader 9
InstallShield has new predefined system searches:

• SQL Server 2008 Express SP1

• Adobe Reader 9

If your installation requires one or both of these, you can use the System Search view or the Installation Requirements page
in the Project Assistant to add these system searches to your project. When end users launch your installation, Windows
Installer checks the target system to see if the requirements are met; if they are not met, the installation displays the error
message that is defined for the system search.

This feature applies to Basic MSI and InstallScript MSI projects.

Support for 64-Bit Managed-Code Custom Actions

InstallShield now has support for 64-bit managed-code custom actions. When you build a release that includes a managed-
code custom action in your project, InstallShield attempts to determine the target architecture (32 bit or 64 bit) of the main
.NET assembly that is associated with the custom action. InstallShield configures the release so that the appropriate
version of the .NET Framework—32 bit or 64 bit—is used to run your managed code at run time.

If you want to override the new default behavior, use the Direct Editor view to add a new record with the following fields to
the ISClrWrap table.

• Action_—Indicate the name of the managed-code custom action that you want to modify.

• Name—Enter the following: TargetPlatform

• Value—Specify the appropriate architecture. To use a 32-bit version of the .NET Framework, enter the following: x86

To use a 64-bit version of the .NET Framework, enter the following: x64

This feature is available in the following project types: Basic MSI, InstallScript MSI, and Merge Module.

To learn more, see Using 32-Bit vs. 64-Bit Managed-Code Custom Actions.

Support for 64-Bit .NET Installer Classes and COM Interop

InstallShield now has support for 64-bit .NET installer classes and COM interop. If you are using InstallShield on a 64-bit
system, the .NET tab on the Options dialog box—which is displayed when you click Options on the Tools menu in
InstallShield—now lets you specify different paths for the 32-bit and 64-bit locations of the Regasm.exe and
InstallUtilLib.dll files that are included with the .NET Framework. InstallShield uses the paths that you specify at build
time for releases that include .NET installer classes and COM interop.

InstallShield 2020 User Guide ISP-2600-UG00 189

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

If you are building from the command line with ISCmdBld.exe and you use the existing -t parameter to specify the path of
the 32-bit version of the .NET Framework, ISCmdBld.exe now uses the 64-bit location of Regasm.exe and
InstallUtilLib.dll when appropriate.

If you are building through MSBuild or Team Foundation Server (TFS) and you use the existing DotNetUtilPath parameter
on the InstallShield task to specify the path of the 32-bit version of the .NET Framework, the build now uses the 64-bit
location of Regasm.exe and InstallUtilLib.dll when appropriate.

To learn more, see:

• .NET Tab (on the Options dialog box)

• ISCmdBld.exe

• Microsoft Build Engine (MSBuild)

Support for Using the InstallScript Function DotNetCoCreateObject or Managed-Code Custom Actions
with DLLs that Target .NET Framework 4
If you create a DLL in Visual Studio 2010 and the DLL uses .NET Framework 4, you can now use the InstallScript function
DotNetCoCreateObject to call functions in this DLL. Previously, the installation crashed if the DLL used version 4 of the
.NET Framework, but not with earlier versions. This feature is available in the following project types: InstallScript and
InstallScript MSI; it is also available in Basic MSI and Merge Module projects with InstallScript custom actions.

In addition, you can now use the same sort of DLL file in a managed-code custom action. Previously, the installation
crashed if it contained a managed-code custom action for a DLL that used version 4 of the .NET Framework. This feature is
available in the following project types: Basic MSI, InstallScript MSI, Merge Module.

For more information, see:

• DotNetCoCreateObject

• Using 32-Bit vs. 64-Bit Managed-Code Custom Actions

Ability to Override the Values of Path Variables for a Release

InstallShield now lets you override the values of your project’s custom path variables (standard path variables,
environment path variables, and registry path variables) for each release in your project. This functionality enables you to
essentially replace certain files and folders in your project with others at build time, depending on the particular release
that you are building.

For example, you might use this functionality to swap out the binaries for custom actions. If you have set up separate
releases for 32-bit and 64-bit target systems, you can override the path variable that is used to refer to the DLL that is
selected for a custom action. Then InstallShield could include a 32-bit DLL for your 32-bit release and a 64-bit DLL for your
64-bit release. Note that overriding path variables to swap out files that your installation is installing is not recommended.
This is because you should use separate components for 32-bit and 64-bit versions of a file.

To override one or more path variables in your project, use the new Path Variables Overrides setting, which is on the Build
tab for a release in the Releases view. Note that if you override a path variable both in the new Path Variables Overrides
setting, and with the -l parameter to IsCmdBld.exe or through MSBuild, the command line or MSBuild value takes
precedence over the value that is set in the release setting.

The automation interface now includes support for this new setting. The ISWiRelease object includes a new
PathVariableOverrides property that lets you override the values of your project’s user-defined path variables,
environment variables, and registry variables for a release.

190 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

This feature is available in the following project types: Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, and
Merge Module.

To learn more, see the following:

• Overriding the Value of a Custom Path Variable for a Release

• Path Variable Overrides setting

• Path Variable Overrides Dialog Box

• ISWiRelease Object

Ability to Configure MIME Types for IIS Web Sites, Applications, and Virtual Directories
The Internet Information Services view has a new MIME Types setting that you can configure for a Web site, application, or
virtual directory in your project. This setting lets you identify the types of content that can be served from the Web server
on the target system to a browser or mail client.

This feature applies to the following project types: Basic MSI, InstallScript, and InstallScript MSI.

For more information, see:

• MIME Types setting for a Web site

• MIME Types setting for an application or virtual directory

Ability to Overwrite Existing IIS Application Pool or Only Create It If It Does Not Exist
The Internet Information Services view has a new Overwrite Existing Application Pool setting. This setting is displayed in
the right pane when you select an application pool in the Internet Information Services view. This setting lets you specify
the behavior that you want to occur if the selected application pool already exists on the target system at run time: the
installation can either overwrite the application pool's settings on the target system, or leave the application pool as is.
The default value for this setting is Yes, indicating the an existing application pool is overwritten at run time.

This feature applies to the following project types: Basic MSI, InstallScript, and InstallScript MSI.

For more information, see the description of the Overwrite Existing Application Pool setting for an application pool.

New Billboard Style in InstallScript and InstallScript MSI Projects

InstallScript and InstallScript MSI projects include support for a new style of billboard that is displayed above the progress
bar on the progress dialog. This style of billboard supports Adobe Flash application files (.swf), as well as image files (.bmp,
.gif, .jpg, and .jpeg).

If a project contains both Flash files and image files but a target system does not have the Adobe Flash Player, the
installation can detect that and display image billboards in place of the Flash billboard.

Previously, the only available billboard support in InstallScript and InstallScript MSI projects required the use of a
background window. The new billboard style does not require a background window.

To add the new style of billboard to a project, use the Support Files/Billboards view to add billboard files to your project. To
display this new style of billboard at run time, use the new STATUSBBRD constant with the Enable function.

Note that the new style of billboard is not available in projects that use skinned dialogs.

To learn more, see:

• Displaying Billboards in InstallScript and InstallScript MSI Installations

InstallShield 2020 User Guide ISP-2600-UG00 191

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Billboard Styles and File Types for InstallScript and InstallScript MSI Projects

• Adding or Modifying the Code in an InstallScript or InstallScript MSI Project to Display Billboards

• Adding an Adobe Flash Application File Billboard to an InstallScript or InstallScript MSI Project

• Adding an Image Billboard to an InstallScript or InstallScript MSI Project

• Naming Billboard Files in an InstallScript or InstallScript MSI Project

Support for Looping Through Image Billboards in Basic MSI Projects

The Billboards view in Basic MSI projects has a new Loop Billboards setting that lets you specify whether you want your
installation to continuously loop the image billboards until the file transfer completes and the installation displays the
appropriate SetupComplete dialog.

If you select Yes for this setting and the file transfer takes more time than you have allocated for the billboards, the
installation restarts the display of billboards from the beginning. The loop continues, if necessary, until the file transfer
ends. The default value for this setting is No, which matches the behavior in earlier versions of InstallShield.

Previously, if the file transfer took more time than what you had allocated for the billboards, the installation continued to
display the last billboard until the file transfer finished; it did not loop the billboards.

For more information, see:

• Run-Time Behavior of a Basic MSI Installation that Includes Billboards

• Billboard Settings

Windows Installer 5 Support for Configuring Windows Service Permissions

InstallShield now includes support for configuring permissions for Windows services; this support uses the
MsiLockPermissionsEx table that was introduced with Windows Installer 5. Windows Installer 5 supports the new service
permission settings; earlier versions of Windows Installer ignore them.

To configure the new permission settings for a service, use the Services node in the Advanced Settings area for a
component in the Setup Design view (in installation projects) or the Components view. The Services node is where you add
new services to your project. When you select a subnode under the Services node, you can configure the settings—
including the new permission-related settings—of that service in the right pane.

This functionality is available in the following project types: Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM
Database, and Transform.

For more information, see:

• Securing Files, Folders, Registry Keys, and Windows Services in a Locked-Down Environment

• Services Settings

Automation Interface Support for Configuring Dynamic File Links in InstallScript Projects
The ISWiDynamicFileLinking object and the ISWiDynamicFileLinkings collection of the automation interface now include
support for dynamic file links in InstallScript projects. In addition, two methods and a property of the ISWiComponent
object are now applicable to InstallScript projects: the AddDynamicFileLinking method lets you add a new dynamic file link
to a component, the RemoveDynamicFileLinking method lets you remove a component’s dynamic file links, and the
ISWiDynamicFileLinkings property lets you get a component’s collection of dynamic file links. The read-only DynamicFile
property for the ISWiFile object is also now applicable to InstallScript projects: use this property to determine whether the
file’s source is linked to the component dynamically or statically.

192 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more details, see:

• ISWiDynamicFileLinking Object

• ISWiDynamicFileLinkings Collection

• ISWiComponent Object

• AddDynamicFileLinking Method

• RemoveDynamicFileLinking Method

• ISWiFile Object

New FlexNet Connect 12.01 Redistributables Available

InstallShield includes support for FlexNet Connect 12.01 in Basic MSI and InstallScript MSI projects. Use the Update
Notifications view in InstallShield to include one of the two FlexNet Connect 12.01 merge modules—one has the Common
Software Manager, and the other does not.

Enhancements
InstallShield includes the following enhancements.

Unicode Views in InstallShield

Several views and areas in InstallShield have been enhanced to display and allow you to enter characters from all
languages. For example, now you can use Chinese characters in file names, paths, and registry entries if you are configuring
system searches in the System Search view on an English machine. Previously, the characters were displayed in these areas
of InstallShield as question marks.

The areas in InstallShield that have been enhanced to include the Unicode support are the System Search view, the tabs for
a release in the Releases view, and the Multiple Instances tab for a release in the Releases view. Note that Unicode support
was previously introduced in many other views in InstallShield 2010.

The improvements for the System Search view are applicable to the following projects: Basic MSI, InstallScript MSI, Merge
Module, MSI Database, MSM Database, and Transform.

The improvements for the tabs for a release in the Releases view are applicable to the following projects: Basic MSI,
InstallScript, InstallScript MSI, InstallScript Object, and Merge Module.

The improvements for the Multiple Instances tab in the Releases view are applicable to Basic MSI projects.

Command-Line Support for Generating a Log File While Using InstallShield MSI Diff
InstallShield MSI Diff includes a new /out command-line parameter. You can use this new parameter while running
InstallShield MSI Diff from the command line to generate a log file that identifies the differences between two .msi, .msm,
or .pcp files, or that shows the differences that are applied to a Windows Installer database by a transform (.mst) or patch
file (.msp). You can also use this tool from the command line to generate a log file that identifies the differences between
two InstallShield project files (.ism or .ise) that are saved in binary format.

To learn more, see Running InstallShield MSI Diff from the Command Line to Generate a Log File of Differences.

InstallShield 2020 User Guide ISP-2600-UG00 193

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Support for Listing Local Microsoft SQL Server Instances on 64-Bit Systems
If you add SQL support to a project through the SQL Scripts view in InstallShield and the installation is run on a 64-bit target
system, the built-in SQL-related run-time dialogs now list 64-bit local SQL Server instances, as well as 32-bit local SQL
Server instances, 32-bit network SQL Server instances, and 64-bit network SQL Server instances. Previously when the
installation was run on a 64-bit target system, the built-in SQL-related run-time dialogs did not list any 64-bit local SQL
Server instances; they listed only 32-bit local instances, 32-bit network instances, and 64-bit network instances.

This functionality is available in the following project types: Basic MSI, InstallScript, and InstallScript MSI.

InstallScript Logging and Uninstallation of 64-Bit Registry Changes

By default, the InstallScript engine now logs the changes that it makes to the 64-bit part of the registry during an
InstallScript or InstallScript MSI installation on 64-bit target systems. Furthermore, the 64-bit registry changes that are
logged by the InstallScript engine are now uninstalled during uninstallation.

Previously, if the InstallScript engine made changes to the 64-bit part of the registry during an installation, those changes
were not logged as 64 bit specific, so they were not removed during uninstallation.

Support for Microsoft SQL Server Management Studio

The SQL Scripts view now includes support for Microsoft SQL Server Management Studio. To open a SQL script file of your
project in SQL Server Management Studio, right-click the SQL script file in the SQL Scripts view and then click Open Script
in Microsoft SQL Server Management Studio. This new command replaces the Open Script in Microsoft Query Analyzer
command on the same context menu.

This functionality is available in the following project types: Basic MSI, InstallScript, and InstallScript MSI.

Support for Adding Project Outputs from Visual Studio Web Setup Projects
If you create a Visual Studio solution that includes a Web setup project and an InstallShield installation project and you are
using InstallShield from within Visual Studio, you can now add project outputs from the Web setup project to your
InstallShield project.

Ability to Select a Windows Installer Property when Configuring a Text File Change
Two settings in the Text File Changes view have been enhanced to make it easier to configure search-and-replace behavior
for content in text files. The Find What and Replace What settings, which are displayed in the right pane when you select a
replacement node in the Text File Changes view, now let you select a Windows Installer property from a list, or type a
string. The list consists of all of the properties that are available in the Property Manager view of your project. Previously,
you could manually enter a string or a property in these settings, but the list of properties was not available.

This enhancement is available in the following project types: Basic MSI and InstallScript MSI.

InstallScript Text Substitution Improvements for Resolving Environment Variable Paths in

IISROOTFOLDER
InstallScript installations now have support for installing IIS data to IISROOTFOLDER if the IIS PathWWWRoot registry value
contains an environment variable. Previously, when text substitution was performed for the IISROOTFOLDER variable in an
InstallScript installation that included IIS support, the environment variable part of the path of IISROOTFOLDER was not
resolved on Windows Server 2008 and later systems. If any components were configured to be installed to IISROOTFOLDER,
they failed to install because the unresolved path was an invalid path.

194 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Ability to Specify the Required Execution Level for Update.exe Manifests

The Required Execution Level setting is now available on the Advanced tab for a patch configuration in the Patch Design
view of Basic MSI and InstallScript MSI projects. It is also available on the Advanced tab of the Build Settings area in the
General Information view of QuickPatch projects.

Use these new settings to specify the minimum execution level that is required by your installation’s Update.exe file for
running the upgrade on Windows Vista and later platforms. InstallShield adds a manifest that specifies the required level.
By default, InstallShield uses the level that was configured in the previous setup launcher’s manifest.

Previously, the Required Execution Level setting was available only for the Setup.exe setup launchers. If you created an
Update.exe patch, InstallShield used the same required execution level that was configured in the previous setup
launcher’s manifest.

To learn more, see:

• Advanced Tab (in the Patch Design view)

• Advanced Tab (for a QuickPatch project)

Ability to Create .cab Files Without Compression

A new Cab Optimization Type setting is available on the Build tab for a release that is selected in the Releases view. If
Compressed or one of the custom options is selected for the Compression setting, use the Cab Optimization Type setting to
specify the type of compression that InstallShield should use when building the release’s .cab files. The available options
are LZX compression, MSZIP compression, or no compression.

The Cab Optimization Type setting replaces the Optimize Size setting, which had support for only LZX compression and
MSZIP compression; it did not let you skip compression.

The automation interface now includes support for this new setting. The ISWiRelease object includes a new
CabCompressionType property that lets you specify which of the three compression options you want to use when you
build a release through the automation interface.

This enhancement is available in the following project types: Basic MSI and InstallScript MSI.

For more information, see Build Tab for a Release.

Expanded List of Predefined Operating System Conditions in the InstallShield Prerequisite Editor
The Prerequisite Condition dialog box, which is displayed when you are adding or modifying a condition for an InstallShield
prerequisite in the InstallShield Prerequisite Editor, now has predefined operating system conditions for Windows Server
2008 R2. Some of the Windows 7 options have been renamed to make it more clear which versions of Windows are checked,
since some of the options check for the workstation version, the server version, or either version. The Prerequisite
Condition dialog box also has new options that check only for Windows 7, not Windows Server 2008 R2. These changes let
you quickly define more-targeted operating system conditions for any InstallShield prerequisites.

You can add InstallShield prerequisites to the following project types: Basic MSI, InstallScript, and InstallScript MSI.

New Refresh Button in the Redistributables and Prerequisites Views

The Redistributables view (in Basic MSI, InstallScript MSI, and Transform projects) and the Prerequisites view (in
InstallScript projects) contains a new Refresh button that you can use to refresh the list of redistributables that are
displayed in the view. Previously, if you added redistributables to your machine when either view was open in InstallShield,
it was necessary to close and then reopen the project in order to see an updated list in the view.

This enhancement is available in the following project types: Basic MSI, InstallScript, InstallScript MSI, and Transform.

InstallShield 2020 User Guide ISP-2600-UG00 195

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Support for Setting Permissions for the IUSR User Account

InstallShield now has support for securing files, folders, and registry keys for the well-known user account IUSR.

If you are using the custom InstallShield handling method of configuring permissions in your project, the User list on the
Permissions dialog box has a new IUSR option. To use the custom InstallShield handling method, select this option in the
Locked-Down Permissions setting in the General Information view. This functionality is available in the following project
types: Basic MSI, InstallScript MSI, Merge Module, and Transform.

If you are using the InstallScript function SetObjectPermissions to set permissions, you can now pass IUSR for the szUser
parameter. This functionality is available in InstallScript events in the following project types: InstallScript and InstallScript
MSI. This functionality is also available through InstallScript custom actions in Basic MSI, InstallScript MSI, and Merge
Module projects.

New IS_PERMISSIONS_OPTION_ALLOW_ACCESS Constant for the SetObjectPermissions Function

A new IS_PERMISSIONS_OPTION_ALLOW_ACCESS constant is available for use with the InstallScript function
SetObjectPermissions. You can pass this constant instead of the number 0 in the nOptions parameter of
SetObjectPermissions to indicate that the permissions that are being set should allow access to the specified file, folder,
or registry key.

This functionality is available in InstallScript events in the following project types: InstallScript and InstallScript MSI. This
functionality is also available through InstallScript custom actions in Basic MSI, InstallScript MSI, and Merge Module
projects.

For more information, see SetObjectPermissions

New Constants for the DialogSetInfo Function

Two new constants are available for the nParameter parameter of the InstallScript function DialogSetInfo when you are
using DLG_INFO_ALTIMAGE for the nInfoType parameter:

• DLG_INFO_ALTIMAGE_VERIFY_BMP—This constant specifies that the bitmap that is indicated by szInfoString should
be used in subsequent dialogs. Before this bitmap is used, the installation checks for the existence of the bitmap. If the
bitmap does not exist, the function returns an error that indicates that the bitmap was not found.

• DLG_INFO_ALTIMAGE_REVERT_IMAGE—This constant specifies that dialogs should display the default bitmap. This
constant is an alternative equivalent to the value of -1. The installation does not check for the existence of the bitmap
when you use this constant.

If you pass TRUE in the nParameter parameter, the installation does not check for the existence of the bitmap; if the bitmap
does not exist in this scenario, the function does not return an error.

This functionality is available in InstallScript events in the following project types: InstallScript and InstallScript MSI.

For more information, see DialogSetInfo.

Enhancements for .NET Framework 4.0 Support

A new FOLDER_DOTNET_40 InstallScript variable is available. This variable stores the path of the .NET Framework 4.0 files.

Two new constants are available for use with the function Is:

• REGDB_KEYPATH_DOTNET_40_CLIENT

• REGDB_KEYPATH_DOTNET_40_FULL

196 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Path Variable Support for Each Patch Configuration’s Output Location and Cache
The Common tab for a patch configuration that is selected in the Patch Design view contains two settings that let you
browse to the appropriate folder: Patch Output Location and Patch Creation Cache. InstallShield now lets you use path
variables for the folders instead of absolute paths. This support makes it easier to build releases on different build and
development machines that use different directory structures.

This support is available if InstallShield is configured to use path variables on your system. (That is, the Path Variables tab
on the Options dialog box must be configured to allow path variable support.) If you configure InstallShield to use absolute
paths, the Patch Design view shows the absolute path to folders.

This enhancement is available in the following project types: Basic MSI and InstallScript MSI.

InstallScript Functions ServiceExistsService and ServiceGetServiceState No Longer Require Elevated

Privileges
The InstallScript functions ServiceExistsService and ServiceGetServiceState no longer require elevated privileges.
Therefore, installations can now call these functions when end users have limited privileges, such as in the Install UI
sequence of a Basic MSI installation.

Important Information

Installing More than One Edition of InstallShield

Only one edition of InstallShield 2020—Premier, Professional, or Express—can be installed on a system at a time.

Installing More than One Version of InstallShield

InstallShield 2020 can coexist on the same machine with other versions of InstallShield.

The InstallShield 2020 Standalone Build can coexist on the same machine with other versions of the Standalone Build. In
most cases, the Standalone Build is not installed on the same machine where InstallShield is installed. If you do install both
on the same machine and you want to use the automation interface, review the Installing the Standalone Build and
InstallShield on the Same Machine to learn about special registration and uninstallation considerations.

Integrating InstallShield with Visual Studio

Microsoft Visual Studio can be integrated with only one version of InstallShield at a time. The last version of InstallShield
that is installed or repaired on a system is the one that is used for Visual Studio integration.

See Also
Upgrading Projects from InstallShield 2010 or Earlier
Upgrading Projects from InstallShield 2009 or Earlier
Upgrading Projects from InstallShield 2008 or Earlier
Upgrading Projects from InstallShield 12 or Earlier
Upgrading Projects from InstallShield 11.5 or Earlier

InstallShield 2020 User Guide ISP-2600-UG00 197

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

What’s New in InstallShield 2010 Expansion Pack for Visual

Studio 2010
InstallShield 2020

InstallShield 2010 Expansion Pack for Visual Studio 2010 includes changes that offer support for the final released version
of Visual Studio 2010 and .NET Framework 4. It also includes additional changes.

Microsoft .NET Framework 4 Prerequisites

InstallShield includes four new .NET-related InstallShield prerequisites that you can add to Basic MSI, InstallScript, and
InstallScript MSI projects:

• Microsoft .NET Framework 4.0 Full

• Microsoft .NET Framework 4.0 Full (Web Download)

• Microsoft .NET Framework 4.0 Client

• Microsoft .NET Framework 4.0 Client (Web Download)

Note the following details about these prerequisites:

• The full prerequisites install the .NET Framework runtime and associated files that are required to run and develop
applications that target the .NET Framework 4.

• The client prerequisites install the .NET Framework runtime and associated files that are required to run most client
applications.

• The two Web download prerequisites require an Internet connection. These prerequisites download the required
redistributable files if appropriate. The other two prerequisites are stand-alone installations that do not require an
Internet connection.

The .NET Framework 4.0 requires Windows Installer 3.1 or later, as well as the Windows Imaging Component. Therefore,
the .NET Framework 4.0 Full prerequisites are configured to have dependencies for the following InstallShield
prerequisites:

• Windows Installer 3.1 (x86)

• Windows Imaging Component (x86)

• Windows Installer 3.1 for Windows Server 2003 SP1 (x86)

• Windows Imaging Component (x64)

• Windows Installer 3.1 for Windows Server 2003 SP1 (IA64)

• Windows Installer 3.1 for Windows Server 2003 SP1 (x64)

• Windows Installer 3.1 for Windows XP (x64)

In addition, the .NET Framework 4.0 Client prerequisites are configured to have dependencies for the following
InstallShield prerequisites:

• Windows Installer 3.1 (x86)

• Windows Imaging Component (x86)

• Windows Installer 3.1 for Windows Server 2003 SP1 (x86)

198 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Windows Imaging Component (x64)

• Windows Installer 3.1 for Windows Server 2003 SP1 (x64)

• Windows Installer 3.1 for Windows XP (x64)

Thus, if you add any of the .NET Framework 4.0 prerequisites to your project, InstallShield also adds prerequisites for
Windows Installer and Windows Imaging Component to your installation automatically by default. This could increase the
size of your installation. In some cases, you may want to edit the .NET Framework 4 prerequisites in the InstallShield
Prerequisite Editor (which is available in the Premier and Professional editions of InstallShield) to remove some of the
dependencies. For example, if your product requires Windows Vista or later or Windows Server 2008 and later, you may
want to remove the Windows Installer 3.1 dependencies that target earlier versions of Windows.

Additional Prerequisites for Visual Studio 2010 Support

InstallShield includes the following new InstallShield prerequisites that you can add to Basic MSI, InstallScript, and
InstallScript MSI projects:

• Microsoft SQL CE 3.5 SP2

• Microsoft ReportViewer 2010

• Microsoft VSTO 2010 Runtime

• FSharp Redistributable Package 2.0

• Microsoft Office 2007 PIA (This prerequisite installs the Microsoft Office 2007 Primary Interop Assemblies. To use this
prerequisite, download the PrimaryInteropAssembly.exe file from Microsoft’s Web site and run it to extract the
o2007pia.msi file. Note that you may need to change the path of the o2007pia.msi installation in the .prq file,
depending on where the .msi package is located on your system.)

Predefined System Searches for .NET Framework 4

InstallShield includes two new predefined system searches:

• Microsoft .NET Framework 4.0 Full package

• Microsoft .NET Framework 4.0 Client package

If your installation requires either of these, you can use the Installation Requirements page in the Project Assistant or the
System Search view to add these system searches to your project. When end users launch your installation, Windows
Installer checks the target system to see if the requirements are met; if they are not met, the installation displays the error
message that is defined for the system search.

This functionality applies to Basic MSI and InstallScript MSI projects.

See Also
What’s New in InstallShield 2010
Upgrading Projects from InstallShield 2009 or Earlier

What’s New in InstallShield 2010 SP1

InstallShield 2020

InstallShield 2010 Service Pack 1 (SP1) includes changes that offer support for the final released versions of Windows 7,
Windows Server 2008 R2, and Windows Installer 4.5. It also includes additional changes.

InstallShield 2020 User Guide ISP-2600-UG00 199

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Important • If you want to open an InstallShield 2010 project in InstallShield 2010 SP1, you must allow InstallShield to
upgrade your project to InstallShield 2010 SP1. InstallShield 2010 SP1 includes support for tables that were not available in
InstallShield 2010 projects, and these tables need to be added during the upgrade. Note that it is not possible to open
InstallShield 2010 SP1 projects in earlier versions of InstallShield (including InstallShield 2010 without SP1). Therefore, if
multiple users need to open and modify your InstallShield projects, ensure that all of you apply the SP1 patch at the same
time.

If you open an InstallShield 2010 project in InstallShield 2010 SP1, InstallShield 2010 SP1 displays a message box that asks you
if you want to convert the project to the new version. If you reply that you do want to convert it, InstallShield creates a backup
copy of the project before converting it.

Setup.exe Manifests Now Have Compatibility Section to Avoid Triggering Program

Compatibility Assistant on Windows 7 and Windows Server 2008 R2 Systems
If you configure your InstallShield project to create a setup launcher for your installation, the manifest that InstallShield
creates for the setup launcher now includes a compatibility section. Previously, without this compatibility section, a
Program Compatibility Assistant (PCA) dialog box may have appeared at the end of an installation on Windows 7 and
Windows Server 2008 R2 systems. The PCA dialog box indicated that the program might not have installed correctly. This
dialog box was displayed if the installation did not create the application uninstallation key. This may happen if the end
user cancels the installation or the installation fails to complete successfully.

Support for Creating App-V Package Upgrades and for Compressing App-V Packages
InstallShield now has support for creating App-V package upgrades. The Package Information page in the Microsoft App-V
Assistant has a new Upgrade Settings link. Click this link to specify whether you want to create an upgrade. If you specify
that you do want to create an upgrade, you can specify additional information about the upgrade, such as whether to
append the version number to the App-V package file name. By default, App-V package upgrades are not created.

The Build Options page in the Microsoft App-V Assistant has a new setting that lets you specify whether you want to use
compression for the data files in the App-V package. If you select Yes for this setting, InstallShield uses zlib compression for
your App-V package.

The App-V upgrade and compression functionality is available in the following project types: Basic MSI and MSI Database.

The Microsoft App-V Assistant is available if you purchase the Premier Edition of InstallShield.

For more information, see:

• Specifying Upgrade Package Information

• Specifying Whether to Compress the Data Files in an App-V Package

Windows Installer 5 Support for Configuring New Customization Options for Windows
Services, Plus Other Service-Related Improvements
InstallShield now includes support for configuring extended customization options for Windows services. The
customization options include a new delayed auto-start capability to help system startup performance, improved failure
detection and recovery options to improve system reliability, and more. Windows Installer 5 supports these new options;
earlier versions of Windows Installer ignore them.

200 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

To configure the new service-related settings, use the new Services node in the Advanced Settings area for a component in
the Setup Design view (in installation projects) or the Components view. All of the services for a component are now
grouped and listed by service name under the Services node. In addition, the previously available service-related settings
are now consolidated in the same grid with the new settings. In earlier versions of InstallShield, these previously available
service-related settings were split among separate subviews for the Install NT Services and Control NT Services nodes. The
consolidated grid of settings makes it easier to create a component that installs, configures, starts, stops, or deletes a new
or existing service during installation or uninstallation.

This functionality is available in the following project types: Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM
Database, and Transform.

For more information, see:

• Installing, Controlling, and Configuring Windows Services

• Services Settings

Validation for the Windows 7 Logo Program

InstallShield includes two new validation suites: InstallShield Validation Suite for Windows 7 and InstallShield Merge
Module Validation Suite for Windows 7. These validation suites can help you verify that your Windows Installer–based
installation or merge module meets the installation requirements of the Compatible with Windows 7 logo program. If you
want to be able to use the Windows 7 logo artwork, your product’s installation must meet the program’s requirements.

If you want to configure InstallShield to perform validation with these validation suites each time that a release is
successfully built: On the Tools menu, click Options. On the Validation tab, select the appropriate check boxes.

If you want to perform validation separately from the build process: On the Build menu, point to Validation, and then click
the appropriate new suite.

Windows Installer 5 Support for Setting Windows Shell Properties for a Shortcut
The Shortcuts view in InstallShield now lets you specify one or more shortcut properties that need to be set by the
Windows Shell at run time. For example, if you do not want the Start menu entry for one of your shortcuts to be highlighted
as newly installed after end users install your product, you can set a property for that shortcut. You might want to use this
property with shortcuts that are for tools and secondary products that are part of your installation.

Windows Installer 5 includes support for setting Shell shortcut properties. Earlier versions of Windows Installer ignore
those properties.

For more information, see Setting Shell Properties for a Shortcut.

Windows Installer 5 Support for the MsiPrint and MsiLaunchApp Control Events
When you are adding a control to a dialog in your project, you can select one of the new events that is now available for
Windows Installer 5:

• MsiPrint—You can add this event to a push button control that is on a dialog that has a scrollable text control. When
an end user clicks the push button control, the contents of the scrollable text control are printed.

• MsiLaunchApp—You can add this event to a check box control on a dialog, and select the file that you want to be
launched in the event’s Argument setting. The check box enables end users to choose whether to run the file at the
end of the installation. This event is typically used with a check box control that is on the SetupCompleteSuccess
dialog. The check box control should include a condition that prevents the control from being displayed during
uninstallation.

InstallShield 2020 User Guide ISP-2600-UG00 201

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Windows Installer 5 includes support for these control events. Earlier versions of Windows Installer ignore these events.
Therefore, if your installation is run on a system that has Windows Installer 4.5 or earlier and you want to use one or both of
these new events, add a condition to the dialog controls so that they are not displayed on systems that have Windows
Installer 4.5 or earlier.

This functionality is available in Basic MSI projects.

Note that if you want to add the print or launch support to your project but your installation targets systems that have
Windows Installer 4.5 or earlier, consider using the support that InstallShield provides. For information on adding the print
support, see Specifying Dialogs for Your Installation in the Project Assistant. For information on adding the print support,
see Adding a Print Button to a Dialog. The support that is available with InstallShield does not require Windows Installer 5.

Additional Changes
For a list of issues that are resolved in InstallShield 2010 SP1, see the release notes. The release notes are available from the
Help menu in InstallShield.

See Also
What’s New in InstallShield 2010
Upgrading Projects from InstallShield 2009 or Earlier

What’s New in InstallShield 2010

InstallShield 2020

New Features
InstallShield includes the following new features.

Support for Creating Customized Virtual Applications

Now you can use InstallShield to create customized virtual applications in the Microsoft App-V format. Virtualization
enables you to isolate an application in its own environment so that it does not conflict with existing applications or modify
the underlying operating system.

Virtual applications run in virtual environments that keep the application layer and the operating system layer separate.
Each application includes its own configuration information in its virtual environment. As a result, many applications can
run side-by-side with other applications on the same computer without any conflicts.

To create a virtual application, use the new Microsoft App-V tab that is available in the following project types: Basic MSI
and MSI Database.

Virtualization support is available if you purchase the Premier Edition of InstallShield.

InstallShield also includes InstallShield prerequisites for the Microsoft App-V 4.5 Desktop Client installation and the
Microsoft Application Error Reporting installation. The Application Error Reporting prerequisite is a dependency of the App-
V prerequisite. The redistributable files for these InstallShield prerequisites are not available for download from within
InstallShield, since you must obtain them from Microsoft. Once you obtain them from Microsoft, place them in the location
that is displayed when you are editing these prerequisites in the InstallShield Prerequisite Editor.

For more information, see:

• Creating Customized Virtual Applications

• About Virtualization

202 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Creating Microsoft App-V Applications

Ability to Target Windows 7 and Windows Server 2008 R2 Systems

InstallShield enables you to specify that your installation requires Windows 7 or Windows Server 2008 R2. It also lets you
build feature and component conditions for these operating systems.

Windows 7 and Windows Server 2008 R2 Support for Displaying Installation Progress on the Taskbar
Installations that are run on Windows 7 and Windows Server 2008 R2 now show a progress bar on the Windows taskbar
during file transfer. This applies to InstallScript and InstallScript MSI installations. In addition, it applies to Basic MSI
installations that display billboards that were configured in the Billboards view. Note that a progress bar is not displayed
on the taskbar on earlier versions of Windows. It is also not displayed during setup initialization or while InstallShield
prerequisites are being installed.

Beta Windows Installer 5 Support for Per-User Installations

The General Information view has a new Show Per-User Option setting. This setting lets you specify whether you want the
ReadyToInstall dialog—in certain scenarios—to include buttons that let end users indicate how they want to install the
product: for the current user or for all users. The per-user button sets the new Windows Installer property
MSIINSTALLPERUSER equal to 1 to indicate that the package should be installed for the current user. The
MSIINSTALLPERUSER property is available with the beta of Windows Installer 5.

This feature is available in Basic MSI projects.

To learn more, see Per-User vs. Per-Machine Installations.

Beta Windows Installer 5 Support for Reducing the Time for Installing Large Packages
Use the new Fast Install setting in the General Information view to select one or more options that may help reduce the
time that is required to install a large Windows Installer package. For example, you can specify that you do not want a
system restore point to be saved for your installation. You can also specify that you want the installation to perform file
costing, but not any other costing.

This setting configures the new Windows Installer property MSIFASTINSTALL, which can be set at the command line.
Windows Installer 5 includes support for this property. Earlier versions of Windows Installer ignore it.

This setting is available in the following project types: Basic MSI, InstallScript MSI, MSI Database, and Transform.

To learn more, see the description of the Fast Install setting.

Beta Support for Additional Windows Installer 5 Features

The Director Editor in InstallShield includes beta support for the new Windows Installer 5 tables (MsiLockPermissionEx,
MsiServiceConfig, MsiServiceConfigFailureActions, and MsiShortcutProperty).

This feature is available in the following project types: Basic MSI and InstallScript MSI.

Ability to Detect the Presence of a Virtual Machine

InstallShield lets you determine whether an installation is running on any of the following types of virtual machines:

• Microsoft Hyper-V

• A VMware product such as VMware Player, VMware Workstation, or VMware Server

• Microsoft Virtual PC

InstallShield 2020 User Guide ISP-2600-UG00 203

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Two new Windows Installer properties are available when you add an MSI DLL custom action to your project to detect
virtual machines: IS_VM_DETECTED and IS_VM_TYPE. The custom action should be configured to call the ISDetectVM
function in the SetAllUsers.dll file, which is installed with InstallShield.

In addition, the InstallScript language has been expanded to support the detection. The structure SYSINFO contains a new
bIsVirtualMachine member, and a new VIRTUAL_MACHINE_TYPE constant is available for use with the InstallScript function
GetSystemInfo.

This feature is available in the following project types: Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, and
Merge Module.

For more information, see Detecting Whether the Installation Is Being Run on a Virtual Machine.

Support for 64-Bit COM Extraction

InstallShield now supports 64-bit COM extraction. If you are using InstallShield on a 64-bit operating system, InstallShield
can extract COM data from a 64-bit COM server. In order to install the data to the correct locations, the component must be
marked as 64 bit.

InstallShield must be installed on a 64-bit operating system in order to perform 64-bit COM extraction.

This feature is available in the following project types: Basic MSI, InstallScript MSI, and Merge Module.

To learn more, see:

• Targeting 64-Bit Operating Systems

• Extracting COM Information from a COM Server

New Support for Setting Permissions for Files, Folders, and Registry Keys
InstallShield offers two new ways to secure files, folders, and registry keys for end users who run your product in a locked-
down environment:

• Custom InstallShield handling—In Windows Installer–based projects, you can choose to use custom support for
setting permissions at run time. With this option, InstallShield stores permission information for your product in the
custom ISLockPermissions table of the .msi database. InstallShield also adds custom actions to your project to set
the permissions. This support is available in the following project types: Basic MSI, InstallScript MSI, Merge Module,
MSI Database, MSM Database, and Transform.

• SetObjectPermissions, an InstallScript Function—You can use the new SetObjectPermissions function in

InstallScript events and InstallScript custom actions to set permissions at run time. You can use this function in the
following project types: InstallScript, Basic MSI, InstallScript MSI, and Merge Module.

With the custom InstallShield handling option, the file, folder, or registry key for which you are setting permissions must be
installed as part of your installation. With the SetObjectPermissions function, the file, folder, or registry key can be
installed as part of your installation, or it can be already present on the target system.

Previously, the only option that InstallShield offered for setting permissions was to use the traditional Windows Installer
handling. With this option, the permission information is stored in the LockPermissions table of the .msi database. The
new custom InstallShield handling option and the SetObjectPermissions function offer several advantages over the
traditional Windows Installer handling:

• The custom option and the SetObjectPermissions function include support for many well-known security identifiers
(SIDs) that are not supported by the traditional Windows Installer handling option.

204 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• The custom option and the SetObjectPermissions function support the use of localized user names for the supported
SIDs, unlike the traditional option. With the traditional option, if you try to use a localized name to set permissions on
a non-English system, the installation may fail.

• The custom option and the SetObjectPermissions function let you specify that you want to deny a user or group from
having the permissions that you are specifying. The traditional handling does not allow you to do this.

• The custom option and the SetObjectPermissions function let you add permissions to a file, folder, or registry key
that already exists on the target system, without deleting any existing permissions for that object. With the traditional
handling, the existing permissions are deleted.

• The custom option and the SetObjectPermissions function let you configure permissions for a folder (or a registry
key), and indicate whether you want the permissions to be applied to all of the folder’s subfolders and files (or the
registry key’s subkeys). With the traditional handling, if you want to configure permissions for a subfolder or a file in a
folder (or a subkey under a registry key), the parent that is created on the target system automatically inherits the
permissions of its child.

• The custom option and the SetObjectPermissions function let you configure permissions for a new user that is being
created during the installation. The traditional handling does not allow you to do this; the user must already exist on
the target system at run time.

The General Information view has a new Locked-Down Permissions setting that lets you specify whether you want to use
the new custom InstallShield handling or the traditional Windows Installer handling for all new permissions that you set for
files, folders, and registry keys in your project. If you have already configured some permissions in your project and then
you change the value of this setting, InstallShield lets you specify whether you want to use the alternate handling method
for those already-existing permissions. In all new projects, the default value for this setting is the custom InstallShield
handling option. If you upgrade a project from InstallShield 2009 or earlier to InstallShield 2010, the traditional Windows
Installer handling option is the default value of this setting. This new setting is available in the following project types:
Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform.

For more information, see the following:

• Securing Files, Folders, Registry Keys, and Windows Services in a Locked-Down Environment

• Selecting the Locked-Down Permissions Type for a Project

• SetObjectPermissions

• SetObjectPermissions Example

Support for InstallShield Prerequisites in InstallScript Projects

InstallShield now enables you to add InstallShield prerequisites to InstallScript projects. Previously, only Basic MSI and
InstallScript MSI projects included support for this type of redistributable.

InstallShield prerequisites are redistributables that usually install a product or technology framework that is required by
your product. Now you can add any of the InstallShield prerequisites that are provided with InstallShield—or any of your
own custom-designed InstallShield prerequisites—to InstallScript projects. If you work on a mix of different project types,
InstallShield lets you simplify your testing matrix by enabling you to reuse this type of redistributable in all of your Basic
MSI, InstallScript, and InstallScript MSI projects.

To add an InstallShield prerequisite to an InstallScript project, use the new Prerequisites view. InstallScript projects
include support for the setup prerequisite type of InstallShield prerequisite, which is run before the main installation’s user
interface is run. InstallScript projects do not have support for feature prerequisites, which are InstallShield prerequisites
that are associated with features.

InstallShield 2020 User Guide ISP-2600-UG00 205

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more information, see:

• Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects

• Run-Time Behavior for an Installation that Includes InstallShield Prerequisites

• Specifying the Installation Order of InstallShield Prerequisites

• Specifying a Run-Time Location for a Specific InstallShield Prerequisite

• Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level

• Designing InstallShield Prerequisites and Other Redistributables

• Prerequisites View

New InstallShield Prerequisites for Windows Installer, .NET Framework, Crystal Reports, and Other
Redistributables
InstallShield includes a number of new InstallShield prerequisites that you can add to Basic MSI, InstallScript, and
InstallScript MSI projects:

• Windows Installer 4.5 (The InstallShield prerequisites for Windows Installer 4.5 include the fix that is described in
Microsoft KB958655.)

• Windows Installer 4.5 Update (The InstallShield prerequisites for the Windows Installer 4.5 Update include the fix that
is described in Microsoft KB958655. Windows Installer 4.5 must already be installed on the target system for this
update.)

• Windows Installer 3.1, Windows Installer 3.0, and Windows Installer 2.0 (These versions of Windows Installer
redistributables were previously available if you added Windows Installer to your project in the Releases view. These
versions were not previously available as InstallShield prerequisites.)

• .NET Framework 3.0 SP1

• .NET Framework 2.0 SP2

• Internet Explorer 8

• Microsoft SQL Server 2008 Express SP1

• Microsoft SQL Server 2005 Express SP3

• Microsoft Visual C++ 2005 SP1 Redistributable Package

• Oracle 11g Instant Client 11.1.0.7 (Oracle does not provide an installer for the Oracle Instant Client files, so you need to
create an .msi package before you can use this InstallShield prerequisite in your projects. You can do so easily by using
the Oracle Instant Client installation project that is installed with InstallShield (InstallShield Program Files
Folder\Support\Oracle Instant Client.)

• Crystal Reports Basic for Visual Studio 2008 (Use this prerequisite with the Crystal Reports Basic installation that is
installed with Visual Studio 2008. Note that you may need to change the path of the Crystal Reports Basic installation
in the .prq file, depending on where the .msi package is located on your system.)

Microsoft SQL Server 2008 SP1 Support

InstallShield now includes support for running SQL script on SQL Server 2008 SP1. In addition, InstallShield includes SQL
Server 2008 SP1 in the predefined list of database servers that you can select when you are specifying in the SQL Scripts
view the target database servers that your product supports.

206 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Oracle 11g Support

InstallShield now includes support for running SQL script on Oracle 11g. In addition, InstallShield includes Oracle 11g in the
predefined list of database servers that you can select when you are specifying in the SQL Scripts view the target database
servers that your product supports.

New Tool for Scanning an IIS Web Site, Recording Its Settings, and Importing Those Settings into an
InstallShield Project
InstallShield includes an IIS scanner (IISscan.exe), a new command-line tool for scanning an existing IIS Web site and
recording IIS data about the Web site. The IIS scanner creates an XML file that contains all of the settings for the Web site, its
virtual directories, its applications, and its application pools. You can use the XML file to import the IIS data into the
Internet Information Services view in InstallShield. Once you have imported the IIS data into a project, you can use the
Internet Information Services view to make changes to the IIS settings as needed.

The ability to import the IIS data into an InstallShield project is available only in the Premier edition of InstallShield.

For more information, see:

• Scanning an IIS Web Site and Importing Its Settings into an InstallShield Project

• Filtering IIS Data When Importing a Web Site and Its Settings into an InstallShield Project

• IISscan.exe

Ability to Add IIS Web Applications to Web Sites, Plus Other IIS-Related Improvements
InstallShield now lets you add IIS Web applications to Web sites. You can do so by right-clicking a Web site in the Internet
Information Services view and clicking New Application. Once you have added a new application, you can configure its
settings in the right pane.

InstallShield also lets you create a virtual directory without an application. Previously whenever you created a virtual
directory, an application was also created automatically.

In addition, InstallShield has new IIS settings:

• Managed Pipeline Mode—This setting enables you to specify the appropriate request-processing pipeline mode—
either integrated or classic—for an application pool.

• Enable 32-Bit Applications—This setting lets you specify whether you want to allow 32-bit applications in the
selected application pool to be run on 64-bit systems.

• .NET Framework Version—This setting is where you specify the version of the .NET Framework that an application
pool should load.

• ASP.NET Platform—If your installation may be run on a 64-bit version of Windows with the .NET Framework, use this
setting to specify which ASP.NET platform should be used to map a Web site, application, or virtual directory to the
ASP.NET version.

This feature is available in the following project types: Basic MSI, InstallScript, and InstallScript MSI.

To learn more, see:

• Creating a Web Site and Adding an Application or a Virtual Directory

• Internet Information Services View

InstallShield 2020 User Guide ISP-2600-UG00 207

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New View for Configuring Run-Time Text File Changes

InstallShield has a new Text File Changes view, which enables you to configure search-and-replace behavior for content in
text files—for example, .txt, .htm, .xml, .config, .ini, and .sql files—that you want to modify at run time on the target system.
The text files can be part of your installation, or they can be files that are already present on target systems.

You can use Windows Installer properties to specify the names of the text files that you want to include in or exclude from
your search. You can also use properties to specify the search strings and the replacement strings. This enables you to use
data that end users enter in dialogs, or other configuration information that is determined at run time, when your
product’s text files are modified on the target system. For example, if your project includes a dialog in which end users
must specify an IP address, your installation can search a set of files for a token, and replace it with the IP address that end
users enter.

Note that the Text File Changes view offers an alternative for configuring XML file changes in the XML File Changes view.
Using the Text File Changes view offers some advantages. For example, this new view does not have any run-time
requirements; however, changes that are configured through the XML File Changes view require MSXML to be present on
the target system. In addition, configuring changes in the Text File Changes view does not require you to enter XPath
queries, as is required in the XML File Changes view.

The Text File Changes view is available in the following project types: Basic MSI and InstallScript MSI.

For more information, see:

• Modifying Text Files

• Creating a Text Change Set

• Specifying a Change for a Text File

• Changing the Order in Which Text File Changes Are Made

• Using Windows Installer Properties to Dynamically Modify Text Files

• Specifying the Code Page that Should Be Used for Opening ANSI Text Files

New String Editor View

InstallShield has a new String Editor view. This view contains a spreadsheetlike table that shows the collection of
language-independent identifiers and corresponding language-specific values for your project. In the String Editor view,
you have complete and centralized control over the localizable text strings that are displayed at run time during the
installation process. The view replaces the string tables that were previously available as nodes within the General
Information view. Following is a list of some of the highlights of the new view:

• The view has a toolbar with buttons that let you add, edit, delete, find, replace, export, and import string entries. It
also has a button that lets you search the project to identify all of the instances in which a specific string identifier is
used.

• The top of the view has a new group box area; you can drag and drop column headings onto this area to organize the
rows in the view in a hierarchical format. This functionality makes it easy to sort string entries by categories such as
language and by modified date.

• This view has support for dynamic searches—as you are typing a string in the search box, InstallShield hides all of the
string entries that do not contain it.

This feature is available in the following project types: Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge
Module.

For more information, see:

208 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• String Editor View

• Localizing the End-User Interface

Support for Unicode

InstallShield takes a three-pronged approach to fully supporting modern multilanguage installations: Windows Installer
databases can now be built in a Unicode format, InstallShield projects are now stored in a Unicode format, and the
InstallShield interface now supports entering and viewing Unicode characters from multiple character sets at the same
time.

Unicode (UTF-8) Databases

The Build tab in the Releases view has a new Build UTF-8 Database setting that lets you specify that a Windows Installer
database, along with any instance or language transforms, be built using the UTF-8 encoding. The UTF-8 encoding
supports characters from all languages simultaneously, enabling you to mix and match, for example, Japanese and
German, or Russian and Polish, both in text shown to end users and in file names and registry keys. These mixed languages
work correctly regardless of the current language of the target system. Unicode support has also been added to key parts
of the installation run times, including IIS support and changes to text and XML files.

The default value for the new Build UTF-8 Database setting is No.

The automation interface now includes support for this new setting. The ISWiRelease object includes a new
BuildUTF8Database property that lets you specify whether you want to use the UTF-8 encoding.

This feature is available in the following project types: Basic MSI, InstallScript MSI, and Merge Module projects.

To learn more, see the description of the Build UTF-8 Database setting.

Unicode Project Files (*.ism)

InstallShield now uses the UTF-8 encoding when saving both binary and XML project files. Because of this change, the files,
registry data, and other strings that are used in the project can include characters from all languages simultaneously. With
this encoding, InstallShield no longer needs to use an unreadable Base64 encoding for strings that are stored in the
ISString table. Instead, as you add or modify strings in a project, InstallShield now saves them as human-readable
Unicode strings that you can easily examine for changes across revisions of your project. Therefore, InstallShield uses only
Unicode strings for all new projects that are created in InstallShield 2010; for upgraded projects, InstallShield uses Unicode
for new and modified strings, as well as for strings that have been exported and reimported.

If you use Unicode values that cannot be represented in the target build (for example, an InstallScript installation, or a
Basic MSI installation in which No is selected for the Build UTF-8 Database setting), a new build error points to the item that
needs to be changed. In some instances, this reveals invalid string entries that were silently allowed in earlier versions of
InstallShield.

This feature applies to all project types.

Unicode Views in InstallShield

Many views in InstallShield have been enhanced to display and allow you to enter characters from all languages. For
example, in the Files and Folders view, Chinese file names from your local English system are no longer displayed with
question marks for their names, and now you can add these files to your project. Similarly, the Registry view no longer
converts Thai registry keys or values to question marks, and you can install them with your Windows Installer–based
projects. In addition, you can view and edit strings from all languages in the String Editor view, a new separate view;
previously, string entries were available from separate language nodes in the General Information view. Examples of other
enhanced views include the Property Manager, Path Variables, Direct Editor, General Information, and Setup Design views.

InstallShield 2020 User Guide ISP-2600-UG00 209

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Note that whenever No is selected for the Build UTF-8 Database setting, all file names, registry keys, and other strings must
still consist of characters from the code page of all target languages that will use it. In this scenario, if an item uses a
character that is not available on the code page of a target language, InstallShield reports a new build error that points to
this item; the Chinese file name cannot be used in an English installation unless Yes is selected for the Build UTF-8
Database setting.

This feature applies to all project types.

New Billboard Support in Basic MSI Projects

Basic MSI projects now include support for billboards. You can add billboards to your projects to display information to end
users during the installation process. The billboards can be used to communicate, advertise, educate, and entertain end
users. For example, billboards can present overviews on new features of the product being installed or other products from
your company. Each billboard is a file that you or your company’s graphics department creates for complete control over
the look and feel of the file transfer.

Following are some of the highlights regarding billboard support in Basic MSI projects:

• You can add an Adobe Flash application file (.swf) as a billboard in your project. Flash application files can consist of
videos, movies, sounds, interactive interfaces, games, text, and more—anything that is supported by the .swf type of
file.

• InstallShield lets you use .bmp, .gif, .jpg, and .jpeg files as billboards.

• InstallShield includes a Billboard Type setting that lets you specify which style of billboard you want to use in your
installation. For example, with one style, the installation displays a full-screen background, with billboards in the
foreground, and a small progress box in the lower-right corner of the screen. With another style, the installation
displays a standard-size dialog that shows the billboards. The bottom of this dialog shows the progress bar.

• InstallShield lets you preview a billboard to see how it would be displayed at run time, without requiring you to build
and run a release. Previewing a billboard lets you see how your billboard will look with the background color, position,
and related settings that are currently configured for your billboard.

The Billboards view in InstallShield is where you add billboard files, configure billboard-related settings, and preview
billboards.

To learn more, see:

• Displaying Billboards in Basic MSI Installations

• Billboard File Types for Basic MSI Projects

• Types of Billboards for Basic MSI Projects

• Adding an Adobe Flash Application File Billboard to a Basic MSI Project

• Adding Image Billboards to a Basic MSI Project

• Configuring Billboard Settings in a Basic MSI Project

• Previewing Billboards Without Building and Launching a Release

• Setting the Billboard Order in a Basic MSI Project

• Run-Time Behavior of a Basic MSI Installation that Includes Billboards

Previously, only InstallScript and InstallScript MSI projects included support for billboards. Note that billboard support in
these project types is different than support in Basic MSI projects. For more information, see Displaying Billboards.

210 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Expanded Billboard Support in InstallScript and InstallScript MSI Projects

InstallScript and InstallScript MSI projects now let you use .gif, .jpg, and .jpeg files as billboards. Previously, only .bmp files
were supported. Use the Support Files/Billboards view to add billboards to your project.

Billboard files in InstallScript and InstallScript MSI projects must follow a designated naming convention. Each file name
must begin with bbrd, followed by the number of the billboard (from 1 through 99); each must end with a supported file
extension (.bmp, .gif, .jpg, or .jpeg). Note that it is no longer necessary for the file name numbers to be contiguous; that is,
you can add bbrd1.jpg, bbrd3.jpg, and bbrd5.jpg to your project, and each image is displayed at run time in order.
Previously, there could not be any numbers missing from the file name sequence for your billboards. For example, if you
added bbrd1.bmp, bbrd2.bmp, and bbrd4.bmp to your installation project, then bbrd1.bmp and bbrd2.bmp were displayed at
run time; however, bbrd4.bmp was not displayed, since bbrd3.bmp was missing from the sequence.

For more information, see:

• Displaying Billboards in InstallScript and InstallScript MSI Installations

• Naming Billboard Files in an InstallScript or InstallScript MSI Project

• Adding an Image Billboard to an InstallScript or InstallScript MSI Project

Ability to Play an Adobe Flash Application File (.swf) with the InstallScript Function PlayMMedia
The InstallScript function PlayMMedia now includes support for playing an Adobe Flash application file (.swf) on a
background window during InstallScript and InstallScript MSI installations. Flash application files can consist of videos,
movies, sounds, interactive interfaces, games, text, and more—anything that is supported by the .swf type of file.

If you are using a Flash file, you can use SizeWindow and PlaceWindow to control the size and placement of the
background window that displays the Flash file.

For more information, see:

• PlayMMedia

• SizeWindow

• PlaceWindow

• Displaying a Background Window in InstallScript and InstallScript MSI Installations

Support for HTML Controls on Dialogs During InstallScript and InstallScript MSI Installations
InstallShield includes support for HTML controls on dialogs in InstallScript and InstallScript MSI projects. HTML controls
enable you to use HTML markup for dialog controls. You can include on dialogs links to Web pages, installed HTML files,
and HTML support files. If an end user clicks the hyperlink on the run-time dialog, you can have the HTML page open in an
Internet browser, or you can trigger other behavior that you have defined through your InstallScript code. The HTML
control lets you use any valid HTML markup, including styles to control their appearance.

The HTML control also lets you display the HTML content directly on a dialog if the content is an installed HTML file or HTML
support file.

A new InstallScript function called CtrlGetUrlForLinkClicked is available. This function retrieves the URL for a link that an
end user clicked.

For more information, see:

• Using an HTML Control on a Dialog

• CtrlGetUrlForLinkClicked

InstallShield 2020 User Guide ISP-2600-UG00 211

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• CtrlGetUrlForLinkClicked Example

Ability to Add Unsupported Languages to InstallScript Projects

The InstallShield Premier edition includes default run-time strings for InstallScript projects in 33 different languages. The
InstallShield Premier edition also lets you use the New Language Wizard to add unsupported languages, beyond the built-
in 33 languages, to InstallScript projects. Once you have added unsupported languages to an InstallScript project, you can
use the String Editor view to provide translated strings for the unsupported languages. As an alternative, you can export a
language’s string entries to a file, translate the string values in the file, and then import the translated file into your project.
Previously, the New Language Wizard enabled you to add unsupported languages to only Basic MSI and InstallScript MSI
projects.

For more information, see:

• Run-Time Language Support in InstallShield

• New Language Wizard

• String Editor View

Ability to Specify Paths for Libraries to Which the InstallScript Compiler Should Link
The Compile/Link tab on the Settings dialog box has a new Additional Library Paths box that lets you specify the locations
where the InstallScript compiler should search for InstallScript libraries (.obl files) that should be linked to your script. In
addition, when you specify your custom libraries on this tab, you can now specify just the file name, without the full path.
These changes enable you to move your libraries to different directories but still successfully compile your script without
manually changing the path for libraries on the Compile/Link tab.

For more information, see Compile/Link Tab.

New FlexNet Connect 11.6 Redistributables Available

InstallShield includes support for FlexNet Connect 11.6 in Basic MSI and InstallScript MSI projects. Use the Update
Notifications view in InstallShield to include one of the two FlexNet Connect 11.6 merge modules—one has the Common
Software Manager, and the other does not. These merge modules replace the FlexNet Connect 11 merge modules.

DIFx 2.1.1 Support

InstallShield includes support for the latest version of Driver Install Frameworks for Applications (DIFx 2.1.1). This new
version, which includes the latest binary files from Microsoft, is available for the following project types: Basic MSI,
InstallScript, and InstallScript MSI.

Enhancements
InstallShield includes the following enhancements.

Usability Enhancements
Many of the views in InstallShield have been enhanced to improve productivity and usability. For example, several views
contain new toolbars that make options easier to find. Some of the views that contain grids let you customize how the rows
in a grid are organized. Searches are performed more quickly in the views that offer search capabilities. Following are
examples of some of the highlights:

• Direct Editor view—When you select a table in this view, a new toolbar is displayed. The toolbar has buttons that let
you add, cut, copy, paste, find, and replace data in the table. This view also has support for dynamic searches—as you

212 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

are typing a string in the search box, InstallShield hides all of the table records that do not contain it. When you are
adding or editing a record, InstallShield displays help text for each field.

• Property Manager view—This view contains a new toolbar that has buttons for performing tasks such as adding and
deleting properties. This view also has support for dynamic searches—as you are typing a string in the search box,
InstallShield hides all of the table records that do not contain it. The top of the view has a new group box area; you can
drag and drop column headings onto this area to organize the rows in the view in a hierarchical format. You can now
select multiple properties in this view (by using the mouse and the SHIFT or CTRL button) and then delete them all at
once.

• Redistributables view—The new toolbar and the new group box area in this view provide robust search and
organizational functionality. You can drag and drop column headings onto the group box area to organize the list of
redistributables in a hierarchical format. In addition, you can type a string in the toolbar’s search box, and
InstallShield hides all of the redistributables that do not contain it.

• Internet Information Services view—This view has been redesigned to look similar to IIS 7: the settings are now
displayed in grids, instead of on tabs. The grids have buttons that let you sort the grid settings by category or
alphabetically. When you select a setting in one of the grids in this view, InstallShield displays help information for
that setting in the lower-right pane.

• General Information view—All of the settings in this view are displayed in one grid, instead of as separate grids that are
associated with nodes within this view. The settings are grouped into several categories to make it easy to find a
particular setting. In addition, the grid has a button that lets you sort the grid settings by category or alphabetically.
The string tables that were previously in this view have been moved to a new String Editor view.

• Path Variables view—This view contains a new toolbar that has buttons for performing tasks such as adding and
deleting path variables. This view also has support for dynamic searches—as you are typing a string in the search box,
InstallShield hides all of the rows that do not contain it. The top of the view has a new group box area; you can drag
and drop column headings onto this area to organize the rows in the view in a hierarchical format. You can now select
multiple path variables in this view (by using the mouse and the SHIFT or CTRL button) and then delete them all at
once.

In addition, the Output window, which is displayed when you are building a release, performing validation, or compiling
script, has been enhanced. The Output window or its individual tabs can be docked to any side of the workspace in
InstallShield, or they can be dragged to free-floating positions. If you drag the Output window or one of its tabs to the edge
of the InstallShield interface, it becomes a docked window. If you drag the Output window or one of its tabs away from any
of the edges of the InstallShield interface, it becomes undocked.

For more information, see the following:

• Working with the Group Box Area in Various Views

• Docking or Undocking the Output Window

Support for Specifying Action Progress Messages

To keep end users informed, installations commonly display text on the progress dialog to describe the installation’s
current activity. This usually accompanies the progress bar as a means of installation status. As each standard action and
custom action is encountered, a message about the action is displayed on the progress dialog. This may be especially
useful for actions that take a long time to execute. The same action text is also written to the installation’s log file if one is
created.

The Custom Actions and Sequences view has a new Action Text area that lets you specify action descriptions and details.
This is available in the following project types: Basic MSI, InstallScript MSI, MSI Database, and Transform.

InstallShield 2020 User Guide ISP-2600-UG00 213

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more information, see:

• Using Action Text

• Specifying an Action Description and a Template for Action Data

• Displaying Action Descriptions on the Progress Dialog

• Displaying Action Data on the Progress Dialog

Ability to Detect Whether a 64-Bit System Allows 32-Bit IIS Applications to Be Run
At run time, you may need to have your installation check the Enable32bitAppOnWin64 property on systems that have IIS 6.
Depending on the requirements for your product and the results of that check, you may want the installation to skip a
particular component that contains a 32-bit IIS 6 application, or a 64-bit IIS application, for example, and proceed with the
rest of the file transfer.

InstallShield includes a sample Windows Installer DLL file that detects how the Enable32bitAppOnWin64 property is set on
a target system. You can add a custom action for this DLL to your project. If 32-bit applications are allowed, the Windows
Installer property ISIIS6APPPOOLSUPPORTS32BIT is set to a value of 1; if they are not allowed, this property is not set. You
can use this property in conditions to prevent or trigger certain behavior. For example, you can create a launch condition if
you want the installation to exit if the ISIIS6APPPOOLSUPPORTS32BIT is set or not set.

This feature is available in the following project types: Basic MSI and InstallScript MSI.

For instructions on how to add the custom action to your project, see Considerations for Supporting IIS 6 on 64-Bit
Platforms.

Ability to Detect Whether the IIS 6 Metabase Compatibility Feature Is Installed

At run time, you can have your installation detect if the IIS Metabase and IIS 6 Configuration Compatibility feature is
installed on a target system, or if IIS 6 or earlier is installed. Depending on the requirements for your product and the
results of that detection, you may want the installation to exit and display an error message.

For example, Web service extensions can be installed on systems that have IIS 6. On systems that have IIS 7, Web service
extensions can be installed only if the IIS Metabase and IIS 6 Configuration Compatibility feature is installed. Thus, you
might want to configure your installation to verify that IIS 6 is present or the IIS 6 compatibility feature is installed; if either
of those conditions are false, the installation would exit and display an error message.

InstallShield includes a sample Windows Installer DLL file that detects whether the IIS Metabase and IIS 6 Configuration
Compatibility feature is installed. You can add a custom action for this DLL to your project. If the IIS Metabase and IIS 6
Configuration Compatibility feature is installed, the Windows Installer property ISIISMETABASECOMPATPRESENT is set to a
value of 1; if it is not installed, this property is not set. You can use this property in conditions to prevent or trigger certain
behavior. For example, you can create a launch condition if you want the installation to exit if the
ISIISMETABASECOMPATPRESENT is set or not set.

This feature is available in the following project types: Basic MSI and InstallScript MSI.

For instructions on how to add the custom action to your project, see Determining If a Target System Has IIS 6 or Earlier or
the IIS 6 Metabase Compatibility Feature.

Ability to Associate a Namespace Prefix with an Attribute of an XML File’s Element

InstallShield now lets you add a namespace prefix to an attribute in the XML File Changes view. To do so, you can type the
prefix, followed by a colon (:), in front of the attribute name. Previously, if an attribute contained a namespace prefix, the
installation failed.

214 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

This enhancement applies to the following project types: Basic MSI, InstallScript, and InstallScript MSI.

For more information, see Adding a Namespace Prefix to an Attribute.

Ability to Specify Whether an XML File Should Be Formatted After Run-Time Changes
The Advanced tab for an XML file in the XML File Changes view has a new Format XML after changes check box that lets
you specify whether you want the XML file to be formatted after the run-time changes are made to the file. When formatting
the file, the installation adds indentations to the file and replaces empty-element tags with start tags and end tags. This
may cause problems for web.config files, so you may want to clear this check box for your project.

This enhancement applies to the following project types: Basic MSI, InstallScript, and InstallScript MSI.

For more information, see Advanced Tab for an XML File.

Predefined System Searches for the .NET Framework and Internet Explorer 8
InstallShield has two new predefined system searches:

• Microsoft .NET Framework 3.5 SP1

• Internet Explorer 8

If your installation requires any of these, you can use the System Search view or the Installation Requirements page in the
Project Assistant to add these system searches to your project. When end users launch your installation, Windows Installer
checks the target system to see if the requirements are met; if they are not met, the installation displays the error message
that is defined for the system search.

This enhancement applies to Basic MSI and InstallScript MSI projects.

Custom Properties Are Now Listed in Condition Builder

The Properties list on the Condition Builder dialog box now includes properties that are added in the Property Manager
view. It also includes properties from searches that are created through the System Search Wizard. Therefore, when you
are creating or editing a condition in InstallShield, you can now select your own custom properties without having to
manually type them.

This enhancement applies to the following project types: Basic MSI, InstallScript MSI, Merge Module, and Transform.

Ability to Specify a Maximum Service Pack Number and 64-Bit Locations for InstallShield Prerequisite
Conditions
The Prerequisite Condition dialog box, which is displayed when you are adding or modifying a condition for an InstallShield
prerequisite in the InstallShield Prerequisite Editor, has a new field that lets you specify the maximum service pack
number. Previously, it was possible to specify a minimum service pack number, but not a maximum service pack number.

In addition, the Prerequisite Condition dialog box now includes the following 64-bit locations in the box that is displayed
when you are specifying file-related conditions: [CommonFiles64Folder], [ProgramFiles64Folder], and [System64Folder].
You can select any of these properties if you want to use 64-bit locations in the file path. At run time, the installation checks
these 64-bit locations if the target system is 64 bit. For 32-bit systems, the installation checks the 32-bit location
equivalents.

For more information, see Prerequisite Condition Dialog Box.

Enhancements to MSBuild Support

The InstallShield task for MSBuild includes several new parameters:

InstallShield 2020 User Guide ISP-2600-UG00 215

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• RunMsiValidator—Use this parameter to specify the .cub file that you want to use for validation. This parameter is
exposed as the ItemGroup InstallShieldMsiValidators when the default targets file is used.

• PatchConfiguration—Use this parameter to specify the patch configuration that you want to build through MSBuild.
This parameter is exposed as the property InstallShieldPatchConfiguration when the default targets file is used.

• PathVariables—Use this parameter to override the value of a path variable. This parameter is exposed as the
ItemGroup InstallShieldPathVariableOverrides when the default targets file is used.

• PreprocessorDefines—Use this parameter to specify preprocessor definitions for compiling InstallScript. This
parameter is exposed as the ItemGroup InstallShieldPreprocessorDefines when the default targets file is used.

For more information, see Microsoft Build Engine (MSBuild).

Automation Interface Enhancements

OSFilter Property Values for Windows 7, Windows Server 2008 R2, Windows Vista, Windows Server 2008, and Windows
Server 2003

The following constants are now available for use with the OSFilter member of the ISWiComponent and ISWiRelease
objects in the automation interface:

• eosWin7 (33554432)—This is for Windows 7 and Windows Server 2008 R2.

• eosWinVista (16777216)—This is for Windows Vista and Windows Server 2008.

• eosWinServer2003 (8388608)

In addition, the value for the eosAll constant is now 64028880; previously, it was 5308624.

The OSFilter member applies to the ISWiComponent object in InstallScript, InstallScript MSI, and InstallScript Object
projects. The OSFilter member applies to the ISWiRelease object in InstallScript and InstallScript Object projects.

For more information, see the following:

• ISWiComponent Object

• ISWiRelease Object

New IsPlatformSelected Property Values

The list of available property values for the IsPlatformSelected property of the ISWiComponent object has been expanded.
This property now has values for 32-bit, 64-bit Itanium, AMD64, and Windows Server 2003 R2. This applies to the following
project types: InstallScript and InstallScript Object.

Note that some of the values for the existing constants have changed. To learn the new values, see ISWiComponent Object.

New AddSQLScriptEx Method for Adding a SQL Script to a Connection

The AddSQLScriptEx method has been added to the ISWiSQLConnection object. Use this method to add an ISSQLScriptFile
entry and generate a valid name from the passed string. The method ensures that the names of the entries in the
ISSQLScriptFile table are unique and less than 47 characters in length.

New RunOnLogon and Condition Properties for the ISWiSQLScript Object

The read-write RunOnLogon property has been added to the ISWiSQLScript object. This property corresponds with the Run
Script During Login check box on the Runtime tab for a SQL script in the SQL Scripts view.

216 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The read-write Condition property has also been added to the ISWiSQLScript object. This property specifies the condition
that is evaluated at run time to determine whether the SQL script should be run during installation or uninstallation. If the
condition evaluates to true, the script is run. This property is available for the following project types: Basic MSI and
InstallScript MSI.

New DisplayName Property for the ISWiUpgradeTableEntry Object

The read-write DisplayName property has been added to the ISWiUpgradeTableEntry object. This property gets or sets the
name of an upgrade entry. This is the internal name that is displayed for an upgrade item in the Upgrades view. This
property is available for the following project types: Basic MSI and InstallScript MSI.

Enhancements to the InstallScript Language for Operating Systems

The following structure members and predefined constants were added to the InstallScript language:

• SYSINFO.WINNT.bWin7_Server2008R2—This is a new SYSINFO structure member. If the operating system is

Windows 7 or Windows Server 2008 R2, this value is TRUE.

• SYSINFO.bWinServer2003R2—This is a new SYSINFO structure member. If the operating system is Windows Server
2003 R2, this value is TRUE. (Note that the value of SYSINFO.WINNT.bWinServer2003 is also TRUE on this operating
system.)

• ISOSL_WIN7_SERVER2008R2—This is a new predefined constant that is available for use with the FeatureFilterOS
function and the SYSINFO structure variable. It indicates that the target system is running Windows 7 or Windows
Server 2008 R2.

• ISOS_ST_SERVER2003_R2—This is a new operating system suite that is available for use with the FeatureFilterOS
function and the SYSINFO structure variable. It indicates that the target system is running Windows Server 2003 R2.

In addition, some items were renamed:

• The SYSINFO.WINNT.bWinVista structure member does not distinguish between Windows Vista or Windows Server
2008. Therefore, the new member SYSINFO.WINNT.bWinVista_Server2008 is now available. The old alias is still
available, but the new one may be preferred for clarity in code.

• The ISOSL_WINVISTA predefined constant does not distinguish between Windows Vista or Windows Server 2008.
Therefore, the new constant ISOSL_WINVISTA_SERVER2008 is now available. The old alias is still available, but the
new one may be preferred for clarity in code.

For more information, see FeatureFilterOS function and the SYSINFO structure variable.

Ability to Easily Override InstallScript Dialog Source Code in the InstallScript View
The event category drop-down list in the InstallScript view has a new Dialog Source option. If you select this option, the
event handler drop-down list shows all of the built-in InstallScript dialogs. You can select any dialog in this list to modify its
code.

This functionality applies to the following project types: InstallScript, InstallScript MSI, and InstallScript Object.

For information about built-in InstallScript dialog functions that are available when you select the Dialog Source option,
see Dialog Functions.

InstallShield 2020 User Guide ISP-2600-UG00 217

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Changes to the Major and Minor Version Registry Entries for the Uninstall Key of InstallScript
Installations
InstallScript installations now create VersionMajor and VersionMinor registry values in the Uninstall key; the names of
these values now match the entries that are created during Basic MSI and InstallScript MSI installations. This applies to
new installations that are created in InstallShield 2010, as well as installations that are upgraded from InstallShield 2009 or
earlier. Previously, in InstallShield 2009 and earlier, the names of the values that InstallScript installations created were
MajorVersion and MinorVersion; these are no longer created.

In order to use the new registry values, the values of the following InstallScript constants have been changed:

• REGDB_VALUENAME_UNINSTALL_MAJORVERSION is now VersionMajor instead of MajorVersion.

• REGDB_VALUENAME_UNINSTALL_MINORVERSION is now VersionMinor instead of MinorVersion.

When the MaintenanceStart function is called, it creates the updated value names in the registry. By default, it also
deletes the old value names if they exist. If you do not want the old value names to be deleted from target systems, you can
use the new REGDB_OPTIONS option called REGDB_OPTION_NO_DELETE_OLD_MAJMIN_VERSION.

If REGDB_UNINSTALL_MAJOR_VERSION or REGDB_UNINSTALL_MINOR_VERSION is used with the RegDBGetItem

function, RegDBGetItem first checks for the new value; if the new value is found, the function returns the value data from
the new value. If the new value is not found, the function automatically checks for the old value; if the old value is found,
the function returns the value data from the old value.

To provide backwards compatibility, the following new constants are available:

• REGDB_UNINSTALL_MAJOR_VERSION_OLD

• REGDB_UNINSTALL_MINOR_VERSION_OLD

You can specify these constants with the RegDBGetItem, RegDBSetItem, and RegDBDeleteItem functions to get, set, and
delete the old values.

The following new string constants are also available:

• REGDB_VALUENAME_UNINSTALL_MAJORVERSION_OLD is defined as MajorVersion.

• REGDB_VALUENAME_UNINSTALL_MINORVERSION_OLD is defined as MinorVersion.

For more information, see the following:

• REGDB_VALUENAME_UNINSTALL_MAJORVERSION

• REGDB_VALUENAME_UNINSTALL_MAJORVERSION_OLD

• REGDB_VALUENAME_UNINSTALL_MINORVERSION

• REGDB_VALUENAME_UNINSTALL_MINORVERSION_OLD

• REGDB_UNINSTALL_MAJOR_VERSION_OLD

• REGDB_UNINSTALL_MINOR_VERSION_OLD

• REGDB_OPTIONS

• RegDBSetItem

• RegDBGetItem

• RegDBDeleteItem

218 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New CtrlGetDlgItem Function for Retrieving the Window Handle of a Control in a Custom InstallScript
Dialog
A new InstallScript function called CtrlGetDlgItem is now available. The CtrlGetDlgItem function retrieves the window
handle of a control in a custom dialog. CtrlGetDlgItem is similar to the Windows API GetDlgItem, except that with
CtrlGetDlgItem, you can specify the InstallScript dialog name instead of the dialog’s window handle. For more
information, see CtrlGetDlgItem.

New InstallScript Constant for Passing a Null Pointer for an InstallScript String to an External DLL
Function
You can use the IS_NULLSTR_PTR variable to pass a null pointer to an external DLL function or Windows API through a
parameter that has been prototyped as an InstallScript string. This functionality works for byval string, byref string,
wstring, and binary data types. For more information, see IS_NULLSTR_PTR.

New StrConvertSizeUnit Function for Converting an InstallScript Size Unit Constant to a Display String
A new InstallScript function called StrConvertSizeUnit is now available. The StrConvertSizeUnit function returns the
appropriate display string for the InstallScript size unit constant that is specified.For more information, see
StrConvertSizeUnit.

New StrTrim Function for Removing Leading and Trailing Spaces and Tabs from a String
A new InstallScript function called StrTrim is now available. The StrTrim function removes the leading and trailing spaces
and tabs from a string. For more information, see StrTrim.

New SdLicense* Dialog Functions to Supersede Existing SdLicense* Dialog Functions

Two new InstallScript dialog functions—SdLicenseEx and SdLicense2Ex—are now available. They both display a dialog
that contains a license agreement in a multi-line edit field. The license agreement can be stored in a text file (.txt) or a rich
text file (.rtf).

• SdLicenseEx displays a dialog that shows a question in a static text field. The end user responds by clicking the Yes or
No button.

SdLicenseEx supersedes SdLicense and SdLicenseRtf.

• SdLicense2Ex displays a dialog that has two radio buttons (one for accepting the terms of the license agreement, and
one for not accepting them). The Next button becomes enabled when the end user clicks the appropriate button to
accept the terms of the license agreement.

SdLicense2Ex supersedes SdLicense2 and SdLicense2Rtf.

New ListFindKeyValueString Function for Searching Lists of Key-Value Pairs

A new InstallScript function called ListFindKeyValueString is now available. The ListFindKeyValueString function
searches a string or number list for a specified value. It returns a value from an additional list that corresponds with the
position of the found string in the first list. This enables you to search lists of key-value pairs for a particular key and
retrieve the corresponding value.

For more information, see ListFindKeyValueString.

New InstallScript Code Examples

The InstallShield documentation now has sample code for the following InstallScript functions:

InstallShield 2020 User Guide ISP-2600-UG00 219

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• AdminAskPath

• CharReplace

• FormatMessage

• LogReadCustomNumber

• LogReadCustomString

• LogWriteCustomNumber

• LogWriteCustomString

You can copy this code from the InstallShield documentation, paste it into your InstallScript code, and customize it as
necessary.

Expanded InstallScript Cabinet File Viewer

The Cabinet File Viewer now provides additional information about .cab files for InstallScript projects.

• For features that were built by InstallShield, the viewer has the following new fields: Password Protected, Split Before,
Split After, Split Not Allowed, and Split Before Not Allowed, and Image Index.

• For InstallScript Objects that are included in the InstallScript installation, the viewer has a new Object version field.

• For components, the viewer has the following new fields: Encrypted, Data as Files, and .NET Assembly.

• For media, the viewer has the following new field: Executable File.

See Also
Upgrading Projects from InstallShield 2009 or Earlier
Upgrading Projects from InstallShield 2008 or Earlier
Upgrading Projects from InstallShield 12 or Earlier
Upgrading Projects from InstallShield 11.5 or Earlier

What’s New in InstallShield 2009 SP2

InstallShield 2020

InstallShield 2009 Service Pack 2 (SP2) includes the following changes:

Microsoft Visual Studio 2008 SP1 Support

InstallShield now supports Microsoft .NET Framework 3.5 SP1 and Microsoft SQL Server 2008, as described below.

In addition, InstallShield integration with Visual Studio supports Visual Studio 2008 SP1, enabling development of
installations and products within the Visual Studio interface.

Microsoft .NET Framework 3.5 SP1 Prerequisite Available

InstallShield includes two new .NET-related InstallShield prerequisites that you can add to Basic MSI and InstallScript MSI
projects:

• Microsoft .NET Framework 3.5 SP1 (Web Download)

• Microsoft .NET Framework 3.5 SP1 (Full Package)

220 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

To learn more, see Adding .NET Framework Redistributables to Projects.

Microsoft SQL Server 2008 Support

InstallShield now includes support for running SQL script on SQL Server 2008. In addition, InstallShield includes SQL Server
2008 in the predefined list of database servers that you can select when you are specifying in the SQL Scripts view the
target database servers that your product supports.

Microsoft SQL Server 2008 Express Prerequisites Available

InstallShield now includes InstallShield prerequisites for Microsoft SQL Server 2008 Express Edition. You can add these
InstallShield prerequisites to Basic MSI, and InstallScript MSI projects.

In order to support these new prerequisites, the InstallShield Prerequisite Editor has a new registry condition type.

New Registry Condition Type in the InstallShield Prerequisite Editor

The InstallShield Prerequisite Editor has a new type of condition option called A registry entry has a specified version
value. Use this condition type when you want the installation to check the target system to see if a version number that is
stored as the value data of a particular registry entry is greater than, less than, or equal to a version number that you
specify in the InstallShield Prerequisite Editor. For more information about this new condition, see Prerequisite Condition
Dialog Box.

Microsoft SQL Server 2005 Express SP2 (x86 and x64 WOW) Prerequisite Available
InstallShield now includes a new InstallShield prerequisite for Microsoft SQL Server 2005 Express Edition SP2. This
prerequisite installs Microsoft SQL Server 2005 Express Edition SP2 on 32-bit and 64-bit (WOW) systems. You can add this
InstallShield prerequisite to Basic MSI and InstallScript MSI projects.

New FlexNet Connect 11.0.1 Redistributables Available

InstallShield includes support for FlexNet Connect 11.0.1 in Basic MSI and InstallScript MSI projects. Use the Update
Notifications view in InstallShield to include one of the two FlexNet Connect 11.0.1 merge modules—one has the Common
Software Manager, and the other does not. These merge modules replace the FlexNet Connect 11 merge modules. For
details about the changes in the updated merge modules, see the FlexNet Connect release notes.

Additional Changes
For a list of issues that are resolved in InstallShield 2009 SP2, see the release notes. The release notes are available from the
Help menu in InstallShield.

See Also
What’s New in InstallShield 2009 SP1
What’s New in InstallShield 2009
Upgrading Projects from InstallShield 2008 or Earlier

What’s New in InstallShield 2009 SP1

InstallShield 2020

InstallShield 2009 supports a beta version of Windows Installer 4.5. InstallShield 2009 Service Pack 1 (SP1) includes
changes that offer support for the final released version of Windows Installer 4.5:

InstallShield 2020 User Guide ISP-2600-UG00 221

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

InstallShield Prerequisites for Windows Installer 4.5

InstallShield now includes the following InstallShield prerequisites for the final released version of the Windows Installer
4.5 redistributables:

• Windows Installer 4.5 for Windows Vista and Server 2008 (x86)

• Windows Installer 4.5 for Windows Vista and Server 2008 (x64)

• Windows Installer 4.5 for Windows Vista and Server 2008 (IA64)

• Windows Installer 4.5 for Windows Server 2003 SP1 and later (x86)

• Windows Installer 4.5 for Windows Server 2003 and XP (x64)

• Windows Installer 4.5 for Windows Server 2003 (IA64)

• Windows Installer 4.5 for Windows XP SP2 and later (x86)

You can add these InstallShield prerequisites to Basic MSI and InstallScript MSI projects if you want Windows Installer 4.5
to be installed at run time.

For more information, see Adding Windows Installer Redistributables to Projects.

Additional Changes
For a list of issues that are resolved in InstallShield 2009 SP1, see the release notes. The release notes are available from the
Help menu in InstallShield.

See Also
What’s New in InstallShield 2009
Upgrading Projects from InstallShield 2008 or Earlier

What’s New in InstallShield 2009

InstallShield 2020

New Features
InstallShield includes the following new features.

Ability to Associate InstallShield Prerequisites with Features for Chaining Installations

InstallShield now enables you to associate InstallShield prerequisites with one or more features. This new type of
InstallShield prerequisite is called a feature prerequisite. It is installed if a feature that contains the prerequisite is installed
and if the prerequisite is not already installed on the system.

Including InstallShield prerequisites in your project enables you to chain multiple installations together, bypassing the
Windows Installer limitation that permits only one Execute sequence to be run at a time. The Setup.exe setup launcher
serves as a bootstrap application that manages the chaining.

The Redistributables view is where you add InstallShield prerequisites to a project and specify whether you want them to
run before your main installation or be associated with one or more features in your main installation.

Previously, all InstallShield prerequisite installations were run before the main installation ran, and the InstallShield
prerequisites could not be associated with any features. This type of prerequisite, which is still available, is called a setup
prerequisite.

222 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Basic MSI projects include support for this feature.

To learn more, see:

• Setup Prerequisites vs. Feature Prerequisites

• Associating an InstallShield Prerequisite with a Feature in a Basic MSI Project

• Run-Time Behavior for an Installation that Includes InstallShield Prerequisites

• Working with InstallShield Prerequisites that Are Included in Installation Projects

Beta Windows Installer 4.5 Support for Installation of Multiple Packages Using Transaction Processing
InstallShield lets you add Windows Installer packages to Basic MSI and InstallScript MSI projects as chained .msi packages.
If your Basic MSI or InstallScript MSI installation includes chained .msi packages and Windows Installer 4.5 is present on the
target system, the Windows Installer installs the multiple packages using transaction processing. The packages are
chained together and processed as a single transaction. If one or more of the packages in the transaction cannot be
installed successfully or if the end user cancels the installation, the Windows Installer initiates rollback for all of the
packages to restore the system to its earlier state.

The Chained .msi Packages area of the Releases view is where you add to your project one or more .msi packages that you
want to be chained to your main installation. This area is also where you can assign release flags to the chained .msi
packages, configure settings such as the properties that should be passed to the chained packages, and specify conditions.

For more information, see:

• Configuring Multiple Packages for Installation Using Transaction Processing

• Overview of Multiple-Package Installations that Use Transaction Processing

• Adding a New Chained .msi Package to Your Project

• Chained .msi Package Settings

Beta Windows Installer 4.5 Support for Using the InstallScript Engine as an Embedded User Interface for
InstallScript MSI Installations
For InstallScript MSI projects, you now have the option to use the InstallScript engine as an embedded custom user
interface (UI) handler, rather than as an external custom UI handler, as it has traditionally been used. Windows Installer 4.5
includes support for this new capability. Use this new embedded option if you want end users to be able to launch your
installation directly from an .msi package, but you also want your installation to include a highly customized user interface
that you have defined through InstallScript.

To specify whether you want to use the new embedded InstallScript UI functionality or the traditional external InstallScript
UI functionality, use the new InstallScript User Interface Type setting; this is a project-wide setting in the General
Information view. By default, InstallShield uses the traditional style for all InstallScript MSI projects; a Setup.exe setup
launcher is required for this traditional option.

A new INSTALLSCRIPTMSIEEUI variable is available. This variable is set to True at run time if the new style is used;
otherwise, it is set to False.

Note that the new style does have some limitations that the traditional style does not. For example, some of the
InstallScript functions and command-line parameters are not supported or behave differently with the new style. For
detailed information about the two styles, see Using the InstallScript Engine as an External vs. Embedded UI Handler for
InstallScript MSI Installations.

For additional information, see:

InstallShield 2020 User Guide ISP-2600-UG00 223

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Specifying the InstallScript User Interface Type for InstallScript MSI Installations

• InstallScript MSI Installation Projects

• INSTALLSCRIPTMSIEEUI

Beta Windows Installer 4.5 Support for Shared Component Patching

InstallShield includes support for the new shared component patching feature that is available with Windows Installer 4.5.
The new Multiple Package Shared Component setting in the Components view lets you specify whether you want to enable
shared component patching for the selected component. Selecting Yes sets a new component attribute that is designed to
prevent Windows Installer from downgrading files when patches that contain components shared across multiple
packages are uninstalled. The intent is to keep the highest version of a component present on the target system, even if the
patch that contains that highest version is being uninstalled. The default value for this option is No.

Windows Installer 4.5 supports this new functionality; earlier versions of Windows Installer ignore this new setting. In
addition, if the DisableSharedComponent policy is set to 1 on a target system, Windows Installer ignores this setting for all
packages.

This feature applies to Basic MSI, InstallScript MSI, Merge Module, and Transform projects.

To learn more, see Specifying Whether Shared Component Patching Should Be Enabled for a Component.

Beta Windows Installer 4.5 Support for Superseding Components

Use the new Uninstall Superseded Component setting in the Components view to specify how you want Windows Installer
4.5 to handle the selected component during installation of a superseding patch under certain conditions. To specify that
this component in the current patch should be flagged for uninstallation in order to avoid leaving this component
orphaned on the target system after a superseding patch is applied, select Yes. If a subsequent patch is installed and it is
flagged to supersede the first patch, Windows Installer can unregister and uninstall this component if appropriate. If you
select No, the superseding patch can leave an orphaned component on the target system, and none of the feature’s
remaining components can be maintained. The default value for this setting is No.

Windows Installer 4.5 supports this new functionality; earlier versions of Windows Installer ignore this new setting.

This feature applies to Basic MSI, InstallScript MSI, Merge Module, and Transform projects.

For more information, see the description of the Uninstall Superseded Component setting.

To learn more about patch sequences, see Patch Sequencing.

Beta Windows Installer 4.5 Support for Running a Custom Action Only During Patch Uninstallation
Use the new Run During Patch Uninstall setting for a custom action to indicate whether Windows Installer should run the
selected custom action only when a patch is being uninstalled. This setting is available in the Custom Actions and
Sequences view of Basic MSI, InstallScript MSI, MSI Database, and Transform projects. It is also available in the Custom
Actions view of Merge Module and MSM Database projects.

You can also use the Run During Patch Uninstall check box on the Additional Options panel in the Custom Action Wizard to
configure the behavior of a custom action.

For details about this new functionality, see Run During Patch Uninstall.

Beta Support for Windows Installer 4.5 Redistributables

InstallShield includes several InstallShield prerequisite files (.prq) for Windows Installer 4.5.

224 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

This feature applies to Basic MSI and InstallScript MSI projects.

For more information, see Adding Windows Installer Redistributables to Projects.

Ability to Create Unicode Versions of the Setup.exe and Update.exe Bootstrappers

InstallShield now enables you to specify whether you want to create a Unicode version or an ANSI version of the Setup.exe
setup launcher for a Basic MSI project. Previously, if your Basic MSI project included a setup launcher, InstallShield always
built an ANSI version; it did not include support for building a Unicode version.

A Unicode setup launcher can correctly display double-byte characters in the user interface of the setup launcher,
regardless of whether the target system is running the appropriate code page for the double-byte-character language. An
ANSI setup launcher displays double-byte characters in the setup launcher dialogs if the target system is running the
appropriate code page. However, it displays garbled characters instead of double-byte characters in those dialogs if the
target system is not running the appropriate code page.

Use the new Setup Launcher Type setting on the Setup.exe tab for a release in the Releases view to specify whether you
want to use Unicode or ANSI. Unicode is the default type for all new Basic MSI projects.

InstallShield also now enables you to specify whether you want to create a Unicode version or an ANSI version of the
Update.exe update launcher for a patch or a QuickPatch package.

Use the new Update Launcher Type setting on the Advanced tab for a patch configuration in the Patch Design view to
specify whether you want to use Unicode or ANSI. For a QuickPatch project, the Update Launcher Type setting is on the
Advanced tab in the Build Settings area of the General Information view. Unicode is the default type for all new patch
configurations and QuickPatch packages.

Ability to Create a Log File for the Setup.exe Bootstrapper

A new /debuglog command-line parameter is available for the Setup.exe setup launcher for Basic MSI and InstallScript
MSI projects. Use this command-line parameter to generate a log file for debugging. For more information, see /debuglog.

Support for Managed-Code Custom Actions

InstallShield lets you add managed-code custom actions to Basic MSI, InstallScript MSI, and Merge Module projects. This
type of custom action calls a public method in a .NET assembly that is written in managed code such as Visual Basic .NET or
C#.

For detailed information, see:

• Calling a Public Method in a Managed Assembly

• Run-Time Requirements for Managed-Code Custom Actions

• Specifying the Signature for a Managed Method in an Assembly Custom Action

• Configuring Custom Action Settings

Support for Installing Multiple Instances of a Product

InstallShield now includes support for creating an installation that allows an .msi package to be used to install multiple
instances of a product in the same context on the same machine. Use the new Multiple Instances tab for a product
configuration in the Releases view to define different instances of your product and configure the properties that are
associated with each instance.

InstallShield 2020 User Guide ISP-2600-UG00 225

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

At build time, InstallShield creates a product code–changing instance transform for each instance and streams the
instance transforms into the .msi package. At run time, the setup launcher displays a new instance selection dialog that
lets end users specify whether they want to install a new instance, or update or maintain an already installed instance.

In addition, if you build a patch in the Patch Design view for a product whose installation includes multiple-instance
support, InstallShield now creates a patch that enables end users to update a specific instance or all instances. At run time,
the Update.exe file displays a patch version of the instance selection dialog.

A new /instance command-line option is available for Setup.exe and Update.exe. This option lets you specify which
instance you want to install, update, or uninstall; it also lets you suppress the instance selection dialog.

Multiple-instance support is available for Basic MSI projects.

For more information, see:

• Installing Multiple Instances of Products

• Run-Time Requirements for Multiple-Instance Support

• Configuring Multiple Instances in InstallShield

• Special Considerations for Multiple-Instance Support

• Configuring and Building a Release that Includes Multiple-Instance Support

• Creating Patches for Multiple Instances of a Product

• Run-Time Behavior for Installing Multiple Instances of a Product

• Creating a Setup Launcher

• Multiple Instances Tab for a Product Configuration

• Setup.exe and Update.exe Command-Line Parameters

New Microsoft .NET Redistributables Available

InstallShield now includes many new .NET-related InstallShield prerequisites that you can add to Basic MSI and
InstallScript MSI projects:

• Microsoft .NET Framework 3.5 (Web Download)

• Microsoft .NET Framework 3.5 (Full Package)

• Microsoft .NET Framework 3.5 Language Packs (x86, x64, IA64)

• Microsoft .NET Framework 3.0 SP1 (Web Download)

• Microsoft .NET Framework 3.0 Language Packs

• Microsoft .NET Framework 2.0 SP1 (x86, x64, IA64)

In addition, an updated Microsoft .NET Framework object is available in InstallShield for InstallScript projects. This object
includes support for versions 3.5, 3.0 SP1, 3.0, 2.0 SP1, 2.0, 1.1 SP1, and 1.0 SP3 of the .NET Framework, including 32-bit, 64-
bit x64, and 64-bit Itanium versions. The object also includes all supported language packs, as well as the Web downloader
redistributables where available.

For more information, see:

• Adding .NET Framework Redistributables to Projects

226 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Including the Microsoft .NET Framework and Microsoft .NET Framework Language Pack Prerequisites

• Microsoft .NET Framework Object Wizard

New .msi Package Tools

InstallShield includes several new tools:

• InstallShield MSI Diff enables you to quickly compare two .msi, .msm, or .pcp files. It lets you apply one or more .msp
and .mst files to an .msi file and see the changes in the resulting .msi database. You can also use this tool to compare
two InstallShield project files (.ism or .ise) that are saved in binary format. This tool uses color coding to show
additions, modifications, deletions, and schema differences. You can easily integrate it with most source code control
systems.

• InstallShield MSI Query lets you test SQL statements using the Windows Installer version of SQL before you run them
in your build script. You can quickly see if a SQL statement is formatted correctly and view the results that it generates.

• InstallShield MSI Sleuth is a diagnostic tool that lets you view the current installed state of a target system.
InstallShield MSI Sleuth displays a list of all of the .msi packages that are installed. You can click any .msi package in
the list to see the status of its features and components, its known source locations, as well as tables and binary
streams within the database. This tool also helps you identify the installed product or products whose packages
contain a specific component code.

• InstallShield MSI Grep searches a collection of .msi and .msm packages for specific text. You can narrow the search to
show results for only certain tables or columns.

You can launch any of these tools from the InstallShield Tools subfolder on the Windows Start menu.

These InstallShield MSI tools are included with the Premier and Professional editions of InstallShield. The Premier edition
also includes a separate installation and extra licenses that let you install just the tools, without InstallShield, on separate
machines. For specific terms, see the InstallShield End-User License Agreement.

For more information, see InstallShield MSI Tools.

Ability to Compress Files that Are Streamed into Setup.exe and ISSetup.dll and to Specify the
Compression Level
If you build a release that uses a Setup.exe setup launcher or a ISSetup.dll file (which contains the InstallScript engine),
InstallShield now compresses files that it streams into the Setup.exe file or the ISSetup.dll file. The default compression
level that InstallShield uses offers a balance between file size and time that is required to extract the compressed files at
run time. If you want to change the compression level or you do not want to use any compression, you can override the
default level through a machine-wide setting.

By default, InstallShield does not compress any files that have a .cab file extension when it is streaming them into the
Setup.exe file at build time, since .cab files are already a compressed type of file. You can modify this default compression
exclusion list to include other file types or specific files as needed. The exclusion list is a machine-wide setting.

This feature applies to Basic MSI and InstallScript MSI projects.

For more information, see Configuring the Compression Level for Files that Are Streamed into Setup.exe and ISSetup.dll.

Support for Multi-Part .cab Files

The .cab file type has some limitations. For example, the maximum size of a single .cab file is 2 GB. In addition, some users
have had trouble signing large .cab files and verifying the digital signature of large signed .cab files. To work around these
limitations, InstallShield now has a new default limit of 600 MB for a .cab file. When InstallShield is creating the .cab files for
your release and it reaches the limit, it splits the data into two or more .cab files, creating multi-part .cab files.

InstallShield 2020 User Guide ISP-2600-UG00 227

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

You can modify the maximum size limit if necessary. In addition, if you do not want InstallShield to create multi-part .cab
files, you can configure it to create single .cab files.

This functionality applies to Basic MSI and InstallScript MSI projects. In addition, it is applicable only if you are building a
compressed network image release in which all of the files are embedded in the single-file .msi package or the Setup.exe
setup launcher. This functionality does not apply to custom compression, where only the files that are associated with one
or more features are compressed into .cab files.

For more information, see Configuring the Maximum Size for .cab Files.

Support for Adding an Open Dialog to a Basic MSI Installation to Let End Users Browse to a File
InstallShield includes support for launching the Open dialog from one of the dialogs in your Basic MSI installation. End
users click a browse button in one of your dialogs, and this launches the Open dialog. The Open dialog lets the end user
browse for a file. When the end user selects the file and clicks the Open button, the Open dialog closes, and the installation
writes the full path and file name in an edit field on the dialog. The installation also sets the value of the
IS_BROWSE_FILEBROWSED property to the path and file name of the file that the end user selected.

To use this functionality, you must add to your project the new Windows Installer DLL custom action called FileBrowse.
This custom action calls the FileBrowse.dll file. In addition, you must add an edit field control and the browse button
that launches the Open dialog, and set a related dialog event. For complete instructions, see Launching a File Open Dialog.

Support for Installing IIS 7 Web Sites on Windows Server 2008

InstallShield now lets you create and manage IIS 7 Web sites, virtual directories, Web service extensions, and application
pools on Windows Server 2008 systems. This functionality is available in Basic MSI, InstallScript, and InstallScript MSI
projects.

Microsoft SQL Server 2005 Express SP2 Prerequisite Available

InstallShield now includes an InstallShield prerequisite for Microsoft SQL Server 2005 Express Edition SP2. You can add this
InstallShield prerequisite to Basic MSI and InstallScript MSI projects.

MySQL 5.0 Support

InstallShield now lists the 5.0.x versions of MySQL in the predefined list of database servers that you can select when you
are specifying in the SQL Scripts view the target database servers that your product supports. Previously, it was necessary
to create a custom version requirement.

Microsoft Visual Studio 2008 Support

InstallShield is now integrated with Visual Studio 2008, enabling development of installations and products within the
same Visual Studio interface.

Ability to Convert Visual Studio Setup and Merge Module Projects to InstallShield Projects
InstallShield now lets you convert a Visual Studio 2008, Visual Studio 2005, Visual Studio .NET 2003, or Visual Studio .NET
setup project (.vdproj) to a Basic MSI project (.ism). In addition, InstallShield enables you to convert a Visual Studio 2008,
Visual Studio 2005, Visual Studio .NET 2003, or Visual Studio .NET merge module project (.vdproj) to an InstallShield Merge
Module project (.ism).

Converting these Visual Studio projects to InstallShield projects enables you to modify the layout of dialogs through a
visual Dialog Editor, manage features and components, and use other functionality that is available in InstallShield.

To learn more, see Converting or Importing Visual Studio Projects into InstallShield Projects.

228 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Arabic (Saudi Arabia) and Hebrew Language Support, and Dialog Editor Support for Right-to-Left
Languages
InstallShield now includes support for Arabic (Saudi Arabia) and Hebrew languages, which are written and read from right
to left. All of the default end-user dialog strings are available in these languages.

Since these languages are read from right to left, InstallShield also includes support for mirroring Arabic and Hebrew
dialogs; that is, InstallShield uses a right-to-left layout for Arabic and Hebrew dialogs. Thus, for example, buttons that are
on the right side of dialogs in English and other left-to-right languages are moved to the left side of right-to-left-language
dialogs. In addition, InstallShield uses mirror-image versions of the dialog images that are displayed for the built-in dialog
themes.

The right-to-left layouts and reversed images are used in the Dialog Editor pane in the Dialogs view of InstallShield, and
also at run time.

The Arabic and Hebrew support is available in the InstallShield Premier Edition. The Premier edition now includes support
for 35 different languages.

The following project types include support for this feature: Basic MSI and Merge Module.

For more information, see Dialog Support for Right-to-Left Languages.

String Entry Validation in InstallScript Files (.rul)

When you build a project that includes an InstallScript file (.rul) and the InstallScript code contains one or more references
to string entries that use the string constant operator (@), InstallShield now validates the string entries at build time.

If a string identifier in the project’s InstallScript file is not defined for one of the project’s string entries, InstallShield
displays build warning -7174.

This applies to the following project types: Basic MSI with InstallScript custom actions, InstallScript, InstallScript MSI,
InstallScript Object, and Merge Module with InstallScript custom actions.

To learn more, see:

• Description of build warning -7174

• String Constant Operator (@)

New FlexNet Connect 11 Redistributables Available

InstallShield includes support for FlexNet Connect 11 in Basic MSI and InstallScript MSI projects. Use the Update
Notifications view in InstallShield to include one of the two FlexNet Connect 11 merge modules—one has the Common
Software Manager, and the other does not.

Enhancements
InstallShield includes the following enhancements.

Best Practice Dynamic File Linking

When you add or modify a dynamic file link in your project, you can now specify which component creation method you
want InstallShield to use: a new best practice method, or the previously available one-component-per-directory method.

InstallShield 2020 User Guide ISP-2600-UG00 229

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

When best practices for component creation are followed, InstallShield creates a separate component for each portable
executable (PE) file in the dynamically linked folder and sets each PE file as the key file of its component. If you later want
to create a patch that updates one of the dynamically linked PE files, it is easier to do so than it would be if you had used
the one-component-per-directory method.

Previously, any time that you added dynamic file links to a project, InstallShield automatically created one component for
all of the dynamically linked files at build time. However, if your dynamic file link included PE files, Windows Installer best
practices for component creation were not followed.

By default, InstallShield considers the following file types to be PE files: .exe, .dll, .ocx, .vxd, .chm, .hlp, .tlb, and .ax. You can
modify this list through the new File Extensions tab on the Options dialog box.

The automation interface includes support for this new best practice method. The ISWiDynamicFileLinking object includes
a new CreateBestPracticeComponents property that lets you specify whether you want to use the best practice method, or
the previously available one-component-per-directory method for a dynamic file link. When you create a new dynamic file
link using the AddDynamicFileLinking method, the best practice method is used by default.

The best practice dynamic file linking applies to Basic MSI, InstallScript MSI, and Merge Module projects.

To learn more, see:

• Determining the Appropriate Component Creation Method for Dynamically Linked Files

• Dynamic File Link Settings Dialog Box

• File Extensions Tab

• ISWiDynamicFileLinking Object

• AddDynamicFileLinking Method

Ability to Hide Setup Prerequisites from the List of Prerequisites to Be Installed

If a target system needs one or more setup prerequisites to be installed, the setup prerequisite dialog is displayed at run
time before the main installation runs. The Behavior tab in the InstallShield Prerequisite Editor has a new check box that
lets you specify whether you want a setup prerequisite to be hidden from the list of prerequisites in the prerequisite dialog.
If a prerequisite is hidden, it is installed when the conditions require it, even though it is not listed as one of the
prerequisites that needs to be installed.

New prerequisites and existing prerequisites that were created before this functionality was available are not hidden by
default. You can change this behavior by selecting the new check box on the Behavior tab.

For more information, see Specifying Whether to Include the Name of a Prerequisite in the List of Setup Prerequisites to Be
Installed on the Target System.

Ability to Show the Progress of an InstallShield Prerequisite Installation at Run Time

The Behavior tab in the InstallShield Prerequisite Editor has a new check box that lets you specify whether you want the
prerequisite installation to show installation progress messages from Windows Installer at run time. This augments the
progress bar to reflect the current progress status of the .msi installation. This functionality is available only if the
prerequisite launches an .msi file; it is not possible if the prerequisite launches a Setup.exe file. For more information, see
Specifying Whether to Show the Progress of an InstallShield Prerequisite Installation at Run Time.

For new prerequisites and existing prerequisites that were created before this functionality was available, the progress is
not shown by default. You can change this behavior by selecting the new check box on the Behavior tab.

230 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Note that if you specify that you want to show the progress, only some of the available command-line parameters are
supported. To learn more, see Specifying Command-Line Parameters for an InstallShield Prerequisite.

Ability to Use Windows Installer Properties in Command-Line Statements for InstallShield Prerequisites
Basic MSI and InstallScript MSI installations now can substitute and pass the following properties on setup prerequisite
command lines: ProductLanguage, ISPREREQDIR, SETUPEXEDIR, and SETUPEXENAME. You can use these properties to identify
the launching installation ("[SETUPEXEDIR]\[SETUPEXENAME]"), to identify full paths to files that are included in the
prerequisite ("[ISPREREQDIR]myconfig.ini"), or to pass the selected language to multilingual prerequisites such as an
InstallShield setup launcher (/l[ProductLanguage]). The new feature prerequisites include command-line support for any
Windows Installer property, including the aforementioned properties.

You can specify the command lines on the Application to Run tab of the InstallShield Prerequisite Editor.

For more information, see Specifying Command-Line Parameters for an InstallShield Prerequisite.

New Option for Reboot Behavior of InstallShield Prerequisites

The Behavior tab of the InstallShield Prerequisite Editor is where you specify how an InstallShield prerequisite installation
should proceed if it appears that the target machine needs to be restarted. The If the prerequisite appears to need a
reboot list is where you specify the behavior. This list has a new option, called Note it, fail to resume if the machine is
rebooted, and reboot after the installation. If it appears that a restart is required at run time but you want to postpone it
until the end of the main installation (or until a subsequent prerequisite triggers a restart), select this new option.

For more information, see Behavior Tab.

Support for Single-File, Compressed InstallScript Installations of up to 4 GB

A single-file, compressed InstallScript installation can now be up to 4 GB in size. Previously, when end users ran large
single-file, compressed InstallScript installations, the installations crashed during setup initialization.

Note that Setup.exe files cannot exceed 4 GB because Windows will not load an executable file that is larger than 4 GB.

Ability to Install IIS Web Sites Without Virtual Directories and to Associate Web Sites with Components
InstallShield now includes support for installing IIS Web sites without any virtual directories. In addition, the General tab
that InstallShield displays when you select a Web site in the Internet Information Services view now has a Component
setting; use this setting to associate the selected Web site with a component. As a result of these enhancements, a Web site
is created on a target machine if a virtual directory or a component that is associated with it is installed.

If a Web site is associated with a component, the Web site’s Delete Web Site on Uninstall check box corresponds with the
Permanent setting for that component in a Basic MSI or InstallScript MSI project, or with the Uninstall setting for that
component in an InstallScript project. That is, if you select or clear the Delete Web Site on Uninstall check box for a Web
site, InstallShield automatically updates the value of the component’s Permanent setting or Uninstall setting, as
appropriate.

Previously, InstallShield did not include support for associating Web sites with components. Therefore, if a Web site in an
installation did not have any virtual directories, the Web site would not be created at run time.

If you add a new Web site through the Internet Information Services view in InstallShield 2009, InstallShield automatically
associates that Web site with a component. If you upgrade an InstallShield 2008 or earlier project that already has an IIS
Web site, InstallShield does not automatically associate that Web site with a component.

The following project types support these IIS enhancements: Basic MSI, InstallScript, and InstallScript MSI.

InstallShield 2020 User Guide ISP-2600-UG00 231

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Note that if a Web site is associated with a component in an InstallScript project, any virtual directories that are added to
that Web site must be associated with the same component. Therefore, if you try to change the component for a Web site
that contains one or more virtual directories, InstallShield displays a message box to inform you that it will also make the
same component change for all of that Web site’s virtual directories; InstallShield also displays this message box if you try
to change the component for any virtual directories in a Web site. In either case, the message box enables you to proceed
or cancel the component change. For Basic MSI and InstallScript MSI projects, keeping a Web site in the same component
as all of the Web site’s virtual directories is not required, but it is recommended.

To learn more, see:

• Creating a Web Site and Adding an Application or a Virtual Directory

• Feature and Component Associations for IIS Support

• Uninstalling Web Sites, Applications, and Virtual Directories

Simplification of QuickPatch Packages

InstallShield now offers the ability to build streamlined QuickPatch packages, which typically have fewer new subfeatures
and built-in InstallShield custom actions than those built in earlier releases of InstallShield. A new Streamline QuickPatch
setting on the Advanced tab in QuickPatch projects lets you specify whether InstallShield should create this new simpler
type of QuickPatch package.

For more information, see:

• Specifying Whether to Streamline the QuickPatch Package

• Advanced Tab

Ability to Build a Patch from the Command Line and from MSBuild
The -patch_config command-line parameter is available for command-line builds (including the Standalone Build
command-line builds) with ISCmdBld.exe. Use this parameter to build a patch from the command line.

If you use an .ini file to pass parameters to the command line, you can use the new PatchConfigName parameter in the
[Project] section of your .ini file to indicate the patch configuration that you want to build.

In addition, the InstallShield task for MSBuild now includes a PatchConfiguration parameter, which you can use to specify
the patch configuration that you want to build through MSBuild.

To learn more, see:

• ISCmdBld.exe

• Passing Command-Line Build Parameters in an .ini File

• Microsoft Build Engine (MSBuild)

Ability to Password-Protect Patches and QuickPatch Packages

InstallShield now has new password settings that let you password-protect patches and QuickPatch packages. These
settings are on the Advanced tab in the Patch Design view of Basic MSI and InstallScript MSI projects, and on the Advanced
tab of QuickPatch projects.

If you password-protect a patch or QuickPatch package, any end user who wants to install the package must enter a case-
sensitive password to launch your update.

To learn more, see the following:

232 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Password-Protecting a Patch Package

• Password-Protecting a QuickPatch Package

• Advanced Tab (for a patch configuration in the Patch Design view)

• Advanced Tab (for a QuickPatch project)

Patch and Upgrade Validation Support in QuickPatch Projects

When you build QuickPatch projects, InstallShield now runs patch and upgrade validation. This validation helps identify
some common problems that may be encountered when attempting to upgrade a product with a QuickPatch package.

Previously, the patch and upgrade validation was available only for Basic MSI projects and InstallScript MSI projects, and
patches that were created in the Patch Design view.

To learn more, see Validating Upgrades, Patches, and QuickPatch Packages.

Ability to Select Multiple .cub Files for Performing Validation at Build Time
The Validation tab on the Options dialog box in InstallShield now lets you specify more than one .cub file that should be
used to validate your installation package or merge module when it is built from within InstallShield.

In addition, you can now pass more than one .cub file through the -m command-line parameter for command-line builds
(including the Standalone Build command-line builds) with ISCmdBld.exe. If you use an .ini file to pass parameters to the
command line, you can now specify more than one .cub file for the CubFile parameter in your .ini file.

The RunMsiValidator parameter of the InstallShield task for MSBuild has been enhanced to accept more than one .cub file.

For more information, see:

• Requirements for the Windows Logo Program

• Validating an Installation Package or Merge Module

• Specifying Whether Validation Should Be Performed at Build Time

• Validating an Installation Package or Merge Module

• Validation Tab (on the Options dialog box)

• Build Menu

• ISCmdBld.exe

• Passing Command-Line Build Parameters in an .ini File

• Microsoft Build Engine (MSBuild)

New Validator for the InstallShield Best Practice Suite

ISBP20 is a new validator that is available with the InstallShield Best Practice Suite. ISBP20 verifies that no registry entries
contained in the Registry table attempt to remove root-level registry keys or other keys that would cause adverse issues
on target machines during uninstallation.

The InstallShield Best Practice Suite is available in the Premier edition of InstallShield for Basic MSI, InstallScript MSI, and
MSI Database projects.

InstallShield 2020 User Guide ISP-2600-UG00 233

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Ability to Use the /v Command-Line Parameter More than Once to Pass More than One Parameter from
Setup.exe to the .msi File
If you want to pass more than one argument from Setup.exe to Msiexec.exe, you can use the /v option multiple times at
the command line, once for each argument. Previously, the /v option could be used only once, and all parameters were
passed through this instance.

The following project types include support for this enhancement: Basic MSI and InstallScript MSI.

For more information, see Setup.exe and Update.exe Command-Line Parameters.

Improved Compatibility Between the Standalone Build and InstallShield

The Standalone Build that is available with InstallShield Premier Edition now uses the same directory structure that
InstallShield uses for its program files. Therefore, if you need to copy a redistributable or some other file from a machine
that has InstallShield to a machine that has the Standalone Build, use the same relative path. Previously, the directory
structures were different and inconsistent.

In addition, the ISCmdBld.exe file that is used for command-line builds with InstallShield is now installed with the
Standalone Build. Previously, the Standalone Build used IsSaBld.exe, a different file, for command-line builds.
ISCmdBld.exe now supports parameters that previously only IsSaBld.exe supported:

• -o <merge module search path>—Specifies one or more comma-delimited folders that contain the merge module
(.msm) files referenced by your project.

• -t <Microsoft .NET Framework path>—Specifies the path to the Microsoft .NET Framework. The path is the location of
the .NET Framework that is installed on the build machine.

• -h—Indicates that you want to skip the upgrade validators at the end of the build.

• -g <minimum target MSI version>—Specifies the minimum version of Windows Installer that the installation
requires on the target machine.

• -j <minimum target Microsoft .NET Framework version>—Specifies the minimum version of the .NET Framework
that the installation requires on the target machine.

Also as part of this enhancement, the Standalone Automation Interface uses the same ISWiAutomation15.dll file that
InstallShield uses, but it is installed to a different location. If you have existing automation scripts that work with the
InstallShield Automation Interface, you no longer need to change the library name from IswiAutoN to SAAutoN throughout
the scripts in order to use them with the Standalone Automation Interface. Note that with this change, the ISWiProject
object includes support for several properties that were previously available for only the Standalone Automation Interface:

• DotNetFrameworkPath

• MergeModuleSearchPath

• MinimumTargetDotNetVersion

• MinimumTargetMSIVersion

• SelfRegistrationMethod

• SkipUpgradeValidators

An advantage of these compatibility improvements is that only one set of binaries, rather than two separate sets, is built for
the Standalone Build and InstallShield; if an InstallShield hotfix or service pack is released, it can be used to update the
Standalone Build and InstallShield. Previously, separate hotfixes and service packs were required.

To learn more, see:

234 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Installing the Standalone Build on a Build Machine

• Adding Redistributables to the Build Machine for the Standalone Build

• Standalone Command-Line Build

• Standalone Automation Interface

• Installing the Standalone Build and InstallShield on the Same Machine

• ISCmdBld.exe

• ISWiProject Object

Support for Browsing to Local, Remote, and Alias SQL Servers in the SQLBrowse Run-Time Dialog
The filter functionality of the SQLBrowse dialogs has been enhanced.

To show only remote servers in the SQL Server browse combo box and list box controls in Basic MSI and InstallScript MSI
installations, you can set the new Windows Installer property IS_SQLSERVER_REMOTE_ONLY. To show only server aliases in
the SQL Server browse combo box and list box controls in Basic MSI and InstallScript MSI installations, you can set the new
Windows Installer property IS_SQLSERVER_ALIAS_ONLY. Previously, the only filtering that was available was showing only
local servers; this is available if you set the IS_SQLSERVER_LOCAL_ONLY property. You can now set any combinations of
these properties to display multiple types of servers in the SQL Server browse combo box and list box controls.

To learn more, see Overriding the Default SQL Run-Time Behavior.

Two new InstallScript functions are available for InstallScript projects:

• SQLRTSetBrowseOption—This function lets you specify whether the SQL Server browse combo box and list box
controls show local servers, remote servers, server aliases, or a combination of these types.

• SQLRTGetBrowseOption—This function returns the current value of the browse option for the SQL Server browse
combo box and list box controls, which can display local servers, remote servers, server aliases, or a combination of
these types.

Ability to Continue an Installation If the Minimum SQL Database Server Requirements Are Not Met
The Requirements tab that is displayed when you select a SQL connection in the SQL Scripts view has a new Allow
installation to continue when minimum requirements are not met check box.

If you select this check box and the minimum database server requirements are not met on a target system, the run time
skips the SQL connection and all of its SQL scripts, and continues with the installation.

If you clear this check box and the minimum requirements are not met, the installation does not allow the end user to
continue with the rest of the installation. This is the default behavior.

This enhancement applies to Basic MSI, InstallScript, and InstallScript MSI projects.

For more information, see Requirements Tab.

SQL Server Alias Support

The SQL run-time support has been enhanced: installations can now list SQL Server alias names in the SQLBrowse dialog.
In addition, the SQLLogin dialogs let end users use an alias name to connect to a SQL Server.

This enhancement applies to Basic MSI, InstallScript, and InstallScript MSI projects.

To learn more, see Adding a New SQL Connection.

InstallShield 2020 User Guide ISP-2600-UG00 235

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Predefined System Searches for the .NET Framework

InstallShield has several new predefined system searches:

• Microsoft .NET Framework 3.5

• Microsoft .NET Framework 3.0 SP1

• Microsoft .NET Framework 3.0

• Microsoft .NET Framework 2.0 SP1

• Microsoft .NET Framework 2.0

• Microsoft .NET Framework 1.1

• Microsoft .NET Framework 1.0

If your installation requires any of these, you can use the System Search view or the Installation Requirements page in the
Project Assistant to add these system searches to your project. When end users launch your installation, Windows Installer
checks the target system to see if the requirements are met; if they are not met, the installation displays the error message
that is defined for the system search.

This enhancement applies to Basic MSI and InstallScript MSI projects.

Expanded Support for the Error Type of Custom Action

The Custom Action Wizard now includes support for a type 19 custom action, which displays a specified error message,
returns failure, and ends the installation. Previously, the only way to create this type of custom action was to right-click the
Custom Actions explorer in the Custom Actions and Sequences view and then click Error, or to use the Direct Editor to
manually enter the custom action’s table entry.

The following project types now support the error custom action: Basic MSI, InstallScript MSI, Merge Module, MSI Database,
MSM Database, and Transform. Previously, only Basic MSI and InstallScript MSI projects included support.

Ability to Specify Whether to Digitally Sign Source Files

The Signing tab in the Releases view has a new Sign files in their original location check box. This check box lets you
specify whether you want InstallShield to sign your original source files or just the files that are built into the release. This
check box is also available on the Digital Signature Options panel in the Release Wizard. The check box is cleared by
default.

The benefit of selecting this check box for a Basic MSI or InstallScript MSI project is that it helps create one patch that
updates both compressed and uncompressed versions of a release that contains originally unsigned files.

Previously, the check box was not available, and InstallShield never enabled you to sign the files in their original location.

The automation interface now includes support for this new digital signing functionality. The ISWiRelease object includes a
new SignFilesInPlace property that lets you specify whether you want InstallShield to sign your original source files or just
the files that are built into the release.

To learn more, see:

• Signing Tab for a Release

• Digital Signature Options Panel

• Digital Signing and Security

• ISWiRelease Object

236 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Improved Static COM Extraction

If you use static COM extraction, InstallShield now uses an MD5 algorithm when generating primary keys for the Registry
table. Therefore, if the COM data does not change, the primary keys do not change between different versions of a package
and when the extracted COM data is refreshed.

Previously, InstallShield used random values for the primary keys that it created during static COM extraction. As a result, if
the COM data were refreshed or a patch were built, it was possible for new primary keys to be created, even if the COM data
had not changed. In the patch scenario, the COM data would be included in the patch if the primary keys changed. If a
patch updated a component with unchanged COM data, the COM data could be removed during patch uninstallation, and
this could cause issues in the earlier version of the product.

This enhancement applies to Basic MSI and InstallScript MSI projects.

InstallScript Language Enhancements and New Functionality

Some enhancements have been made to the InstallScript language.

Enhancements for .NET Framework 3.5 and .NET Framework 3.0 SP1 Support

A new FOLDER_DOTNET_35 InstallScript variable is available. This variable stores the path of the .NET Framework 3.0 files.

Two new constants are available for use with the function Is:

• REGDB_KEYPATH_DOTNET_35

• REGDB_KEYPATH_DOTNET_30_SP

You can use the REGDB_KEYPATH_DOTNET_30_SP variable when querying whether SP1—or a later service pack—of the
.NET Framework 3.0 is installed. To detect whether the RTM version of the .NET Framework 3.0 is installed, use
REGDB_KEYPATH_DOTNET_30.

New GetTempFileNameIS Function that Calls the Windows API GetTempFileName to Create a Temporary File

A new InstallScript function called GetTempFileNameIS is available. This function calls the Windows API
GetTempFileName to create a temporary file and perform related actions.

To learn more, see GetTempFileName.

See Also
What’s New in InstallShield 2009 SP1
Upgrading Projects from InstallShield 2008 or Earlier
Upgrading Projects from InstallShield 12 or Earlier
Upgrading Projects from InstallShield 11.5 or Earlier

What’s New in InstallShield 2008

InstallShield 2020

New Features
InstallShield includes the following new features.

InstallShield 2020 User Guide ISP-2600-UG00 237

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New End-User Dialog Themes for Basic MSI Projects

Dialog themes are predefined sets of images that give your end-user dialogs a unified and distinctive look. With the click of
a button, you can now select one of the available themes for your project, and InstallShield applies that theme to all of the
interior and exterior dialogs, as well as the Setup.exe initialization dialog, in your project. You can easily preview each
dialog from within the Dialogs view to see how it looks with the selected theme.

Some of the themes are available in both the Premier and Professional editions of InstallShield, and some are available in
only the Premier edition. For more information, see Available Themes and Corresponding Dialog Sizes.

For more information about this feature, see the Dialog Themes section of this documentation.

Digital Signing Improvements

InstallShield now lets you digitally sign any files—including your product’s executable files—in your project at build time. In
addition, you can now use a personal information exchange file (.pfx) for digital signatures. All of the following project
types support this functionality: Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, and Merge Module.

The new Signing tab in the Releases view is where you specify the digital signature information—including the digital
certificate files that a certification authority grated to you—that InstallShield should use to sign your files. The Signing tab
is also where you specify which files in your installation should be digitally signed. You can also use the Release Wizard to
specify all of the digital signature information.

If you specify a .pfx file for signing, InstallShield uses SignTool.exe to sign your files. If you specify an .spc file and a .pvk
file, InstallShield uses Signcode.exe to sign your files. Using a .pfx file is often the preferred method, since it is more likely
to work in many different environments (such as locked build machines). If you specify the digital signature password in
InstallShield, you will never see a password prompt if you are using a .pfx file. However, if you are using .spc and .pvk files,
a password prompt may be displayed.

Previously, InstallShield included support for signing only the .msi, .hdr, and Setup.exe files. In addition, InstallShield
allowed you to specify .spc and .pvk files for the digital signature, but not .pfx files.

To learn more, see the following:

• Digital Signing and Security

• Digitally Signing a Release and Its Files at Build Time

• Signing Tab for a Release

InstallShield Best Practice Suite Available in Premier Edition

InstallShield includes a set of validators called the InstallShield Best Practice Suite. The InstallShield Best Practice (ISBP)
validators in this suite alert you if your installation violates best-practice guidelines.

This feature is available for Basic MSI, InstallScript MSI, and MSI Database projects.

For more information, see:

• InstallShield Best Practice Suite

• Specifying Which ICEs, ISICEs, ISVICEs and ISBPs Should Be Run During Validation

Support for Internet Information Services (IIS) 7.0 and SSL

InstallShield now includes support for IIS 7.

238 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

In addition, InstallShield lets you include an SSL certificate for a Web site in your installation. Including an SSL server
certificate enables users to authenticate the Web server, check the validity of the Web content, and establish a secure
connection.

For more information, see:

• Internet Information Services View

• Specifying the SSL Certificate for a Web Site

• Determining If a Target System Has IIS 6 or Earlier or the IIS 6 Metabase Compatibility Feature

• Version-Specific Information for IIS Support in InstallShield

New Microsoft .NET Prerequisites Available

InstallShield now includes many new .NET-related setup prerequisites that you can add to Basic MSI and InstallScript MSI
projects:

• .NET Framework 2.0 (x64)

• .NET Framework 2.0 (x64) Language Packs

• .NET Framework 2.0 (IA64)

• .NET Framework 2.0 (IA64) Language Packs

• .NET Framework 3.0 (x64)

For more information, see Adding .NET Framework Redistributables to Projects.

Updated Microsoft .NET Object for InstallScript Projects

An updated Microsoft .NET object is available in InstallShield. This object includes support for versions 1.0 (SP3), 1.1 (SP1),
2.0, and 3.0 of the .NET Framework, including 32-bit, 64-bit x64, and 64-bit Itanium versions. The object also includes all
supported language packs, and the latest service packs of 1.0 and 1.1.

In addition, the object launches and completes the .NET Framework installation as the feature containing the .NET object
installs. This allows the .NET Framework to be available as early as possible, in case it is needed to install or configure files
that are subsequently installed during the installation.

For more information, see Microsoft .NET Framework Object Wizard.

Visual C++ 8.0 SP1 Merge Modules Available

InstallShield now includes Visual C++ 8.0 SP1 merge modules (version 8.0.50727.762).

Support for the UAC Shield Icon on Dialog Buttons (Basic MSI Projects)
In the Dialog Editor of Basic MSI projects, a new Show UAC Shield Icon property is available for all button controls. If you
select True for this property, the User Account Control (UAC) icon is displayed on the button when end users run the
installation on Windows Vista systems. If you are using InstallShield on a Windows Vista system, you can see the shield icon
on the button in the Dialog Editor as it will be displayed at run time. The shield icon signals to end users that elevated
privileges may be required.

InstallShield 2020 User Guide ISP-2600-UG00 239

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For any new Basic MSI projects that you create, the Show UAC Shield Icon property is set to True for the Install button on
the ReadyToInstall dialog. If you upgrade a Basic MSI project that was created with InstallShield 12 or earlier to
InstallShield 2008, the default value for the Install button’s Show UAC Shield Icon property is False. You can override the
value for this button, or for any other buttons, as required.

Ability to Require End Users to Scroll Through the EULA in the LicenseAgreement Dialog
InstallShield includes support for disabling the Next button on the LicenseAgreement dialog until the end user reaches the
end of the End-User License Agreement (EULA) text in the scrollable EULA control through mouse or keyboard scrolling.

The end user must also select the I accept the terms in the license agreement option before the Next button is enabled;
this behavior is the same as with earlier releases of InstallShield.

The scroll requirement is not available in the LicenseAgreement dialog by default. To use this functionality, you must add
to your project the new Windows Installer DLL custom action called WatchScroll. This custom action calls the
EulaScrollWatcher.dll file. In addition, you must modify the Next button’s Control conditions and add an event to the
Memo control.

This is available for Basic MSI projects.

For detailed instructions, see Requiring End Users to Scroll Through the EULA in the LicenseAgreement Dialog.

Microsoft SQL Server 2005 Express SP1 Setup Prerequisite Available

InstallShield now includes a setup prerequisite for Microsoft SQL Server 2005 Express Edition SP1. You can add this setup
prerequisite to Basic MSI and InstallScript MSI projects.

Updated DirectX 9.0c Objects

Two DirectX 9.0c objects are available with InstallShield: a Windows Installer–based object that is available for Basic MSI
and InstallScript MSI projects, and an InstallScript-based object that is available for InstallScript projects. Both of these
objects install all of the latest DirectX 9.0c core and optional components, including 32-bit-specific and 64-bit-specific
components.

In addition, some changes have been made to the DirectX 9 Object Wizard for Basic MSI and InstallScript MSI projects. The
wizard now lets you specify whether the redistributable files should be included in the Disk1 folder or streamed into the
.msi file. This change enables you to use the DirectX 9 object in compressed installations. Also, you can now use the DirectX
9 object in silent installations.

For Basic MSI and InstallScript MSI projects, the custom action that launches the DirectX installation is now sequenced in
the Execute sequence and run in deferred system context so that it can be run with elevated privileges on Windows Vista
systems.

To learn more, see:

• Including the DirectX 9.0 Object

• DirectX Object Wizard

DIFx 2.1 Support

InstallShield includes support for the latest version of Driver Install Frameworks for Applications (DIFx). This new version,
which includes the latest binary files from Microsoft, is available for any Basic MSI, InstallScript, or InstallScript MSI projects
that you create in InstallShield. This new version can be installed on Windows Vista systems. Earlier versions of
InstallShield included an earlier version of DIFx that failed to install on Windows Vista in some cases.

240 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Support for 64-Bit Self-Registration of COM Servers (Basic MSI Projects)

InstallShield now includes support for 64-bit self-registration of COM servers in Basic MSI projects. If you mark a
component as 64 bit and then add a file to that component, you can select the file’s Self Register check box to enable 64-bit
self-registration of that file during installation. In addition, InstallShield also supports 64-bit self-registration of
dynamically linked COM servers. For more information, see:

• Targeting 64-Bit Operating Systems with Basic MSI and InstallScript MSI Installations

• File Properties Dialog Box

• Adding Dynamic File Links to Components

Expanded Operating System Condition Settings in the Setup Prerequisite Editor

The Setup Prerequisite Editor now enables you to specify more details about operating system requirements when you are
creating conditions for a prerequisite. The Prerequisite Condition dialog box, which is displayed when you are adding or
modifying a condition for a prerequisite through the Setup Prerequisite Editor, lets you select a predefined operating
system or select the custom option. With the new custom option, you can configure settings for operating system
requirements such as platform, major and minor versions, processor architecture (64-bit or 32-bit), and service pack. If a
target system does not meet the operating system requirements, the prerequisite is not installed.

For more information, see the following:

• Adding an Operating System Condition for an InstallShield Prerequisite

• Prerequisite Condition Dialog Box

• Conditions Tab

Ability to Target Windows Server 2008 Systems

InstallShield enables you to specify that your installation requires Windows Server 2008. It also lets you build Windows
Server 2008–related conditions for features and components.

Note that Windows Vista and Windows Server 2008 use the same major and minor version numbers. Therefore, if you want
to use InstallScript to distinguish between Windows Server 2008 and Windows Vista, check whether
SYSINFO.nOSProductType = VER_NT_WORKSTATION; for Windows Vista, this is TRUE; for Windows Server 2008, it is FALSE.
For more information, see SYSINFO.

New MSXML 6 SP1 Setup Prerequisites Available

InstallShield now includes some new MSXML setup prerequisites that you can add to Basic MSI and InstallScript MSI
projects:

• MSXML 6.0 SP1

• MSXML 6.0 SP1 (IA64)

• MSXML 6.0 SP1 (x64)

To learn more about MSXML, see Run-Time Requirements for XML File Changes.

FlexNet Connect Support

You can add a redistributable for FlexNet Connect 6.1 to Basic MSI and InstallScript MSI projects.

InstallShield 2020 User Guide ISP-2600-UG00 241

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The Update Notifications view in Basic MSI and InstallScript MSI projects lets you select which version of FlexNet Connect
you want to include in your project. You can include version 6.1 or any version that is installed in any of the locations that
are specified in the Merge Module Location area on the Merge Module tab of the Options dialog box.

The Update Notifications view includes a new Vendor Database setting, which FlexNet Connect 6.1 supports.

Enhancements

Usability Enhancements for Releases

The release settings are now organized by category on several different tabs in the Releases view.

In addition, you can now select Compressed or Uncompressed for the Compression setting from within the Releases view.
Previously, the only way to modify this setting was to use the Release Wizard. Note that if you want to specify a custom
compression setting (one .cab file per feature or one .cab file per component), you must still use the Release Wizard. The
Compression setting is available in Basic MSI, InstallScript MSI, and Merge Module.

The settings in the Distribution view have been moved to the new Postbuild tab in the Releases view for Basic MSI,
InstallScript MSI, and Merge Module projects. The Postbuild tab lets you configure settings for distributing releases to a
folder or FTP site automatically at build time.

A new Distribute command is available when you right-click a release in the Releases view for Basic MSI, InstallScript MSI,
and Merge Module projects. When you select this command, InstallShield copies all of the relevant files for your release to
the locations that are specified on the Postbuild tab. Note that for InstallScript and InstallScript Object projects,
InstallShield automatically copies the release to the locations that you specify on the Postbuild tab every time that you
build the release.

To learn more, see:

• Build Tab for a Release

• Setup.exe Tab for a Release

• Signing Tab for a Release

• Internet Tab for a Release

• Events Tab for a Release

• Distributing Releases to a Folder or FTP Site Automatically

Usability Enhancements for Custom Actions and Sequences

The Custom Actions view and the Sequences view have been combined into a more robust view called the Custom Actions
and Sequences view. The combined view supports drag-and-drop editing and copying:

• To sequence a new custom action, drag it from the Custom Actions explorer to the appropriate location in a sequence
under the Sequences explorer.

• To move a dialog, standard action, or custom action to a different point in a sequence (or from one sequence to
another), drag it from the old location to the new location.

• To copy a custom action from one sequence to another, press and hold CTRL while dragging the custom action from
one sequence to another sequence.

The Custom Actions and Sequences view is available in Basic MSI, InstallScript MSI, MSI Database, and Transform projects.

For more information, see:

242 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Custom Actions and Sequences View (or Custom Actions View)

• Creating Custom Actions in the Custom Actions and Sequences View (or the Custom Actions View)

• Inserting Actions into Sequences

• Copying a Custom Action from One Sequence to Another

• Reordering a Sequence

Usability Enhancements for the Files and Folders view, the Registry View, and the Redistributables View
Several enhancements are available for the Files and Folders view:

• You can right-click a file in the Destination computer’s files pane and then click the new Open Containing Folder
command. Doing so opens a Windows Explorer window and displays the folder that contains the file that you right-
clicked.

• A new Add command is available when you right-click the Destination computer’s files pane. Use this command to
display an Open dialog box that lets you browse to the file that you want to add to your project.

• The upper-right corner of this view has a new link (either Show Source Panes or Hide Source Panes). Use this new link
to show or hide the two top panes—the Source computer’s folders pane and the Source computer’s files pane—in
this view. You can hide the two panes, open a Windows Explorer window, and drag and drop files from the Windows
Explorer window to the two remaining panes in InstallShield.

The Registry view also has a new link (either Show Source Panes or Hide Source Panes) in the upper-right corner. Use this
new link to show or hide the two top panes—the Source computer’s folders pane and the Source computer’s files
pane—in this view.

Two enhancements have also been made to the Redistributables view for Basic MSI and InstallScript MSI projects:

• The right pane in this view shows details about the merge module, object, or setup prerequisite that is selected in the
upper-left pane. You can now hide or show the details pane by clicking the Show Details or Hide Details link in the
upper-right corner of this view.

• The Details pane that is displayed for setup prerequisites now shows complete information about the selected setup
prerequisite. This includes conditions, command-line parameters, and other information that is configured for the
prerequisite.

Automation Interface Enhancements

Many enhancements have been made to the automation interface.

CreateProject Method Now Enables Creation of Merge Module Projects

The CreateProject method for the ISWiProject object now enables you to create merge module projects. Previously, this
method supported only Basic MSI, InstallScript, InstallScript MSI, and InstallScript Object projects.

To learn more, see CreateProject Method.

Support for Configuring Dynamic File Links

The automation interface includes a new object and a new collection for dynamic file links. In addition, the
ISWiComponent object includes two new methods and a property that let you add (AddDynamicFileLinking) and remove
(RemoveDynamicFileLinking) a component’s dynamic file link, as well as get the collection of dynamic file links
(ISWiDynamicFileLinkings).

InstallShield 2020 User Guide ISP-2600-UG00 243

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more details, see:

• ISWiDynamicFileLinking Object

• ISWiDynamicFileLinkings Collection

• ISWiComponent Object

• AddDynamicFileLinking Method

• RemoveDynamicFileLinking Method

Support for Configuring Path Variables

The automation interface includes a new object and a new collection for configuring path variables in a project. In
addition, the ISWiProject object includes two new methods and a property that let you add (AddPathVariable) and remove
(DeletePathVariable) a path variable from a project, as well as get the collection of path variables (ISWiPathVariables).

To learn more, see:

• ISWiPathVariable Object

• ISWiPathVariables Collection

• ISWiProject Object

• AddPathVariable Method

• DeletePathVariable Method

Support for Modifying String-Table Entries

The automation interface includes new objects and collections for configuring languages and string entries in a project.
The ISWiLanguage object includes two methods and a property that let you add (AddStringEntry) and remove
(DeleteStringEntry) a string entry from a project, as well as get the collection of string entries (ISWiStringEntries). In
addition, the ISWiProject object includes a new property (ISWiLanguages) that gets the collection of languages included in
the current project.

For more information, see:

• ISWiLanguage Object

• ISWiLanguages Collection

• ISWiStringEntry Object

• ISWiStringEntries Collection

• AddStringEntry Method

• DeleteStringEntry Method

• ISWiProject Object

Support for Configuring Environment Variables

The automation interface includes a new object and a new collection for environment variables. In addition, the
ISWiComponent object includes two new methods and a property that let you add (AddEnvironmentVar) and remove
(RemoveEnvironmentVar) a component’s environment variables, as well as get the collection of environment variables
(ISWiEnvironmentVars).

244 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• ISWiEnvironmentVar Object

• ISWiEnvironmentVars Collection

• ISWiComponent Object

• AddEnvironmentVar Method

• RemoveEnvironmentVar Method

ISWiProject Object Properties for Setting the Company Name, Company URL, and Company Phone Number

The ISWiProject object includes several new properties that let you specify values for General Information view settings:

• CompanyName

• CompanyURL

• CompanyPhone

ISWiRelease Object Properties for Digitally Signing Files

The ISWiRelease object includes several new properties that enable you to configure settings for digitally signing files for
releases at build time. The new properties are:

• CertificatePassword

• SignFiles

• SignFilesExclude

• SignFilesInclude

• SignSignedFiles

ISWiRelease Object Properties for Specifying Whether to Keep Unused Directories in the Directory Table

The ISWiRelease object includes a new KeepUnusedDirectories property that lets you specify whether you want to want
InstallShield to remove unused directories from the Directory table of the .msi file when you build this release.

ISWiRelease Object Property for Configuring Whether to Postpone Any Reboot for Installing or Updating the .NET
Framework

The ISWiRelease object includes a new DotNetDelayReboot property that lets you specify whether you want to postpone
any reboot associated with installing or updating the .NET Framework on the target system until after your installation has
completed.

ISWiRelease Object Property for Specifying Whether to Display a Message Box Asking the End User if They Want to
Install the .NET Framework

The ISWiRelease object includes a new DisplayDotNetOptionDialog property. Use this property to specify if a message box
should be displayed at run time to let end users indicate whether the .NET Framework should be installed.

ISWiRelease Object Properties for Configuring Build-Time Distribution Options

The ISWiRelease object now includes several new properties that enable you to configure settings for distributing releases
to a folder or FTP site automatically at build time. The new properties are:

• DistributeLoc

InstallShield 2020 User Guide ISP-2600-UG00 245

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• DistributeToURLLoc

• DistributeToURLUserName

• DistributeToURLPassword

• DistributeAfterBuild

New RemoveSequenceRecord Method for the ISWiSequence Collection

The ISWiSequence collection has a new RemoveSequenceRecord method that enables you to delete an item from a
sequence. To learn more, see RemoveSequenceRecord Method.

Basic MSI Projects Now Support Adding and Removing Support Files

The automation interface now includes support for the ISWiSetupFile and ISWiAdvancedFile objects in Basic MSI projects.
These objects include methods (AddSetupFile, DeleteSetupFile, AddAdvancedFile, and DeleteAdvancedFile) that are now
available in Basic MSI projects. Previously, these objects and methods were available in only InstallScript, InstallScript MSI,
and InstallScript Object projects.

To learn more, see:

• ISWiAdvancedFile Object

• ISWiAdvancedFiles Collection

• AddAdvancedFile Method

• DeleteAdvancedFile Method

• ISWiSetupFile Object

• ISWiSetupFiles Collection

• AddSetupFile Method

• DeleteSetupFile Method

• ISWiProject Object

XML File Change Enhancements

Support for XML file changes has been expanded in InstallShield:

• Now you can test just the XML file changes that are configured for your project through the XML File Changes view
without having to build and run your entire installation.

• The XML File Changes view now supports namespaces in XML files.

• InstallShield lets you specify the XML encoding of an XML file.

To learn more, see the following areas:

• Testing Installation Changes to an XML File

• Testing Uninstallation Changes to an XML File

• Using Namespaces in XML Files

• Declaring Namespace Mappings for an XML File

• Adding a Namespace Prefix to an Element

246 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• XML File Changes View

• Namespace Tab for an XML File

To learn more about XML file changes, see the Modifying XML Files section of the InstallShield Help Library.

Faster Direct Editor, String Table Editor, and Files Subview

Loading records in the Direct Editor and the String Table editor in InstallShield takes less time now. In addition, for projects
that contain a large number of files, InstallShield now displays the files in the Files subview within the Components view
more quickly than in earlier releases.

Enhanced User Account Control Support for InstallScript Projects

The Required Execution Level setting is now available on the Setup.exe tab in the Releases view for InstallScript projects.
Use this setting to specify the minimum level required by your installation’s Setup.exe file for running the installation (the
setup launcher) on Windows Vista platforms. InstallShield adds a manifest that specifies the required level.

Previously, InstallShield always included a Highest Available manifest for InstallScript projects, and the Required Execution
Level setting was available in only Basic MSI and InstallScript MSI projects.

For more information, see Specifying the Required Execution Level for Your Setup Launcher on Windows Vista and Later
Platforms.

Shortcuts View Enhancements

Some enhancements have been made to the Shortcuts view for Basic MSI, InstallScript MSI, and merge module projects.

• To change the icon that is used for a shortcut, you can right-click the shortcut and then click the new Change
Shortcut icon command. InstallShield opens the Change Icon dialog box, which enables you to select the icon file and
associated icon index that should be used when the shortcut is created on target systems at run time.

• Shortcuts that are listed in the Shortcuts explorer now show the icon image that will be used on the target system.
Previously, the Shortcuts explorer used a different image for all types of shortcuts, even if an icon was specified for the
shortcut.

For more details about these enhancements, see:

• Specifying the Icon for a Shortcut

• Shortcuts View

Windows Vista and Internet Explorer 7 Support for One-Click Install Installations
One-Click Install installations in InstallScript projects can now be used on Windows Vista systems and with Internet
Explorer 7. The One-Click Install setup player is now an external .ocx file, instead of being embedded in the Setup.exe file.
The setup player downloads and then launches the Setup.exe file with the appropriate command line. This enables end
users who are using Windows Vista with limited privileges to run the installation; if elevated privileges are required because
of the required execution level specified in the installation’s manifest, the appropriate User Account Control (UAC) prompt
is displayed when the Setup.exe file is launched.

To support this new behavior, a new Generate One-Click Install setting is available on the Internet tab in the Releases view
and on the Internet Options panel in the Release Wizard. If you select Yes for this setting, InstallShield includes an .ocx file
for the installation.

To learn more about One-Click Install installations, see the Typical Web Installation vs. One-Click Install section of the
documentation. In addition, see the following:

InstallShield 2020 User Guide ISP-2600-UG00 247

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Internet Tab for a Release

• Internet Options Panel

Enhanced Support for the SecureCustomProperties Property

If you set a public property in the user interface sequence of an installation that requests elevated privileges for the execute
sequence, and you want to pass the property’s value to the execute sequence, the property must be listed as a value for the
SecureCustomProperties property, or it must be a restricted public property.

InstallShield now automatically adds to the SecureCustomProperties property properties that may need to be passed
from the user interface sequence to the execute sequence. To learn more, see Specifying that a Public Property Should Be
a Restricted Public Property.

This support applies to Basic MSI, InstallScript MSI, and Merge Module projects.

Automatic Downgrade Prevention Entries in Basic MSI and InstallScript MSI Projects
To prevent end users from being able to install the current version of your product over a future major version of the same
product, the following conditions should be met: The Upgrades view should contain a major upgrade item, the major
upgrade item should be properly configured to prevent the current version of your product from being installed over a
future version, and your project should include a properly configured and scheduled type 19 custom action.

When you create a new Basic MSI or InstallScript MSI project, InstallShield automatically adds support for preventing the
current installation from overwriting a future major version. To learn more, see the following:

• Preventing the Current Installation from Overwriting a Future Major Version of the Same Product

• ISICE19

Changes for ALLUSERS and for the CustomerInformation Dialog

Beginning with InstallShield 2008, the ALLUSERS property is set to 1 by default in all new Basic MSI projects. This is the
recommended implementation, since most installations must be run in a per-machine context with administrative
privileges.

If you upgrade a project that was created with InstallShield 12 or earlier to InstallShield 2020, InstallShield does not
automatically change the value of the ALLUSERS property or add this property if it was not defined in the earlier project.

Also new with InstallShield 2008, by default, the CustomerInformation dialog in all new Basic MSI projects does not display
the radio button group that enables end users to specify whether they want to install the product for all users or for only
the current user. This is the recommended implementation for this dialog.

If you upgrade a project that was created with InstallShield 12 or earlier to InstallShield 2020, InstallShield does not
automatically change the CustomerInformation dialog.

To learn more, see:

• Per-User vs. Per-Machine Installations

• ALLUSERS

Ability to Change the Product Version from the Command Line or Through an MSBuild Task Parameter
The -y command-line parameter is available for command-line builds with ISCmdBld.exe and IsSaBld.exe. Use this
parameter to specify a product version from the command line.

248 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

In addition, the InstallShield task for MSBuild now includes a ProductVersion parameter, which you can use to specify the
product version through MSBuild. This parameter is exposed as the property InstallShieldProductVersion when the default
targets file is used.

Using the -y command-line parameter or the InstallShield task ProductVersion parameter is especially helpful if you want
to increment the build version (the third field) of the product version.

To learn more, see:

• ISCmdBld.exe

• Standalone Command-Line Build

• Microsoft Build Engine (MSBuild)

Ability to Override Windows Installer Property Values from the Command Line or Through an MSBuild
Task Parameter
The -z command-line parameter is available for command-line builds with ISCmdBld.exe and IsSaBld.exe. Use this
parameter to override the value of a Windows Installer property or create the property if it does not exist.

In addition, the InstallShield task for MSBuild now includes a PropertyOverrides parameter, which you can use to override
the value of a Windows Installer property or create the property if it does not exist. This property is exposed as the
InstallShieldPropertyOverrides ItemGroup passthrough to the PropertyOverrides property on the InstallShield task.

To learn more, see:

• ISCmdBld.exe

• Standalone Command-Line Build

• Microsoft Build Engine (MSBuild)

Windows Installer Properties Used for IIS Data Are Stored in the Registry by Default
Installations that install IIS Web sites and use Windows Installer properties to dynamically set IIS data at run time now write
the property and its value to the following registry key:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\InstallShield Uninstall
Information\{ProductCode}

This change was made to make the value available during uninstallation and repair. Therefore, if your Web site is installed
to an end user–specified site number, the Web site and its virtual directories can be successfully uninstalled from that site
number. If you do not want the IIS data to be stored in the registry, set the IS_IIS_DO_NOT_USE_REG property in your
project.

This change applies to Basic MSI and InstallScript MSI projects.

New Setting for Specifying Whether an IIS Web Server Should Allow the CMD Command to Be Used for SSI
#exec Directives
You can configure an IIS Web server to prevent the CMD command for the #exec directive from being used to execute shell
commands, or you can configure it to allow the CMD command to be used to execute this type of command. The
SSIEnableCmdDirective registry value for the
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters registry key is what determines whether
the CMD command is permitted.

InstallShield 2020 User Guide ISP-2600-UG00 249

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The Internet Information Services view in InstallShield includes a new SSIEnableCmdDirective registry value setting. This
setting lets you specify how your installation should configure the SSIEnableCmdDirective registry value on target systems.
This setting also lets you specify that the SSIEnableCmdDirective registry value should not be changed at installation run
time; this is the default behavior.

For more information, see Specifying Whether a Web Server Should Allow the CMD Command to Be Used for SSI #exec
Directives.

New Host Header Name Setting for IIS Web Sites

You can now use the new Host Header Name setting on the Web Site tab for a Web site in the Internet Information Services
view to specify the host header name that identifies the IIS Web site that is installed during your installation. Previously, it
was necessary to configure the ServerBindings property on the Advanced tab in this view in order to specify the host
header name.

For more information, see Specifying the IIS Host Header Name for a Web Site.

Ability to Install an IIS Web Site and Its Virtual Directories to the Next Available New Site Number
InstallShield provides support for installing an IIS Web site and its virtual directories to the next available new site number.
The implementation is slightly different, depending on which project type you are using. For more information, see
Configuring the TCP Port and Site Numbers.

Ability to Specify Whether New SQL Connections Should Share the Same Windows Installer Properties
A new SQL Scripts tab on the Options dialog box lets you specify how InstallShield should create new database
connections by default—either by using the same Windows Installer properties that were used by default for the first
connection in your project, or by using a unique set of new Windows Installer properties.

This applies to the following project types: Basic MSI and InstallScript MSI.

For more information, see the following:

• Specifying Whether New SQL Connections Should Share the Same Windows Installer Properties

• SQL Scripts Tab

SQLLogin Dialog Enhancements

The SQLLogin dialog now includes a new control that enables end users to specify the name of the target database catalog.
This dialog also has a Browse button next to the new control; the Browse button lets end users select from the list of
database catalogs that are available on the target database server.

If you upgrade a Basic MSI project that includes SQL support from InstallShield 12 or earlier to InstallShield 2020, you need
to manually import the SQLLogin.isd and SQLBrowse.isd dialogs into your project to use the new version of the SQLLogin
dialog. The .isd files are installed in the following location: InstallShield Program Files Folder\Support. To use this
updated SQLLogin dialog in InstallScript and InstallScript MSI projects, replace the SQLServerSelectLogin function call in
your InstallScript code with a call to the new SQLServerSelectLogin2 function.

Database Import Wizard Enhancements

The Database Import Wizard has a new Advanced Scripting Options panel that lets you specify security script options such
as script database, script database users and database roles, script SQL Server logins, and script object-level permissions.

For more information, see Advanced Scripting Options Panel.

250 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New Windows Installer Property for Specifying SQL Connections That Should Not Be Installed or
Uninstalled
InstallShield includes support for a new Windows Installer property called IS_SQLSERVER_CXNS_ABSENT_FROM_INSTALL. Use
this property to specify one or more SQL connections that should be skipped during installation or uninstallation. To
specify more than one SQL connection, separate each with a semicolon (;). To skip all of the SQL connections, set the value
of this property to ALL. Using this property is helpful if you cannot uninstall a product because of a SQL scripting error.

For details about SQL-related properties, see Overriding the Default SQL Run-Time Behavior.

Ability to Remove Unreferenced Directories from the .msi File

The Build tab in the Releases view includes a new Keep Unused Directories setting. Use this setting to specify whether you
want InstallShield to remove unused directories from the Directory table of the .msi file when you build the selected
release. The default value is No.

This setting is available for Basic MSI, InstallScript MSI, and Merge Module projects.

For more information, see Build Tab for a Release.

Ability to Specify COM+ Component File Destinations from Within the Component Services View
The Component Services view has two new Destination fields on the Installation tab: one for a server type of installation,
and one for a proxy type of installation. Use these fields to specify the target destination of the selected COM+ component
files. Previously, the only way to specify the destination of the components associated with a COM+ application was in the
Components view or the Setup Design view.

New Windows Installer Property for Specifying COM+ Applications to Be Installed After the
InstallFinalize Action
InstallShield includes support for a new Windows Installer property called IS_COMPLUS_INSTALL_AT_FINALIZE. Use this
property to specify one or more COM+ applications that should be installed by the ISComponentServiceFinalize action,
which is called after the InstallFinalize action. To specify more than one COM+ application, separate each with a semicolon
(;). To specify that all COM+ applications should be installed by the ISComponentServiceFinalize action, set the value of this
property to ALL.

Using this property is helpful if you want to install a COM+ application that contains .NET assemblies to be installed to the
GAC because Windows Installer does not commit the changes made in the in-script session to the GAC until the
InstallFinalize action.

Additional Predefined System Searches for Basic MSI and InstallScript MSI Projects
InstallShield has several new predefined system searches:

• Adobe Reader 7

• Adobe Reader 6

• Internet Explorer 7.0

If your installation requires any of these products, you can use the System Search view or the Installation Requirements
page in the Project Assistant to add these system searches to your project. When end users launch your installation,
Windows Installer checks the target system to see if the requirements are met; if they are not met, the installation displays
the error message that is defined for the system search.

InstallShield 2020 User Guide ISP-2600-UG00 251

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

New and Enhanced Setup.exe and Update.exe Command-Line Parameters (InstallScript Projects)
Two new command-line parameters are available for Setup.exe and Update.exe:

• /installfromweb

• /media_path

In addition, the /L parameter now supports both hex and decimal language values.

To learn more, see Setup.exe and Update.exe Command-Line Parameters.

Downloader Web Release Type Supports More Location Options for .cab Files
The Downloader type of Web release now lets you specify whether InstallShield should create external .cab files that are
downloaded at installation time as needed. Previously, .cab files were always streamed into the .msi package for the
Downloader Web release type.

The new external .cab file options are available on the Downloader Options panel of the Release Wizard. This panel is
displayed in the Release Wizard if the media type is Web and the Web type is Downloader. The Downloader Options panel
has a new Create external .cab files check box. If you clear this check box, the behavior is the same as it was previously: the
.cab files are streamed into the .msi package. If you select this check box, you can specify how .cab files should be created:
one .cab file per feature, one .cab file per component, or multiple .cab files based on a particular size that you specify.

Downloader and Install from the Web Types of Web Releases Embed All Transforms
The Downloader type of Web release and the Install from the Web type of Web release now always embed all .mst and .ini
files in the Setup.exe file.

Enhancements for Patch Display Information

The Identification tab, which was previously called the Uninstall tab, is where you specify information that should be
displayed for a patch in Add or Remove Programs on systems running Windows Installer 3.0 or later. This tab in the Patch
Design view of Basic MSI and InstallScript MSI projects and in the General Information view in QuickPatch projects has
settings for items such as the display name, the manufacturer name, and the support URL. Now every time that you change
the latest setup for a patch configuration in the Patch Design view or in a QuickPatch project, InstallShield uses the Add or
Remove Programs information from the latest setup as the values for the Identification tab settings. You can override the
values on the Identification tab as needed.

In addition, the Allow Patch to Be Uninstalled (Requires Windows Installer 3.0) check box is now available on the
Common tab. This setting was previously available on the Uninstall tab.

For more information, see:

• Common Tab (in the Patch Design view)

• Identification Tab (in the Patch Design view)

• Common Tab (in a QuickPatch project)

• Identification Tab (in a QuickPatch project)

Ability to Specify the Minimum Initialization Time

InstallShield includes a new Minimum Initialization Time setting on the Setup.exe tab for a release in the Releases view.
Use this setting to specify the minimum number of seconds that the installation should display the initialization dialog—as
well as the splash screen, if one is included—when end users run this release.

252 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

InstallScript Language Enhancements and New Functionality

Several enhancements have been made to the InstallScript language.

New LaunchApplication and WaitForApplication Functions to Supersede LaunchAppAndWait for Launching Applications
with Elevated Privileges

The LaunchApplication function uses either the Windows API function CreateProcess or the Windows API function
ShellExecuteEx to launch the specified application. After the application is launched, the installation can optionally call
the new WaitForApplication function to wait for the application to terminate.

The WaitForApplication function waits for a running application, and optionally all child applications that are launched by
the running application, to terminate before returning.

Note that calling LaunchAppAndWait now calls the following:

LaunchApplication( szProgram, szCmdLine, "", LAAW_STARTUPINFO.wShowWindow, LAAW_PARAMETERS.nTimeOut,

nOptions | LAAW_OPTION_CHANGEDIRECTORY | LAAW_OPTION_FIXUP_PROGRAM );

The new LaunchApplicationInit function is available. This function, which was added to match the naming convention of
the LaunchApplication function, has the same behavior as the LaunchAppAndWaitInitStartupInfo function.

For more information, see:

• LaunchApplication

• WaitForApplication

• LaunchAppAndWait

• LaunchApplicationInit

Several new predefined constants are available:

• LAAW_OPTION_CHANGEDIRECTORY

• LAAW_OPTION_FIXUP_PROGRAM

• LAAW_OPTION_USE_SHELLEXECUTE

• LAAW_OPTION_WAIT_INCL_CHILD

In addition, the LAAW_OPTION_NO_CHANGEDIRECTORY is now obsolete. Passing this parameter has no effect.

The following script variables are also now available:

• LAAW_SHELLEXECUTEINFO

• LAAW_SHELLEXECUTEVERB

New SdRMFilesInUse Dialog and OnRMFilesInUse Event Handler for Minimizing Reboots Through the Restart Manager
Infrastructure in InstallScript MSI Projects

A new SdRMFilesInUse function is available. This function displays a dialog that includes a list box containing a list of the
applications that are open and are locking files. The dialog also includes two radio buttons that allow end users to specify
whether the installation should attempt to use the Restart Manager to shut down the applications that are locking files or
overwrite the locked files (which most likely results in the need for a reboot to complete the installation).

For InstallScript MSI projects, the new OnRMFilesInUse event handler displays the new SdRMFilesInUse dialog. This event
handler is called when the Restart Manager is enabled and Windows Installer 4.0 sends an
INSTALLMESSAGE_RMFILESINUSE message to the installation.

InstallShield 2020 User Guide ISP-2600-UG00 253

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

For more details, see:

• SdRMFilesInUse

• OnRMFilesInUse

Ability to Specify Additional Compiler Include Paths on a Per-Project Basis

The Compile/Link tab on the Settings dialog box, which is available from the Build menu in InstallShield, now has an
Include Paths box. Use this Include Paths box to specify which directories InstallShield should search for source files that
have been included in the main installation’s InstallScript code through #include statements. It corresponds with the -i
option for Compile.exe, the command-line compiler.

To learn more, see Compile/Link Tab.

Enhancements for .NET Framework 3.0 Support

A new FOLDER_DOTNET_30 InstallScript variable is available. This variable stores the path of the .NET Framework 3.0. The
corresponding text substitution for this variable is <FOLDER_DOTNET_30>.

The .NET Framework 3.0 writes the value InstallSuccess with value data of 1 to the registry to indicate that it is installed. To
check for this InstallSuccess value, you can now use the Is function and pass the DOTNETFRAMEWORKINSTALLED
constant. You can still pass this constant through the Is function to check for the value of Install, which is used by earlier
versions of the .NET Framework. For more information, see Is.

Two new constants are available for use with the Is function:

• REGDB_KEYPATH_DOTNET_30

• REGDB_VALUENAME_INSTALLSUCCESS

New Is Constant for Checking for the Presence of a Minimum Service Pack Number of the .NET Framework

Use the new DOTNETSERVICEPACKINSTALLED constant with the Is function to determine whether a particular service
pack—or a later version of the service pack—of the .NET Framework is installed. For more information, see Is.

New and Updated Functions for SQL Support

Several InstallScript functions for SQL support have been added or updated.

The following InstallScript functions are now available for InstallScript and InstallScript MSI projects:

• SQLRTInitialize2—Loads the SQLRT.dll file for InstallScript projects and the ISSQLSRV.dll file for InstallScript MSI
projects, and it uses the settings file to initialize the .dll file. This function supersedes the SQLRTInitialize function.

• SQLServerSelectLogin2—Creates a login dialog that lets the targeted end user specify which SQL Server should be
used for the current connection, as well as which login credential should be used. This dialog also optionally shows
the connection name that is associated with the connection information. In addition, it optionally allows the end user
to specify which database catalog should be used for the current connection. This function supersedes the
SQLServerSelectLogin function.

• SQLDatabaseBrowse—Creates a dialog that lets the end user display a list of all database catalogs available on the
specified database server.

• SQLBrowse2—Creates a dialog that lets an end user display a list of all database servers that are available on the
network for the database technologies specified for a connection. This function supersedes the SQLBrowse function.

254 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• SQLRTPutConnectionInfo2—Sets the connection information (the default server, default database catalog, default
user name, and default password). This function supersedes the SQLRTPutConnectionInfo function.

The following InstallScript functions are now available for InstallScript projects:

• SQLRTGetLastError2—Returns detailed information about the last error encountered by the SQL run time and loads
the proper SQL error message.This function supersedes the SQLRTGetLastError function.

• SQLRTGetErrorMessage—Returns the descriptive message of the last error encountered by the SQL run time when a
connection is being opened.

• SQLRTGetScriptErrorMessage—Returns the descriptive message of the last error encountered by the SQL run time
when a SQL script is executing.

The following InstallScript function is now available for InstallScript MSI projects:

• SQLRTTestConnection2—Establishes a connection.This function supersedes the SQLRTTestConnection function.

The following InstallScript functions, which were previously available only for InstallScript projects, are now also available
for InstallScript MSI projects:

• SQLRTGetConnections

• SQLRTGetConnectionInfo

• SQLRTPutConnectionInfo

• SQLRTGetConnectionAuthentication

• SQLRTPutConnectionAuthentication

InstallShield still supports the functions that are superseded by new versions of the functions. However, if you upgrade a
project that was created in InstallShield 12 or earlier to InstallShield 2020, InstallShield does not automatically update the
existing InstallScript code to use the new functions.

For more information, see:

• Using the SQL Run-Time Functions in InstallScript and InstallScript MSI Projects

• SQL Functions

New Is Constant for Checking If a User Is in the Administrators Group

Use the new USER_INADMINGROUP constant with the Is function to determine whether a user is in the Administrators
group, regardless of whether that user is running the installation with a standard access token. For more information, see
Is.

Note that passing the USER_ADMINISTRATOR constant through the Is function now returns FALSE if the user is in the
Administrators group but the group has the SE_GROUP_USE_FOR_DENY_ONLY security identifier (SID) attribute set (that
is, the user is running with a standard access token).

New Functions that Enable a .NET Library Loaded Through InstallScript to Be Unloaded Before the Installation
Completes

Two new InstallScript functions are available: DotNetCoCreateObject and DotNetUnloadAppDomain.

• The DotNetCoCreateObject function calls functions in .NET assemblies without the assembly being registered for
COM interoperability. This function lets you specify the .NET application domain in which the .NET assemblies should
be loaded and run.

InstallShield 2020 User Guide ISP-2600-UG00 255

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

The DotNetCoCreateObject function is similar to the CoCreateObjectDotNet function. The only difference is that with
DotNetCoCreateObject, you can specify the .NET application domain that should be loaded; the assembly is then run
in this domain.

For CoCreateObjectDotNet, the .NET assembly is loaded into the default application domain after the installation
completes; thus, the .NET assembly file is locked until the installation has finished.

• The DotNetUnloadAppDomain function unloads the specified .NET application domain and releases any assemblies
that are currently loaded into the specified application domain.

New RegDBDeleteItem Function

A new InstallScript function called RegDBDeleteItem is now available. The RegDBDeleteItem function deletes values
under the per application paths key or the application uninstallation key, depending on the value of nItem. For more
information, see RegDBDeleteItem.

New GetStatus Function for Objects

A new InstallScript function called GetStatus is now available for InstallScript Object projects. The GetStatus function
retrieves the current status of the object; that is, the current value of Status.Number. For more information, see GetStatus.

Changes to the ListWriteToFileEx Function and Related Constants

The LWTF_OPTION_APPEND_TO_FILE constant has been added to the InstallScript language. You can pass this constant as
the nOptions parameter for the ListWriteToFileEx function to append a list to an existing file.

In addition, two existing nOptions constants have been renamed:

• LWFT_OPTION_WRITE_AS_ANSI is now LWTF_OPTION_WRITE_AS_ANSI.

• LWFT_OPTION_WRITE_AS_UNICODE is now LWTF_OPTION_WRITE_AS_UNICODE.

To maintain backwards compatibility, the aforementioned two LWFT_* constants are still available, and they are defined
the same way as the corresponding new LWTF_* constants.

For more information, see the following:

• ListWriteToFileEx

• LWTF_OPTION_APPEND_TO_FILE

• LWTF_OPTION_WRITE_AS_ANSI

• LWTF_OPTION_WRITE_AS_UNICODE

Expanded InstallScript Text Substitution Functionality

An InstallScript text-substitution association can now be embedded in another text-substitution association; for example,
"<MYTEXTSUB1>" can be associated with "My Text Sub 1 Value" and "<MYTEXTSUB2>" with "Text Sub <MYTEXTSUB1>
Embedded". Previously, if a local text-substitution association was embedded in a global text-substitution association, the
local text substitution was not performed.

See Also
Upgrading Projects from InstallShield 12 or Earlier
Upgrading Projects from InstallShield 11.5 or Earlier

256 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

What’s New in InstallShield 12 SP1

InstallShield 2020

InstallShield 12 supports a beta version of Microsoft Windows Vista. InstallShield 12 SP1 includes changes that offer
support for the RTM version of Microsoft Windows Vista.

New Microsoft .NET 3.0 Prerequisite Available

InstallShield now includes a .NET Framework 3.0 setup prerequisite that you can add to Basic MSI and InstallScript MSI
projects.

To learn more about setup prerequisites, see Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI
and InstallScript MSI Projects.

Ability to Minimize the Number of UAC Prompts by Advertising as Part of Prerequisite

Installation
Use the new Advertise If Prerequisites Are Elevated setting in the Releases view to specify whether your .msi file should be
advertised and run after the setup prerequisites in the installation have been successfully installed with elevated privileges
on Windows Vista machines. The advertisement may allow end users to avoid the User Account Control (UAC) prompt that
would otherwise be displayed for an .msi package that requires elevated privileges. For more information, see Specifying
Whether a Product Should Be Advertised If Its InstallShield Prerequisites Are Run with Elevated Privileges.

The Advertise If Prerequisites Are Elevated setting is one of several settings in InstallShield that affect whether an
installation triggers UAC consent or credential prompts for elevated privileges. Understanding these different settings will
help you create the appropriate UAC experience for your installation when end users run it on Windows Vista systems. It
will also enable you to try to minimize the number of UAC prompts that are displayed during your installation. To learn
about all of these settings, see Minimizing the Number of User Account Control Prompts During Installation.

Enhanced Validation for the Certified for Windows Vista Program

InstallShield includes several new InstallShield internal consistency evaluators (ISICEs) that help you ensure that your
installation follows the best practices outlined in the Certified for Windows Vista program. The new evaluators—ISICE11
through ISICE20—check that all .exe files have embedded manifests, that none of the protected registry keys have been
modified, that the .dll and .exe files do not use any obsolete API calls, and more. In addition, ISICE02 now verifies that .ocx,
.sys, .cpl, .drv, and .scr files are signed. Previously, ISICE02 verified only that .exe files are signed. ISICE06 now checks the
destination path of files that are in your installation and that have the same name as a Windows Protected File. If the
destination path for the file in your installation does not match the location of the Windows Protected File, ISICE06 now
displays a validation warning instead of a validation error.

When you validate your package, InstallShield lists any validation messages on the Tasks tab of the Output window. Now
you can double-click a validation message on the Tasks tab to jump to the area of the Direct Editor that corresponds to the
validation message. This functionality is available for ISICEs, as well as for standard ICEs. Previously, it was available only
for standard ICEs.

For more information, see:

• ISICEs

• Viewing Validation Results

InstallShield 2020 User Guide ISP-2600-UG00 257

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Additional Changes
For a list of issues that are resolved in InstallShield 12 SP1, see the release notes. The release notes are available from the
Help menu in InstallShield.

What’s New in InstallShield 12

InstallShield 2020

New Features
InstallShield includes the following new features.

Ability to Target Windows Vista Systems

InstallShield enables you to specify that your installation requires Windows Vista. It also lets you build Windows Vista–
related conditions for features and components.

Validation for the Certified for Windows Vista Program

To provide the best possible installation experience for end users, ensure that your installation follows the best practices
outlined in the Certified for Windows Vista program. InstallShield now includes a validation suite that helps you verify that
your installation meets the installation requirements of the Certified for Windows Vista program for Basic MSI and
InstallScript MSI projects. If you want to be able to use the Windows Vista Logo artwork, your application’s installation
must meet the program’s requirements.

In addition, InstallShield now lets you customize the list of internal consistency evaluators (ICEs) that should be used for
installation package validation and merge module validation. This is helpful if you do not want to pursue logo certification
but you still want to ensure that your installation or merge module meets specific best practices that are verified during
validation. To configure validation settings: on the Tools menu, click Options and select the Validation tab.

To learn more, see the following:

• Specifying Whether Validation Should Be Performed at Build Time

• Specifying Which ICEs, ISICEs, ISVICEs and ISBPs Should Be Run During Validation

• ISICEs

User Account Control Support

InstallShield includes support for the User Account Control functionality that Microsoft added for Windows Vista. Use the
new Require Administrative Privileges setting in the General Information view to specify at a project-wide basis whether
administrative privileges are required for an installation. Also, use the Required Execution Level setting in the Releases
view to specify the minimum level required by your installation’s Setup.exe file for running the installation (the setup
launcher, any setup prerequisites, and the .msi file) on Windows Vista platforms.

For details, see:

• Entering Summary Information Stream Data

• Specifying the Required Execution Level for Your Setup Launcher on Windows Vista and Later Platforms

258 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Support for Minimizing Reboots Through the Restart Manager Infrastructure

Restarting the system after an installation is inconvenient for end users. One of the Certified for Windows Vista program
requirements is that all installations must contain an option that enables end users to automatically close applications and
attempt to restart them after the installation is complete.

To support this quality guideline, an MsiRMFilesInUse dialog is available in all Basic MSI projects. The installation displays
this dialog if one or more files that needs to be updated are currently in use during the installation. To learn more, see
Minimizing Reboots on Windows Vista and Later Systems.

Digital Signature Enhancements

If you specify digital signature information for your installation, InstallShield automatically adds the necessary information
to the MsiDigitalCertificate and MsiPatchCertificate tables. The MsiPatchCertificate table contains the
information that is needed to enable User Account Control (UAC) patching. This enables you to create patches that can be
installed by non-administrators.

In addition, the Build Installation page in the Project Assistant now offers the ability to specify digital signature information
for your installation.

For more information, see:

• Preparing Installations for Non-Administrator Patches

• Digital Signing and Security

Support for Documentation about Custom Action Behavior

The intended behavior of each custom action must be documented for the Certified for Windows Vista program. This is
especially helpful if system administrators deploy your product to enterprise environments; they sometimes need to know
what the custom actions do. InstallShield now has a new Help File Path setting in the Custom Actions view to help you
meet this requirement. Use this setting to specify the path of a document that describes the behavior of a custom action
that you create for your project. For details, see:

• Documenting the Behavior of Custom Actions

• Guidelines for Creating Custom Actions that Meet Requirements of the Windows Logo Program

This documentation now describes each of the built-in InstallShield custom actions that are added automatically to
InstallShield projects to support different functionality. See InstallShield Custom Action Reference.

Setup Prerequisite Enhancements

Many enhancements have been made to the Setup Prerequisite Editor:

• The user interface has been improved; it now has menus that list easy-to-access commands.

• The new Behavior tab lets you specify whether end users may skip the prerequisite installation. You can also specify
how the prerequisite installation should proceed if it appears that the target machine does or does not need to be
restarted.

• Now you can create prerequisite installation conditions for DWORD registry comparisons. You can also create
conditions for 64-bit machines.

For more details, see:

• Behavior Tab

InstallShield 2020 User Guide ISP-2600-UG00 259

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

• Allowing End Users to Choose Whether to Install an InstallShield Prerequisite

• Planning for Issues that Could Occur with an InstallShield Prerequisite Installation

• Specifying the Behavior for an InstallShield Prerequisite that Requires a Restart

Redistributing setup prerequisites is now more flexible than ever. You can specify different methods for supplying each
individual setup prerequisite in your installation. This enables you to store some of the setup prerequisite files on the
source media; compress some of the setup prerequisite files into Setup.exe, to be extracted at run time; and download
some of the setup prerequisite files. In addition, you can now assign release flags to setup prerequisites. Then you can
include and exclude any combinations of setup prerequisites when you build different releases.

To learn more, see:

• Specifying a Run-Time Location for a Specific InstallShield Prerequisite

• Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level

• Assigning Release Flags to InstallShield Prerequisites

Windows Installer 4.0 Log File Support on a Project-Wide Basis

InstallShield provides support for the option to easily log installations run with Windows Installer 4.0 on a project-wide
basis without having to use the command line or configure log parameters through the registry. To enable logging, specify
Yes in the new Create MSI Logs setting in the General Information view. To override the default logging parameters, edit the
MsiLogging property in the Property Manager view. If the installation is run on a target system that has Windows Installer
4.0, the installer creates a log file and populates the MsiLogFileLocation property with its path. In addition, a Show the
Windows Installer log check box is added to the SetupCompleteSuccess, SetupCompleteError, and SetupInterrupted
dialogs.

For more information, see Specifying Whether Windows Installer Installations Should Be Logged.

Registry Reflection Support for 64-Bit Systems

InstallShield includes support for the new Windows Installer 4.0 attribute called
msidbComponentAttributesDisableRegistryReflection in the Component table. To easily configure this attribute, set the
Disable Registry Reflection setting for a selected component in the Components view. Registry reflection keeps the 32-bit
registry view and the 64-bit registry view in sync on a target machine. Only 64-bit systems with Windows Installer 4.0
support this setting. Other systems ignore it. For more specific information, see Enabling and Disabling Registry Reflection.

Multilingual User Interface (MUI) Support

If you are preparing an installation for a multilingual application and Windows Installer 4.0 will be running the installation,
you can now use InstallShield to create shortcuts that include support for the Windows multilingual user interface (MUI).
Four new settings are available in the Shortcuts view for a selected shortcut:

• Display Resource DLL

• Display Resource ID

• Description Resource DLL

• Description Resource ID

These new settings correspond with the four new columns in the Shortcut table for Windows Installer 4.0. To learn more,
see Shortcuts View.

260 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Additional InstallShield Collaboration Licenses for Premier Edition

InstallShield Premier Edition now includes a five-pack of licenses for InstallShield Collaboration for Visual Studio. You can
use these licenses to install InstallShield Collaboration on development systems that do not have InstallShield but do have
Visual Studio .NET 2002, Visual Studio .NET 2003, or Visual Studio 2005.

InstallScript Rearchitecture Enhancements for InstallScript MSI Projects and Basic MSI Projects with
InstallScript Custom Actions
The InstallScript MSI architecture has had a number of issues with security (COM/DCOM) and other areas that can cause
some installations to fail for various reasons. The architecture has been improved dramatically for InstallShield 12 to
resolve these issues and to make InstallScript MSI a more reliable project type. The improvements also help increase the
reliability of Basic MSI projects that include InstallScript custom actions.

To learn more, see the following:

• Run-Time Behavior for Basic MSI Installations with InstallScript Custom Actions

• Run-Time Behavior for InstallScript MSI Installations

• Upgrading Projects from InstallShield 11.5 or Earlier

DIFx 2.01 Support

InstallShield includes support for the latest version of Driver Install Frameworks for Applications (DIFx). This new version,
which includes the latest binary files from Microsoft, is available for any Basic MSI, InstallScript, or InstallScript MSI projects
that you create in InstallShield.

Enhancements for Setup.exe and Update.exe Command-Line Parameters

Some of the command-line parameters for Setup.exe and Update.exe were added or modified:

• /Clone_wait (InstallScript only)

• /runfromtemp (Basic MSI, InstallScript, and InstallScript MSI)

• /v"ISSCRIPTCMDLINE=\"<Option1> <Option2>\"" (Basic MSI only)

• /hide_progress (Basic MSI, InstallScript, and InstallScript MSI projects)

• /hide_splash (InstallScript and InstallScript MSI projects)

For more information, see Setup.exe and Update.exe Command-Line Parameters.

Registry and File Filtering Enhancements for COM Extraction and Dependency Scanners
To prevent InstallShield from extracting undesired COM data from a COM server, you can edit a new Filters.xml file that is
installed with InstallShield. Editing this Filters.xml file enables you to customize the list of registry keys that will be
excluded from COM extraction.

The Filters.xml file also now lists files that the Static, Dynamic, and Visual Basic dependency scanners will exclude or
include. Previously, two different files—Userscan.ini and Iswiscan.ini—were used to list excluded and included files.

For more information, see:

• Filtering Registry Changes for COM Extraction

• Filtering Files in Dependency Scanners

InstallShield 2020 User Guide ISP-2600-UG00 261

Chapter 1 InstallShield 2020 Help Library
What Was New in Earlier Versions of InstallShield

Internet Explorer 7.0 Compatibility

Several areas of InstallShield have been revised so that it is now compatible with Internet Explorer 7.0. The Transform
Wizard, Custom Action Wizard, the String Table Editor, the Distribute view, and the General Information view are all
examples of areas that have been updated.

Enhanced Start Page

The list of recently opened projects that are displayed on the Start Page now includes a column that shows the project
type. In addition, the maximum number of projects that are listed has been increased from four to eight.

InstallScript Enhancements and New Functionality

Several enhancements have been made to the InstallScript language. New and revised variables, functions, and constants
are now available.

System Variable Changes and Text Substitution Additions

A system variable called DISK1SETUPEXENAME has been added.

Two system variables have new default values:

• UNINST

• UNINSTALL_STRING

Two new InstallScript text substitutions are available:

• DISK1SETUPEXENAME

• SELECTED_LANGUAGE

For more information, see System Variables.

Script Variable Additions

Two new script variables are available:

• INSTALLSCRIPTMSI

• BASICMSI

Function and Predefined Constant Changes

A new LANGUAGE_SUPPORTED predefined constant is available for use with the Is function. To learn more, see Is.

A new ISOSL_WINVISTA predefined constant is available for use with the FeatureFilterOS function and the SYSINFO
structure variable. For more information, see FeatureFilterOS function and the SYSINFO.

The DoInstall function is now similar to the LaunchAppAndWait function. For more details, see DoInstall.

Upgrade Details
For InstallShield 12, a number of improvements were made to the InstallScript MSI architecture to resolve issues with
security (COM/DCOM) and other areas that can cause some installations to fail for various reasons. The architecture was
improved for InstallShield 12 to resolve these issues and to make InstallScript MSI a more reliable project type. The
improvements also help increase the reliability of InstallScript projects, as well as Basic MSI projects that include
InstallScript custom actions.

262 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
Target System Requirements

In addition, the merge module project type has been enhanced: it now has the same InstallScript view that is available in
Basic MSI projects. This enhanced version of the merge module project type replaces the InstallScript MSI object project
type, which is no longer available in InstallShield.

To learn more, see Upgrading Projects from InstallShield 11.5 or Earlier.

Target System Requirements

InstallShield 2020

You can use InstallShield to rapidly build, test, and deploy installations that target Windows-based systems.

Requirements For Desktop Computers

Operating System

Project • For all project types except for Suites (Advanced UI, and Suite/Advanced UI project types), Windows XP SP3 and
Windows Server 2003 SP2 are the minimum versions of Windows that are required for target systems that run the installations
that are created in InstallShield. For Suites, Windows Vista and Windows Server 2008 are the minimum versions of Windows
that are required for target systems.

Target systems must meet the following minimum operating system requirement:

• Windows XP SP3

• Windows Server 2003 SP2

• Windows Vista

• Windows Server 2008

• Windows 7

• Windows Server 2008 R2

• Windows 8

• Windows Server 2012

• Windows 8.1

• Windows Server 2012 R2

• Windows 10

• Windows Server 2016

• Windows Server 2019

Target systems must also support the SSE2 instruction set.

InstallShield 2020 User Guide ISP-2600-UG00 263

Chapter 1 InstallShield 2020 Help Library
Target System Requirements

Installer Engine Requirements

The minimum target system requirements for the various installer engines are as follows.

Table 1-3 • Target System Requirements for Desktop Computers

Installer Engine Operating System and Other Requirements

Windows Installer 5.0 Windows 7 or later, Windows Server 2008 R2 or later

(This is not available as a

redistributable.)

Windows Installer 4.5 Windows XP SP2 or later, Windows Server 2003 SP1 or later

Windows Installer 4.0 Windows Vista, Windows Server 2008

(This is not available as a

redistributable.)

Windows Installer 3.1 Windows 2000 SP3 or later, Windows Server 2003 or later

Windows Installer 3.0 Windows 2000 SP3 or later, Windows Server 2003 or later

Windows Installer 2.0 Windows 95 or later

(Note that InstallShield does not include support for Windows 95, Windows 98,
Windows NT 4, or Windows Me.)

Suite/Advanced UI Windows Vista or later, and Windows Server 2008 or later

Advanced UI Windows Vista or later, and Windows Server 2008 or later

InstallScript Windows XP SP3 or later, Windows Server 2003 SP2 or later

For more information about Windows Installer redistributables, see Adding Windows Installer Redistributables to Projects.

See Also
Settings for Platforms and Platform Suites

Targeting 64-Bit Operating Systems

InstallShield 2020

Microsoft designed 64-bit versions of Windows to allow existing 32-bit applications to continue to work seamlessly. They
also designed 64-bit versions of Windows in such a way to allow a recompiled version of the same code to work seamlessly
as a 64-bit application. To provide this support, 64-bit versions of Windows isolate the 32-bit and 64-bit from each other in
two main ways: their files are stored in separate locations (Program Files vs. Program Files (x86); System32 vs. SysWow64),
and their registry keys are separated (HKLM\Software vs. HKLM\Software\Wow6432Node).

264 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
Target System Requirements

In some cases, such as installation, what is normally a beneficial separation becomes a challenge. Typically installations
are 32-bit applications themselves (in order to run on 32-bit machines), and accessing 64-bit locations to install a 64-bit
application is more complex than a standard file copy or registry write. Each project type that is available in InstallShield
handles this complexity in different ways.

Windows Installer–based installations disallow access to 64-bit locations except when the installation targets only 64-bit
systems; however, they support running 64-bit DLL code whenever running on a 64-bit system. Note that some target
systems—such as Windows Server Core systems—may not have 32-bit Windows-on-Windows (WOW64) support.
InstallShield lets you create pure 64-bit installations that work on those systems. For more information, see Targeting 64-
Bit Operating Systems with Basic MSI and InstallScript MSI Installations.

InstallScript installations are always 32 bit so they can run only 32-bit DLL code (or launch 32-bit or 64-bit .exe files).
However, all InstallScript installations support accessing 64-bit locations through the 64-bit component setting, as well as
through other methods. For additional details, see Targeting 64-Bit Operating Systems with InstallScript Installations.

Suite/Advanced UI and Advanced UI installations enable you to reference either 32-bit or 64-bit locations, and they can
launch 32-bit or 64-bit installations, depending on the target system. However, all extension DLL code in a Suite/Advanced
UI or Advanced UI project must be 32 bit. To learn more, see Targeting 64-Bit Operating Systems with Suite/Advanced UI
and Advanced UI Installations.

Targeting 64-Bit Operating Systems with Basic MSI and InstallScript MSI
Installations
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

Note that if you create an InstallScript MSI project and change the Template Summary property from Intel to x64, InstallShield
creates a 64-bit MSI installation combined with a 32-bit InstallScript MSI installation at build time.

Also note that InstallScript MSI projects do not have support for architecture validation.

If you are writing applications for 64-bit Windows-based systems, you will need a way to install your 64-bit files and other
data. Although 32-bit Windows Installer–based installations can run on most 64-bit machines, they cannot install to 64-bit
locations. The Windows Installer service provides support for 64-bit installations. These installations can be designed and
built on 32-bit machines, but they can run only on 64-bit machines. Through the use of release flags, you can build two
installations (one 32 bit and one 64 bit) from a single project.

Configuring the Template Summary Property

The Template Summary property determines whether an .msi package is a 32-bit package or a 64-bit package.

If your installation targets 64-bit systems, configure the Template Summary property with the appropriate 64-bit value (x64
or Intel64). This allows end users to install your product in 64-bit locations on 64-bit systems; it also prevents end users
from installing your product on 32-bit systems.

You can use the Template Summary setting in the General Information view to configure the Template Summary property.
You can also set the Template Summary setting for a product configuration in the Releases view. Any value entered in the
Releases view overrides the value set in the General Information view.

InstallShield 2020 User Guide ISP-2600-UG00 265

Chapter 1 InstallShield 2020 Help Library
Target System Requirements

To learn more, see Using the Template Summary Property.

Creating 64-Bit Components

To specify that a component is 64 bit, select Yes for the component’s 64-Bit Component setting. If you build a release that
has at least one 64-bit component and the Template Summary property is set to a 64-bit value, the result is a 64-bit
package.

For more information about the 64-Bit Component setting, as well as additional component settings, see Component
Settings.

Extracting COM Data from 64-Bit COM Servers

If you are using InstallShield on a 64-bit operating system, InstallShield can extract COM data from a 64-bit COM server. In
order to install the data to the correct locations, the component must be marked as 64 bit.

Note that if you use InstallShield on a 32-bit system, 64-bit COM extraction is not available.

To learn about extracting COM data, see Extracting COM Information from a COM Server.

Self-Registering 64-Bit COM Servers

InstallShield supports 64-bit self-registration of COM servers. If you mark a component as 64 bit and then add a file to that
component, you can select the file’s Self Register check box to enable 64-bit self-registration of that file during installation.
The Self Register check box is on the file’s Properties dialog box.

InstallShield also supports 64-bit self-registration of dynamically linked COM servers. To enable this, select the Self-
Register all files check box on the Dynamic File Link Settings dialog box when you add the files dynamically to a 64-bit
component. For more information, see Adding Dynamic File Links to Components.

Enabling or Disabling Registry Reflection

InstallShield includes support for the Windows Installer 4.0 and later attribute
msidbComponentAttributesDisableRegistryReflection in the Component table. To use this attribute, set the Disable
Registry Reflection setting for a selected component in the Components view to Yes. Registry reflection keeps the 32-bit
registry view and the 64-bit registry view in sync on a target machine. Only 64-bit systems with Windows Installer 4.0 and
later support this setting. Other systems ignore it. For more specific information, see Enabling and Disabling Registry
Reflection.

Adding Other 64-Bit Elements

InstallShield includes support for additional 64-bit elements. For example, InstallShield includes 64-bit .NET Framework
redistributables that you can add to your project. Custom actions can include 64-bit JScript or VBScript code, and 64-bit
folder properties give you access to essential operating system folders such as the 64-bit Program Files folder. In addition,
you can use the Setup Prerequisite Editor to configure setup prerequisites that have conditions that check for 64-bit
requirements on the target system.

Note • 64-bit support requires Windows Installer version 2.0 or later.

266 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
Target System Requirements

Specifying the Appropriate Architecture Validation

Basic MSI projects include a product configuration setting that lets you specify whether you want to use architecture
validation at build time. Architecture validation enables you to detect potentially problematic cases in which your
installation may try to install product files or use run-time binaries that may not match the architecture of a target system.

For example, if end users may run your installation on 64-bit Windows Server Core systems that do not have 32-bit
Windows-on-Windows (WOW64) support, architecture validation can help you identify any 32-bit product files or 32-bit
custom action files in your installation; 32-bit binaries cannot be loaded on 64-bit target systems without WOW64 support.

Architecture validation also enables you to generate pure 32-bit .msi packages that contain only 32-bit versions of the
built-in InstallShield custom action DLLs, or pure 64-bit .msi packages that contain only 64-bit versions of the built-in
InstallShield custom action DLLs.

To specify what type of architecture validation you want to use at build time and identify whether you want to build a pure
32-bit or 64-bit package, use the Architecture Validation setting for a product configuration in the Releases view.

For more details, see Selecting the Appropriate Type of Architecture Validation for Builds.

Tips for Building Two Installations—One 32 Bit and One 64 Bit—from a Single Project
If you want to be able to build two installations (one 32 bit and one 64 bit) from a single project, consider using release
flags. You can assign release flags to features, InstallShield prerequisites, and chained .msi packages, as necessary, to
differentiate the 32-bit items from the 64-bit items. Then you can configure each release or product configuration in the
Releases view to include or exclude certain items that have a particular release flag at build time. You can also
conditionally launch certain custom actions based on release flags, so that 32-bit custom actions are launched during a 32-
bit installation and 64-bit custom actions are launched during a 64-bit installation.

To learn more, see:

• Release Flags

• Filtering Based on Release Flags

• Conditionally Launching Custom Actions Based on Release Flags

InstallShield lets you override the values of your project’s path variables for each release in your project. This functionality
enables you to essentially replace certain files and folders in your project with others at build time, depending on the
particular release that you are building.

For example, you might use this functionality to swap out the binaries for custom actions. If you have set up separate
releases for 32-bit and 64-bit target systems, you can override the path variable that is used to refer to the DLL that is
selected for a custom action. Then InstallShield could include a 32-bit DLL for your 32-bit release and a 64-bit DLL for you
64-bit release. Note that overriding path variables to swap out files that your installation is installing is not recommended.
This is because you should use separate components for 32-bit and 64-bit versions of a file.

To override one or more path variables in your project, use the Path Variables Overrides setting, which is on the Build tab
for a release in the Releases view. For more information, see Build Tab for a Release.

See Also
Adding .NET Framework Redistributables to Projects
Destination Folders
Using 64-Bit Windows Installer Packages (Windows Installer Help Library)
Using 64-Bit Windows Installer Packages (Windows Installer Help Library)
Targeting 64-Bit Operating Systems
Building 64-Bit Setup Launcher

InstallShield 2020 User Guide ISP-2600-UG00 267

Chapter 1 InstallShield 2020 Help Library
Target System Requirements

Targeting 64-Bit Operating Systems with InstallScript Installations

InstallShield 2020

Project • This information applies to InstallScript projects.

With a single InstallScript project, you can create one installation that installs to 32-bit locations on 32-bit systems, and to
64-bit and 32-bit locations as needed on 64-bit systems.

InstallScript installations are always 32-bit so they can run only 32-bit DLL code (or launch 32-bit or 64-bit .exe files).
However, all InstallScript installations support accessing 64-bit locations through the 64-bit component setting, as well as
through other methods.

Reading from and Writing to the 64-Bit System32 Folder

InstallScript includes the following system variables that let you choose between 32-bit and 64-bit System32 folders on
target systems:

• WINSYSDIR

• WINSYSDIR64

Although the WINSYSDIR64 variable is set to the 64-bit Windows folder, 64-bit Windows includes functionality to
automatically redirect 32-bit applications (such as the InstallScript engine) to the 32-bit System32 folder (SysWOW64).
Therefore, if you are installing files or folders to WINSYSDIR64, you can disable file system redirection by placing the folders
or files in a component that is marked as 64 bit. To specify that a component is 64 bit, select Yes for the component’s 64-Bit
Component setting. For more information about the 64-Bit Component setting, as well as additional component settings,
see Component Settings.

As an alternative, you can use the constant WOW64FSREDIRECTION with the functions Disable and Enable to disable 64-bit
Windows file system redirection while writing to or reading from the WINSYSDIR64 folder through your InstallScript code,
and then re-enable it once the write or read is complete. Since some Windows functionality that could be used by the
installation requires that redirection be enabled to work, Windows documentation recommends that you disable
redirection only for as long as necessary.

Reading from and Writing to Other 64-Bit Destination Folders

InstallScript includes several addition system variables that let you choose between other 32-bit and 64-bit locations on
target systems:

• COMMONFILES

• COMMONFILES64

• FOLDER_APPLICATIONS

• FOLDER_APPLICATIONS64

• PROGRAMFILES

• PROGRAMFILES64

268 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
Target System Requirements

Reading from and Writing to 64-Bit Registry Locations

The 64-bit version of Windows includes functionality that maps some 64-bit registry locations to 32-bit equivalents. For
example, on a 64-bit version of Windows, HKEY_LOCAL_MACHINE\Software\Wow6432Node is the 32-bit equivalent of
HKEY_LOCAL_MACHINE\Software.

If you want to install registry data to a 64-bit area of the registry without having it redirected to a 32-bit area, you can place
the registry data in a component that is marked as 64 bit. To specify that a component is 64 bit, select Yes for the
component’s 64-Bit Component setting. For more information about the 64-Bit Component setting, as well as additional
component settings, see Component Settings.

As an alternative, you can use the REGDB_OPTION_WOW64_64KEY option with the REGDB_OPTIONS variable to avoid
registry redirection while editing the registry or reading from the registry through your InstallScript code, and then use the
REGDB_OPTION_USE_DEFAULT_OPTIONS option with REGDB_OPTIONS to enable changes to the 32-bit area of the
registry. Since some Windows functionality that could be used by the installation requires that redirection be enabled to
work, Windows documentation recommends that you disable redirection only for as long as necessary.

Installing Self-Registering 64-Bit COM Servers

InstallShield supports 64-bit self-registration of COM servers. For the component that contains the self-registering DLL,
.exe, .tlb, or .olb file, select Yes for the component’s Self-Register setting.

Note that 32-bit self-registering files should not be installed to the 64-bit System32 folder, since file system redirection
cannot be disabled for self-registration. Thus, if you have a 32-bit self-registering COM server that needs to be installed to
the 32-bit System32 folder, ensure that No is selected for the 64-Bit Component setting of the component that contains the
COM server.

About Add or Remove Programs Information

InstallScript installations do not support reading or writing Add or Remove Programs information in the 64-bit part of the
registry. Therefore, InstallScript installations always install Add or Remove Programs information in the 32-bit part of the
registry. In addition, the REGDB_OPTION_WOW64_64KEY option does not disable registry reflection for registry functions
such as CreateInstallationInfo, MaintenanceStart, RegDBGetItem, RegDBSetItem, RegDBGetAppInfo,
RegDBSetAppInfo, and RegGetUninstCmdLine.

See Also
Targeting 64-Bit Operating Systems

Targeting 64-Bit Operating Systems with Suite/Advanced UI and Advanced

UI Installations
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

InstallShield 2020 User Guide ISP-2600-UG00 269

Chapter 1 InstallShield 2020 Help Library
Launching InstallShield with vs. Without Administrative Privileges

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

Note • By default, the Suite/Advanced UI and Advanced UI installations are 32-bit. If required, you can change 64-Bit Setup
Launcher setting under release configuration for 64-bit installation. For 64-Bit Setup Launcher, see Building 64-bit Setup Exe.

Suite/Advanced UI and Advanced UI installations enable you to reference either 32-bit or 64-bit locations, and they can
launch 32-bit or 64-bit installations, depending on the target system.

For example, if you include in your Suite/Advanced UI project one installation that should target 32-bit systems, and
another installation that should target 64-bit systems, you could create an eligibility condition in the Packages view for
both of these packages; for the 32-bit package, the eligibility condition would contain a platform condition that checks for
the x86 architecture, and for the 64-bit package the eligibility condition would contain a platform condition that checks for
the x64 or IA64 architecture. For more information, see Types of Condition Checks in Advanced UI and Suite/Advanced UI
Projects.

See Also
Targeting 64-Bit Operating Systems
Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects

Launching InstallShield with vs. Without

Administrative Privileges
InstallShield 2020

If you launch InstallShield without administrative privileges, the following functionality is not available:

• COM extraction—Extracting COM information from a COM server requires administrative privileges.

If you specify that you want to have COM information extracted from a COM server in your project, and then you try to
build a release while running InstallShield without administrative privileges, build error -6017 occurs.

• Redistributable downloading—Downloading redistributables from within the Redistributables view requires

administrative privileges. This is because InstallShield tries to download the files to a per-machine location, which
requires administrative privileges.

If you try to download a redistributable from within the Redistributables view but you do not have administrative
privileges, InstallShield displays the following message:

The download failed; make sure you are running as Administrator, and that your machine is connected
to the Internet. Would you like to try again?

• Ability to specify All Users locations for InstallShield prerequisites—The Prerequisites tab on the Options dialog
box is where you specify the folders that contain the InstallShield prerequisites that should be displayed in the
Redistributables view and the Prerequisites view. Modifying the All Users location on that tab requires administrative
privileges, since InstallShield writes the information to a per-machine location in the registry. Therefore, the All Users
location on that tab is disabled if you are running InstallShield without administrative privileges.

270 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
Developing and Building Installations on 32-Bit vs. 64-Bit Systems

• Ability to specify All Users locations for merge modules—The Merge Module tab on the Options dialog box is where
you specify the folders that contain the merge modules that should be displayed in the Redistributables view.
Modifying the All Users location on that tab requires administrative privileges, since InstallShield writes the
information to a per-machine location in the registry. Therefore, the All Users location on that tab is disabled if you are
running InstallShield without administrative privileges.

• Ability to edit the locations for Regasm.exe and InstallUtilLib.dll—The .NET tab on the Options dialog box is where
you specify the locations of Regasm.exe and InstallUtilLib.dll files, which are utilities that are included with the
.NET Framework. These utilities are used for COM interop and .NET custom actions. Modifying these locations on the
.NET tab requires administrative privileges, since InstallShield writes the information to a per-machine location in the
registry. Therefore, these location settings on that tab are disabled if you are running InstallShield without
administrative privileges.

If you switch between full Administrator and non-Administrator contexts and you use mapped-drive locations in your
projects, you may encounter issues. For example, if you map a drive letter to a shared network folder through Windows
Explorer without administrative privileges, you can access this drive letter in a non-administrative instance of InstallShield,
but not in an administrative instance. Likewise, if you map a drive letter to a shared network folder through Windows
Explorer with administrative privileges, you can access this location in an administrative instance of InstallShield, but not
in a non-administrative instance. Thus, if you want to reference network locations in your project, consider using UNC
paths (such as \\server\share) or mapping drive letters both with and without administrative privileges.

Note that if you are using InstallShield from within Visual Studio, you may not have administrative privileges. By default, if
you launch Visual Studio by double-clicking its shortcut on a Windows Vista or later system, you will not have
administrative privileges.

Task To run InstallShield from within Visual Studio with administrative privileges on a Windows Vista or later system:

1. On the Start Menu, right-click the Visual Studio shortcut and then click Run as administrator.

2. Create a new InstallShield project or open an existing one. For more information, see one of the following:

• Creating InstallShield Projects in Microsoft Visual Studio

• Opening InstallShield Projects in Microsoft Visual Studio

Developing and Building Installations on 32-Bit vs.

64-Bit Systems
InstallShield 2020

InstallShield is a 32-bit application that runs on both 32-bit and 64-bit systems. In some cases, InstallShield behaves
differently, depending on whether you are using it on a 32-bit system or a 64-bit system; you may also encounter
differences depending on which operating system you are using. The following sections explain these differences.

Note that like InstallShield, the command-line build (ISCmdBld.exe), the Standalone Build, and the automation interface
are also 32-bit applications. Therefore, the same platform-specific differences occur for these tools.

InstallShield 2020 User Guide ISP-2600-UG00 271

Chapter 1 InstallShield 2020 Help Library
Developing and Building Installations on 32-Bit vs. 64-Bit Systems

Loading the Automation Interface

The automation interface is a 32-bit interface; therefore, it must be loaded from a 32-bit process. If you are using the
automation interface on a 64-bit machine, you may need to load the automation interface through a 32-bit executable file.
Otherwise, you may encounter errors.

For more information, see Using the Automation Interface on a 64-Bit System.

Adding System Files to Your Project

When you are using InstallShield on a 64-bit system and you want to add to your project a system file whose source
location is the 64-bit System folder (System32) on your development machine, it is not possible to drag the file from one of
the source computer panes at the top of the Files and Folders view to the appropriate location in one of the destination
computer panes.

To add a 64-bit System32 file on your development machine to your InstallShield project, you can browse to the Sysnative
folder on your machine and then select the appropriate file for your project. To learn more, see Adding Files from Your 64-
Bit Source Machine’s 64-Bit System32 Folder.

Viewing Both the 32- and 64-Bit Areas of the Source Machine’s Registry on 64-Bit
Development Systems
If you are using InstallShield on a 64-bit development system, the Registry view in InstallShield displays both the 32-bit and
64-bit areas of your machine’s registry:

• HKEY_LOCAL_MACHINE\Software

• HKEY_LOCAL_MACHINE\Software\Wow6432Node

This support enables you to drag and drop entries from those source areas to the appropriate areas in the destination pane
of this view when you are configuring registry data changes for your project.

Note that if you want your installation to install registry data to a 64-bit area of the registry on 64-bit target systems without
having it redirected to a 32-bit area, you must place the registry data in a component that is marked as 64 bit. Simply
dragging 64-bit data from the source panes in the Registry view to a location in one of the destination panes of the view
does not mark the component as 64 bit. For more information, see the following:

• Targeting 64-Bit Operating Systems

• Dragging and Dropping Registry Entries to Create Registry Keys

Extracting COM Data from 64-Bit COM Servers

If you want to extract COM data from a 64-bit COM server at design time or at build time, you must be using InstallShield on
a 64-bit operating system. If you use InstallShield on a 32-bit system, 64-bit COM extraction is not available.

To learn about extracting COM data, see Extracting COM Registration Data at Build Time.

Scanning 64-Bit Files for Dependencies

If you use the dependency scanners in InstallShield to help you identify dependencies that you may need to add to your
project, these scanners can check 64-bit files in your project for dependencies only if you are using InstallShield on a 64-bit
operating system.

272 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1 InstallShield 2020 Help Library
Developing and Building Installations on 32-Bit vs. 64-Bit Systems

If you are using InstallShield on a 32-bit system, the dependency scanners in InstallShield cannot check 64-bit files in your
project for dependencies. To add 64-bit dependencies to a project on a 32-bit system, consider manually adding the
required files and merge modules to your project.

To learn about scanning files for dependencies, see Identifying Application Dependencies.

Scanning 64-Bit .NET Assemblies for Dependencies and Properties

If you use InstallShield on a 64-bit version of Windows Vista or later or a 64-bit version of Windows Server 2008 or later, and
you use one of the built-in methods for detecting dependencies, InstallShield can scan for 64-bit dependencies of the 64-bit
.NET assemblies in your project.

These methods also scan for 32-bit dependencies of the 32-bit .NET assemblies in your project.

Note that if you use InstallShield on a 32-bit version of Windows, these built-in scans can check for only 32-bit
dependencies of the 32-bit files in your project. If your project includes 64-bit files, you can manually add any
dependencies to the project as needed.

To learn more, see the following:

• Identifying Properties and Dependencies of .NET Assemblies

• Scanning 64-Bit .NET Assemblies for Dependencies

Using 64-Bit .NET Installer Classes and COM Interop

If you are using InstallShield on a 64-bit version of Windows, the .NET tab on the Options dialog box—which is displayed
when you click Options on the Tools menu in InstallShield—lets you specify different paths for the 32-bit and 64-bit
locations of the Regasm.exe and InstallUtilLib.dll files that are included with the .NET Framework. InstallShield uses
the paths that you specify at build time for releases that include .NET installer classes and COM interop.

If you are building from the command line with ISCmdBld.exe on a 64-bit version of Windows, and you use the existing -t
parameter to specify the path of the 32-bit version of the .NET Framework, ISCmdBld.exe uses the 64-bit location of
Regasm.exe and InstallUtilLib.dll for 64-bit .NET installer classes and COM interop.

If you are building through MSBuild or Team Foundation Server (TFS) and you use the existing DotNetUtilPath parameter
on the InstallShield task to specify the path of the 32-bit version of the .NET Framework, the build uses the 64-bit location
of Regasm.exe and InstallUtilLib.dll for 64-bit .NET installer cases and COM interop.

Note that if you are using InstallShield on a 32-bit operating system, the setting for the 64-bit location is disabled, and only
32-bit support for .NET installer cases and COM interop is available. This support also applies to building from the
command line with ISCmdBld.exe, and building through MSBuild or TFS.

To learn more, see:

• .NET Tab (on the Options dialog box)

• ISCmdBld.exe

• Microsoft Build Engine (MSBuild)

See Also
Launching InstallShield with vs. Without Administrative Privileges

InstallShield 2020 User Guide ISP-2600-UG00 273

Chapter 1 InstallShield 2020 Help Library
Using Help

Using Help
InstallShield 2020

Revenera understands the importance of having useful information and help resources at your fingertips. In addition to the
inline help embedded within various views of the InstallShield interface, InstallShield includes a help library that is
installed with the product, an online help system that is available on the Web, and documentation that is available in PDF
format.

InstallShield Help Library

When you have questions about your product, first consult the InstallShield Help Library. It is a complete user guide.

You can access the InstallShield Help Library from the Help menu in InstallShield, by pressing F1, or by clicking Help
buttons in the interface.

No Internet connectivity is required to view the InstallShield Help Library. Essentially, the online help viewer is a tool that
you can use to display, search, and filter technical information based on your personal needs.

Using Context-Sensitive Help

While working on a project, clicking a software object displays its help information in the Help window. This is also called
“context-sensitive” help.

Help information is also available for each of the properties of a selected software object displayed in the Explorer window,
which provides instructions for setting that property.

Web-Based Online Help

Web-based online help is available to you 24 hours a day, seven days a week, on our Web site at http://docs.revenera.com.
This help resource center provides near real time updates to documentation.

Documentation as PDF
InstallShield documentation is also available as a PDF at: https://community.revenera.com/.

274 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 1
Contacting Us

Contacting Us
InstallShield 2020

Revenera is headquartered in Itasca, Illinois, and has offices worldwide. To contact us or to learn more about our products,
visit our website at:

http://www.revenera.com

InstallShield 2020 User Guide ISP-2600-UG00 275

Chapter 1
Contacting Us

276 ISP-2600-UG00 InstallShield 2020 User Guide

 2
Getting Started

InstallShield 2020

InstallShield provides powerful features and time-saving tools that make authoring reliable Windows Installer and
InstallScript installations easy. The InstallShield Help Library is a resource that will help you harness the full potential of
InstallShield. The help topics you might want to read first depend upon your previous experience with InstallShield
installation-authoring software. The table below directs you to various topics based on your level of experience.

Table 2-1 • Getting Started Road Map

Level of Familiarity Top Help Topics

You have not created installations To learn general information about installations, refer to the following
previously. topics:

• Installation Fundamentals

• Application Lifecycle

You are new to InstallShield. If you have created installations previously but you do not have experience
using InstallShield, see the following topics:

• Working with the InstallShield Interface

• Working with Projects

• Basic MSI Project Tutorial

• Globalization Tutorial

• InstallScript Project Tutorial

• Run-Time Language Support in InstallShield

• Supported Application Programming Languages

InstallShield 2020 User Guide ISP-2600-UG00 277

Chapter 2 Getting Started
Installation Fundamentals

Table 2-1 • Getting Started Road Map (cont.)

Level of Familiarity Top Help Topics

You have used other Revenera If you have used other products from Revenera, refer to any of the following
products. topics:

• Upgrading from Earlier InstallShield Versions

• Upgrading from Other InstallShield Editions

• Project Assistant

• Installation Projects Overview

You are an intermediate-level or If you are familiar with InstallShield, you may want to review the following
advanced-level user of InstallShield. topics:

• Command-Line Tools

• Errors and Warnings

• InstallScript Language Reference

• Running Installations in Silent Mode

• Configuring Advanced Settings for InstallShield

See Also
Frequently Asked Questions

Installation Fundamentals
InstallShield 2020

An installation, in its simplest terms, is the “package” used to install your files and programs onto your user’s machine. It is
a complete collection of the application files, as well as logic that interacts with the installer engine. The primary task of
any installation is to transfer the application files from the source medium to the end user’s computer. The complexities of
the Windows operating system make it anything but simple to create an effective, coherent installation without the aid of a
utility such as InstallShield.

An installation is divided into three levels: products, features, and components. The following diagram illustrates this
hierarchy:

278 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Application Lifecycle

Figure 2-1: Installation Hierarchy

A product is the highest level of organization in an installation project. A product is usually one main application (for
example, a word processor) and all of the files and data that the application requires; a suite of applications may also be a
product.

A feature is the smallest installable part of a product, from the end user’s perspective. As the designer of an installation
program, you usually allow the user to choose which features to install and which features to leave on the source media. In
a word processor product, the main executable may be one feature, and optional dictionaries may be a separate feature. A
feature should be self-contained, in the sense that a feature should not require sibling features. For example, a thesaurus
feature should not require a dictionary feature that the user can choose not to install. However, you can design features to
contain subfeatures, which allow the end user finer control over which files and data to install.

Each feature in a project is made up of one or more components. A component is the smallest installable part of a product
from the installation developer’s perspective; components are invisible to the end user. Each component contains files
(and other resources) with similar properties. For example, all of the files in a component will be installed in the same
directory on an end user’s machine, and all of the files in a component should apply to the same operating system or
language. A dictionary feature might contain several language-specific dictionary components. In addition to containing
files, components generally contain registry data, shortcuts, file extension information, and other system data to write to a
user’s machine.

When you are designing an installation, the overall task is to separate the product’s files into components based on the
files’ destination, operating system, language, and other properties, and to associate each component with one or more
features.

See Also
Application Lifecycle
Working with Projects
Creating Installations

Application Lifecycle
InstallShield 2020

Your application lifecycle should not end when your customer installs your application. As a software vendor, the success
of your application goes well beyond the initial installation on the customer’s desktop. Customers expect to have easy
access to product updates, enhancements, and critical information. Your ability to communicate with your customers and
monitor the health of your application is vital to your ongoing growth and profitability.

InstallShield 2020 User Guide ISP-2600-UG00 279

Chapter 2 Getting Started
Starting InstallShield

Too often, software vendors require their customers to initiate communication. Vendors who are not proactively creating
an ongoing dialog are missing a tremendous opportunity. Unless the customer is an active visitor to your Web site or public
user communities, they miss important information about updates, upgrades, hot fixes, and general technical bulletins.
You miss revenue and service opportunities.

Figure 2-2: How FlexNet Connect Manages the Application Lifecycle

The above diagram illustrates how FlexNet Connect is used to manage the application lifecycle:

1. Create Install—InstallShield makes it easy for software developers to create installations that run on any platform.

2. Run Install—Installations created with InstallShield technology have successfully installed on over 400 million
machines worldwide.

3. Create Update—InstallShield enables software developers to rapidly build patches and updates.

4. Notify User—FlexNet Connect notifies every user that a new update is ready to be installed.

5. Download & Install—FlexNet Connect downloads the update and installs it in one seamless, integrated process.

6. View Reporting—FlexNet Connect provides immediate feedback on the update’s adoption rate.

See Also
Creating Installations
Updating Applications
Notifying End Users about Upgrades Using FlexNet Connect
General Information View Settings

Starting InstallShield
InstallShield 2020

Each time you open InstallShield (with the exception of the initial launch after installing the product), you are taken
directly to the InstallShield Start Page. The Start Page provides quick access to product information, to recently opened
projects, and to InstallShield resources.

See Also
InstallShield Start Page

280 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Starting InstallShield

InstallShield Start Page

InstallShield 2020

The InstallShield Start Page provides quick access to product information, to recently opened projects, and to InstallShield
resources. The Start Page includes the following sections:

Table 2-2 • Sections on the Start Page

Section Description

Project Tasks Click a project task to quickly create a new project, open an existing project, or browse to one
of the sample projects included with the InstallShield installation.

Help Topics Frequently accessed help topics are listed in this section. To access the entire InstallShield
Help Library from the Start Page, press F1 or click the Help Library link in the Resources
section.

(Recently Opened The section in the middle of the Start Page lists your most recently accessed projects, the
Projects) project types, and the dates on which they were last modified.

Getting Started Click the Getting Started heading for guidance on what areas of the InstallShield Help Library
to read, based on your level of experience with InstallShield and installation-authoring tools.

Resources The Resources section contains a number of links to connect you to helpful InstallShield
information.

• Help Library—Displays the InstallShield documentation.

• InstallShield Community—Provides a Web-based forum where you can join other

InstallShield users, post questions, and search for answers.

• Webinars—Directs you to free Web-based seminars that help you evaluate InstallShield
and gain the most from your Revenera products.

• Downloads—Offers a place where you can download the latest InstallShield

prerequisites, InstallShield merge modules, and objects; service packs; patches; and
more for the version of InstallShield that you are using.

• Release Notes—Connects you to the release notes that are posted to the Knowledge
Base on the Revenera Web site.

• Known Issues—Displays the Knowledge Base article that lists the known issues for the
version of InstallShield that you are using and provides information about workarounds
and resolutions.

• Upgrade Alerts—Displays the Knowledge Base article that provides information about
possible issues that may occur when you upgrade projects that were created with earlier
versions of InstallShield to InstallShield 2020. It also alerts you to possible changes in
behavior that you may notice between new InstallShield 2020 projects and projects that
are upgraded from earlier versions.

• RSS Feeds—Directs you to the Web page where you can subscribe to RSS feeds of
InstallShield Knowledge Base articles.

InstallShield 2020 User Guide ISP-2600-UG00 281

Chapter 2 Getting Started
Working with Projects

Table 2-2 • Sections on the Start Page (cont.)

Section Description

Contact Us To access the Support area of the Revenera Web site, click one of the links listed in this
section.

Working with Projects

InstallShield 2020

An InstallShield project specifies the files, folders, and operations that make up the project’s output. A project’s output is
one of the following (depending on the project type):

• Installation: creates or updates a copy of your application on the target system

• Redistributable (merge module or InstallShield object): contains logic and files needed to install distinct pieces of
functionality when included in an installation

• Transform: enables an administrator to apply modified settings to an Windows Installer installation when deploying
the installation

A project can be as simple or as complex as you need to meet your requirements. A simple project might consist of files,
components, features, and registry entries. More complex projects might consist of these items plus redistributables,
initialization file changes, and calls to external DLL functions.

See Also
Project Types

Installation Projects Overview

InstallShield 2020

With InstallShield, you have the ability to choose between a variety of different installation project types—those that use
InstallShield’s powerful InstallScript programming language (InstallScript), those that use the Windows Installer database
(Basic MSI), or a combination of the two (InstallScript MSI).

The installation project type you choose depends on the needs of your software installation. InstallShield provides the
same intuitive user interface for all project types, so your application’s needs can dictate the project type and your
authoring experience does not change. Additionally, the knowledge gained by learning how to create projects of one type
is applicable to projects of the other types.

Similarities Between Project Types

All InstallShield installation project types create installations that have the same professional, industry-standard look and
feel that your end users have come to expect from InstallShield. All enable you to create customized installations to meet
the needs and expectations of your end users.

Despite the similarities in the project types’ feature sets, there are some important differences between them—especially
between the InstallScript and Basic MSI projects. See Determining Which Installation Project Is Right for You to learn which
of these project types is right for your software installation needs.

282 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

See Also
InstallScript Installation Projects
Basic MSI Installation Projects
InstallScript MSI Installation Projects

Determining Which Installation Project Is Right for You

InstallShield 2020

InstallShield enables you to create different types of projects, but for the beginner there is just one significant choice to
make: Do you want to build your installation with Windows Installer or InstallScript technology? Deciding which project
type is right for you depends on your experience with InstallShield software and installation development and on your
installation and deployment needs. The three main project types are described below.

Basic MSI Projects

Basic MSI projects use the Windows Installer service to drive the entire installation, including calls to any custom actions
(InstallScript, VBScript, JScript, .exe files, .dll files, managed code). The Basic MSI project type is recommended when you
want to do any of the following:

• You want to meet the Windows logo program requirements.

• You want to maximize compatibility with administrative tools such as Microsoft System Center Configuration
Manager, or if your software will be customized by corporate system administrators prior to deployment. The Basic
MSI project type gives them the flexibility to create transforms for the installation package and its associated
properties, without repackaging your installation.

• You want to avoid writing scripting code and want to instead set properties and make table entries.

• You want to upgrade an existing Basic MSI project.

InstallScript Projects
InstallScript projects use InstallScript to control the installation. This project type is recommended for any of the following
scenarios:

• You have advanced requirements for the end-user experience (the end-user dialogs), such as multimedia elements.

• You want to use full-screen billboards during the run time of your installation.

• You prefer authoring the project using a procedural language at its core rather than a set of database tables.

• You want to perform actions before or after the main installation has been run.

• You want to upgrade an existing InstallScript project.

InstallScript MSI Projects

InstallScript MSI projects use both the Windows Installer engine and the InstallScript engine to drive the installation. This
project type is the most complicated since it uses both of those engines for the installation; it is not recommended for
beginners. This project type may be recommended in the following scenarios:

• You want to meet the Windows logo program requirements.

• You have advanced requirements for the end-user experience (the end-user dialogs), such as multimedia elements.

InstallShield 2020 User Guide ISP-2600-UG00 283

Chapter 2 Getting Started
Working with Projects

• You prefer authoring the project using a procedural language at its core rather than a set of database tables.

• You want to perform actions before or after the main installation has been run.

• You want to upgrade an existing InstallScript MSI project.

Tip • Repackager is a project conversion tool that is available in AdminStudio. You can use this tool to convert InstallScript
projects and InstallScript MSI projects to Basic MSI projects.

See Also
InstallScript Installation Projects
Basic MSI Installation Projects
InstallScript MSI Installation Projects
Converting from One Project Type to Another Project Type

Project Types
InstallShield 2020

InstallShield offers a number of different project types to assist you in creating the optimal project for your end users.

Table 2-3 • Project Type Descriptions

Project Type Icon Description

Advanced UI

Edition • This project type is available in the Professional edition of

InstallShield. If you open this type of project in the Premier edition of
InstallShield, it opens as a Suite/Advanced UI project.

An Advanced UI project lets you create a bootstrap application with a

contemporary, customizable user interface for a single .msi package, .msp
package, or InstallScript package, as well as multiple InstallShield
prerequisites. An Advanced UI installation uses a setup launcher
(Setup.exe) to conditionally launch packages on target systems as needed.

Basic MSI A Basic MSI project uses Windows Installer to provide the user interface for
the installation. When you choose this project type, you need to create
features and components, and specify all application files and other
distributable data.

DIM A DIM project is targeted toward engineering teams who want to foster
collaboration, enable distributed installation development, and maximize
efficiency in their organizations. A developer installation manifest (DIM) is a
feature-sized collection of related items such as product files, shortcuts,
registry entries, text file changes, IIS Web sites, and other elements that
together make up a discrete, logically separated portion of a product
installation. You can incorporate one or more DIMs into Basic MSI projects.

284 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

Table 2-3 • Project Type Descriptions (cont.)

Project Type Icon Description

InstallScript The InstallScript installation project provides the flexibility afforded by the
InstallScript language and is driven by the proven InstallScript engine.

InstallScript MSI An InstallScript MSI project uses both InstallScript and Windows Installer
tables. With this project type, you need to create features and components,
and specify all application files and other distributable data.

InstallScript Object Using the InstallScript Object project, you can create an InstallShield merge
module that uses InstallScript. This type of merge module, however, can be
consumed only by InstallShield.

Merge Module Select this option to create your own merge modules. You need to create
any components and file associations.

MSI Database Select MSI Database to edit your installation project in Direct Edit mode.
This means that you can directly edit the Windows Installer tables within
InstallShield to configure your installation.

MSM Database Select MSM Database to edit your merge module in Direct Edit mode. This
means that you can directly edit the Windows Installer tables within
InstallShield to configure your merge module.

QuickPatch This project type is recommended for installation authors who want to ship
small, single updates to their end users. QuickPatch authoring provides an
alternative to creating a patch configuration in the Patch Design view even
though it provides less customization. Creation of a QuickPatch begins with
the Create New QuickPatch Wizard.

Suite/Advanced UI

Edition • This project type is available in the Premier edition of InstallShield.

A Suite/Advanced UI project lets you create a bootstrap application with a

contemporary, customizable user interface for multiple .msi packages,
.msp packages, InstallScript packages, .exe packages, Web Deploy
packages, sideloading Windows App packages (.appx), and Windows
Installer transactions, as well as multiple InstallShield prerequisites. A
Suite/Advanced UI installation packages together multiple separate
installations as a single installation while providing a unified user interface;
it uses a setup launcher (Setup.exe) to conditionally launch packages on
target systems as needed.

InstallShield 2020 User Guide ISP-2600-UG00 285

Chapter 2 Getting Started
Working with Projects

Table 2-3 • Project Type Descriptions (cont.)

Project Type Icon Description

MSIX

Edition • This project type is available in the Premier and Professional

edition of InstallShield.

MSIX is a Windows app package format that provides a modern packaging

experience to all Windows apps. The MSIX package format preserves the
functionality of existing app packages and/or install files in addition to
enabling new, modern packaging and deployment features to Win32, WPF,
and WinForm apps.

MSI to MSIX Conversion The MSI to MSIX Conversion Wizard enables you to convert existing
Wizard Windows Installer files (.msi files) to MSIX packages through a Basic MSI
project.

MSIX Modification Package

Project
Edition • This project type is available in the Premier and Professional
edition of InstallShield.

MSIX Modification Package is a new type of MSIX package that store

customizations (Introduced in Windows 10, version 1809). MSIX
Modification Packages are applied as an overlay of an MSIX package, not at
installation time, but upon execution of the application. Modification
packages can also be plugins/add-ons that may not have an activation
point. IT professionals can use this feature to flexibly change MSIX
containers so that applications are overlaid by their enterprise's
customizations.

Transform A transform (.mst file) is a simplified Windows Installer database that

contains the differences between two Windows Installer databases.
Creating a new transform project launches the Open Transform Wizard.

Visual Basic .NET Wizard Select this option to launch the Visual Studio .NET Wizard for Visual Basic
.NET, C# .NET, and Visual C++ .NET.

C# .NET Wizard Select this option to launch the Visual Studio .NET Wizard for Visual Basic
.NET, C# .NET, and Visual C++ .NET.

Visual C++ .NET Wizard Select this option to launch the Visual Studio .NET Wizard for Visual Basic
.NET, C# .NET, and Visual C++ .NET.

See Also
Creating New Projects
Determining Which Installation Project Is Right for You
Converting from One Project Type to Another Project Type

286 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

Advanced UI and Suite/Advanced UI Projects

InstallShield 2020

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

Advanced UI and Suite/Advanced UI installations are bootstrap applications that package together installations and
InstallShield prerequisites as a single installation while providing a unified, fully customizable user interface. They use a
setup launcher (Setup.exe) to conditionally launch packages on target systems as needed.

Note that Advanced UI and Suite/Advanced UI installations require Windows Vista or later or Windows Server 2008 or later.

Also note that the ability to create and build a Suite/Advanced UI installation that includes a sideloading Windows App
package (.appx) requires Windows Vista or later or Windows Server 2008 or later on the machine that has InstallShield or
the Standalone Build.

See Also
Creating Advanced UI and Suite/Advanced UI Installations
Primary Packages vs. Dependency Packages in Advanced UI and Suite/Advanced UI Projects

MSIX Projects
InstallShield 2020

Edition • The MSIX project type is available in the Premiere edition and Professional edition of InstallShield.

MSIX is the Windows app package format that provides a modern packaging experience to all Windows apps. The MSIX
package format preserves the functionality of existing app packages and/or install files in addition to enabling new,
modern packaging and deployment features to Win32, WPF, and WinForm apps.

In InstallShield 2019 and later, you can now use MSIX project type to build MSIX packages. It contains windows applications
for side-loading or distribution via the Windows Store.

• Package Information

• Package Payload

• Media

Package Information
Now you can describe and identify your project by providing:

• General Information view to specify details such as the name and format of the project file.

• MSIX VisualAssets explorer to offer an integrated, visual method for describing visual aspects of the MSIX apps.

• Capabilities view that requires to be enabled in app's package manifest to access certain API or resources like
pictures, music, or devices such as the camera or the microphone.

InstallShield 2020 User Guide ISP-2600-UG00 287

Chapter 2 Getting Started
Working with Projects

• Declarations view that provides a visual tool for creating and managing the application, package level declarations
and allows to configure their properties.

• Content URIs view to specify the URIs that can use window.external.notify to send a Script-Notify event to the app.

Package Payload
Now you can specify the files that designs your MSIX application:

• Files and Folders view lets you to add files to your InstallShield project. You can organize these files into folders on
the target system.

Important • If you are packaging your UWP application using MSIX project, you are required to add all the assets in the same
folder structure as expected by the application.

• Applications view offers an integrated, visual method for designing windows app properties that comprises part of or
all of the functionality delivered in the package.

• Registry view enables you to define registry keys and values to be created by your installation.

Media
Now you can customize the files and folders that you will use to distribute your installation:

• Path Variables view makes your installation easily portable between development systems through the use of
variables.

• Releases view provides a visual tool for each product in your project.

Basic MSI Installation Projects

InstallShield 2020

Basic MSI is the Windows Installer–based project type in InstallShield. Basic MSI projects are recommended in cases where
the Windows Installer service should drive the entire installation. They allow you to author your installation using only the
native Windows Installer feature set. The geometry of your end user dialogs as well as the flow of your setup user interface
(UI) is authored directly in the MSI package, and the Windows Installer Service uses its native user interface rendering
capabilities to display the UI to your end users. The advantages of this project type are fully realized if you need to author
your installation in an open format.

Note • Create a Basic MSI project if your software will be customized by corporate systems administrators prior to
deployment. It gives them the flexibility to create transforms for the installation package and its associated properties,
without repackaging your installation.

Basic MSI projects have the ability to run InstallScript code in the form of custom actions. As with InstallScript projects,
Basic MSI projects take advantage of other robust features provided by InstallShield such as dialog authoring, the ability to
call custom actions in standard Windows .dll files, and the ability to specify support files.

288 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

See Also
Installation Projects Overview
InstallScript Installation Projects
Converting from One Project Type to Another Project Type

Run-Time Behavior for Basic MSI Installations with InstallScript Custom Actions
InstallShield 2020

For InstallShield 12 and Later Projects

The following steps outline the run-time behavior for Basic MSI installations that include InstallScript custom actions:

1. The package is launched by the Windows Installer service.

2. Any sequenced InstallScript custom actions execute as follows.

a. The Windows Installer calls the relevant entry point in ISSetup.dll (loaded from the Binary table).

b. ISSetup.dll extracts its Setup.inx resource to a temporary location.

c. ISSetup.dll executes relevant script code.

d. Windows Installer unloads ISSetup.dll.

The run-time behavior for InstallShield 12 and later Basic MSI projects that have InstallScript custom actions is much
different than the behavior for InstallShield 11.5 and earlier because of some architecture enhancements. For more
information about the enhancements, see Upgrading Projects from InstallShield 11.5 or Earlier.

For InstallShield 11.5 and Earlier Projects

For installations created with InstallShield 11.5 and earlier, the run-time behavior is as follows:

1. Setup.exe installs ISScript.msi.

2. Setup.exe launches MsiExec.exe to install the primary .msi file. (Setup.exe must be included in the installation, or it
must already be present on the target system.)

3. ISMsiServerStartup (immediate custom action) starts and initializes IDriver.exe.

4. Any sequenced InstallScript custom actions execute as follows.

a. The Windows Installer finds the relevant entry point in ISScriptBridge.dll.

b. ISScriptBridge.dll finds the running IDriver.exe instance using the running object table (ROT).

c. IDriver.exe executes relevant script code.

5. ISCleanUpSuccess shuts down IDriver.exe.

If you upgrade an InstallShield 11.5 or earlier project to InstallShield 2020, the run-time behavior is updated to the behavior
described for InstallShield 12 and later projects.

See Also
Upgrading InstallShield 11.5 or Earlier Basic MSI Projects that Have InstallScript Custom Actions
Overview of ISSetup.dll

InstallShield 2020 User Guide ISP-2600-UG00 289

Chapter 2 Getting Started
Working with Projects

DIM Projects
InstallShield 2020

The DIM support in InstallShield is targeted toward engineering teams who want to foster collaboration, enable distributed
installation development, and maximize efficiency in their organizations. A developer installation manifest (DIM) is a
feature-sized collection of related items such as product files, shortcuts, registry entries, text file changes, IIS Web sites,
and other elements that together make up a discrete, logically separated portion of a product installation. Some benefits
of using DIMs are as follows:

• Working with DIMs enables multiple team members to contribute to the development of the installation
simultaneously. Each software developer or other team member can work on a separate DIM that the release engineer
can reference in one or more installation projects.

• Release engineers can reuse DIMs in multiple installation projects, enabling efficiency.

• DIMs include support for virtually the same functionality that is available in Basic MSI projects. This gives authors of
DIMs all of the flexibility that they need to develop their portions of an installation.

See Also
Modularizing Installation Projects to Distribute Development Work and Enable Reuse
Using Path Variables in a DIM
Specifying the Default Destination Folder for a DIM

InstallScript Installation Projects

InstallShield 2020

The InstallScript installation project type provides the power and flexibility of the InstallScript programming language and
the familiarity of the InstallShield Professional project. Windows Installer is not used at all. The installation is completely
script driven and very flexible, and it uses the InstallScript engine, the same trusted engine used by InstallShield
Professional.

Note • InstallScript installations are generally less desirable to systems administrators because they require the use of
Setup.exe, rather than being self-contained in an .msi file, and may not be fully customizable prior to deployment. If your
software will be customized by corporate systems administrators prior to deployment, create a Basic MSI installation project.

The InstallScript Engine

With InstallScript projects, the run-time user interface is rendered and its flow controlled by InstallScript, and the changes
that are made to the target operating system are done through InstallShield’s trusted InstallScript engine, with no reliance
on Windows Installer.

Using InstallScript as the installation driver has many benefits. The first is that InstallScript’s event model enables you to
create a script-driven installation without writing a single line of code. If you want to add custom functionality, you need to
implement only the events whose functionality you want to change.

The user interface abilities for Basic MSI projects are somewhat limited with regard to the types of controls you can use or
the kind of control you have over dialog events. InstallScript projects have no such limitation—offering a wide range of
standard controls along with the ability to add custom dialog controls. Dialog messaging in the script enables you to have
complete control over how your end-user dialogs behave.

290 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

Upgrading Projects Created Using InstallShield Professional

Installation projects created using InstallShield Professional (version 5.5 and later) upgrade to the InstallScript project
type.

Additional Features for InstallScript Projects

InstallScript projects provide a few additional features that are not available in Basic MSI projects:

Table 2-4 • Additional InstallScript Project Features

Feature Description

Setup Types view This view enables you to easily create different installation configurations for
your application. This view also lets you select the defaults for the Custom setup
type.

Billboard Support Run-time billboard support is available only for InstallScript projects. Billboards
let you show bitmaps to the end user while files are being transferred to their
machine. You can use these bitmaps to entertain or educate user.

See Also
Installation Projects Overview
Basic MSI Installation Projects
Converting from One Project Type to Another Project Type

InstallScript MSI Installation Projects

InstallShield 2020

InstallScript MSI installations use two different installer engines:

• The Windows Installer engine runs the standard Execute sequence of the .msi package. This is the sequence that
typically modifies the target system.

• The InstallScript engine serves as the custom user interface (UI) handler of the installation. It also executes the
InstallScript code. The advantage of using the InstallScript engine for the UI is that it offers support for highly
customized run-time dialogs.

In addition, InstallShield offers two different styles for the UI of InstallScript MSI installations:

• Traditional style—This style lets you use the InstallScript engine as an external UI handler for your InstallScript MSI
installation. With this style, your installation must include a Setup.exe setup launcher. The setup launcher serves as a
bootstrap application that initiates the InstallScript engine to display the UI and run the InstallScript code, and the
Windows Installer to run the Execute sequence of the .msi package.

• New style—This style lets you use the InstallScript engine as an embedded UI handler for your InstallScript MSI
installation. For this style, InstallShield embeds the InstallScript engine within the .msi package. The Windows
Installer calls the InstallScript engine to display the UI. The Windows Installer also runs the Execute sequence of the
.msi package.

This option requires Windows Installer 4.5 on the target machine. This option also has some limitations that require
careful planning if you decide to use this style.

InstallShield 2020 User Guide ISP-2600-UG00 291

Chapter 2 Getting Started
Working with Projects

For detailed information about these two styles, see Using the InstallScript Engine as an External vs. Embedded UI Handler
for InstallScript MSI Installations.

Note • Because this project type uses two different engines, it is more complex than pure InstallScript or Basic MSI installation
projects. It is recommended only for advanced users.

Traditional-style InstallScript MSI installations are less desirable to systems administrators than Basic MSI installations or
new-style InstallScript MSI installations. That is because traditional-style InstallScript MSI installations require the use of
Setup.exe, rather than being self-contained in an .msi package, and they may not be fully customizable prior to deployment.
If your software will be customized by corporate systems administrators prior to deployment, create a Basic MSI project. As an
alternative, you could consider using the new-style InstallScript MSI installations, but your must ensure that any system
changes that need to be made are done with custom actions in the Installation Execute sequence. To ensure that sufficient
privileges are available, custom actions should have an in-script execution setting of deferred in system context.

Additional Features for InstallScript MSI Projects

InstallScript MSI projects provide a few additional features that are not available in Basic MSI projects:

Table 2-5 • Additional InstallScript MSI Project Features

Feature Description

Setup Types view This view enables you to easily create different predefined installation
configurations for your application, such as Typical or Compact. This view also
enables you to select the defaults for the Custom setup type.

Billboard Support Run-time billboard support is available for InstallScript MSI installations, but
not Basic MSI installations. Billboards enable you to show bitmaps while files
are being transferred to an end user’s machine. You can use these bitmaps to
entertain or educate end users.

See Also
InstallScript Installation Projects
Basic MSI Installation Projects
Converting a Basic MSI Project to an InstallScript MSI Project
Converting an InstallScript MSI Project to an InstallScript Project

Run-Time Behavior for InstallScript MSI Installations

InstallShield 2020

For InstallShield 12 and Later Projects

The following steps outline the run-time behavior for InstallScript MSI installations:

1. Setup.exe initializes ISSetup.dll.

2. ISSetup.dll does the following:

a. Loads Setup.inx.

292 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

b. Executes pre-installation InstallScript events (for example, OnBegin).

c. Launches the Windows Installer (and the InstallScript engine for the external user interface).

d. Each InstallShield custom action executes as follows (for example, OnMoved). (Note that this essentially the
same mechanism that is used in Basic MSI with InstallScript custom actions.)

i. The Windows Installer calls the relevant entry point in ISSetup.dll. (This is a different instance of
ISSetup.dll, loaded from the Binary table.)

ii. ISSetup.dll extracts its Setup.inx resource to a temporary location.

iii. ISSetup.dll executes relevant script code.

iv. Executes post-installation InstallScript events (for example, OnEnd).

The run-time behavior for InstallShield 12 and later InstallScript MSI projects is much different than the behavior for
InstallShield 11.5 and earlier because of some architecture enhancements. For more information about the enhancements,
see Upgrading Projects from InstallShield 11.5 or Earlier.

For InstallShield 11.5 and Earlier Projects

For InstallScript MSI installations created with InstallShield 11.5 and earlier, the run-time behavior is as follows:

1. Setup.exe installs ISScript.msi.

2. Setup.exe launches IDriver.exe.

3. IDriver.exe does the following:

a. Loads Setup.inx.

b. Executes pre-installation InstallScript events (for example, OnBegin).

c. Launches the Windows Installer (and the InstallScript engine for the external user interface).

Each InstallScript custom action executes as follows (for example, OnMoved). (Note that this is the same
mechanism used in Basic MSI installations with custom actions.)

i. The Windows Installer calls the relevant entry point in ISScriptBridge.dll.

ii. ISScriptBridge.dll finds the running IDriver.exe instance using the running object table (ROT).

iii. IDriver.exe executes relevant script code.

d. Executes post-installation InstallScript events (for example, OnEnd).

See Also
Overview of ISSetup.dll

Merge Module Projects

InstallShield 2020

Merge modules allow you to add existing pieces of functionality to your installation. For example, if your application
requires the VB Run-Time DLL, you can add Microsoft’s Visual Basic Virtual Machine module to your setup application.
Traditionally, you would have to create registry entries, set the target folders, custom actions and any other necessary
steps yourself. With merge modules, all you need to do is associate an existing merge module with your installation and
move on to your next task.

InstallShield 2020 User Guide ISP-2600-UG00 293

Chapter 2 Getting Started
Working with Projects

InstallShield provides you with the ability to create your own merge modules to distribute with your installations or give
away to other developers. This can be useful if you are going to include certain pieces of functionality in all of your
installation projects. Rather than having to recreate that part of the installation every time, you can create it once as a
merge module and then associate that module with all of your installation projects.

InstallScript Custom Actions in Merge Module Projects

Merge modules can contain InstallScript custom actions. However, you must manually create the Module**Sequence
table entries to make sure that the custom actions are merged properly.

How Merge Modules Work

When a merge module is associated with an installation project, it is merged into the .msi database at build time. As a
result, you are merging two distinct projects (your new installation and the existing merge module) into one .msi file. The
merge module behaves like a component in that it is not installed unless the feature with which it is associated is installed.
Therefore, if you have a feature that requires VB run-time DLLs, and that feature is not selected for installation, the VB
merge module will not be installed.

See Also
Designing Merge Modules

MSI Database and MSM Database Projects

InstallShield 2020

The MSI Database and MSM Database project types allow you to edit Windows Installer installation databases and merge
module databases directly, rather than working through an intermediate project format (.ism file). These project types
extend the Direct Editor functionality to include different views that are supported in standard installation and merge
module projects. The views that are supported in these project types are intended to function as they do for an .ism
project.

Project • There is no string entry or path variable support in an MSI Database or MSM Database project.

You can directly edit an existing .msi file or .msm file, or directly create a new database by opening a new MSI Database or
MSM Database project. The data in this file should match what you would get if you created a blank Basic MSI or Merge
Module project and built a database from that project.

See Also
Adding Files in Direct Edit Mode
Adding Merge Modules in Direct Edit Mode

InstallScript Object Projects

InstallShield 2020

Using InstallShield objects, you can easily install key Windows technologies. To install a technology, simply include the
corresponding InstallShield object in your installation. If a technology is required by a particular component, you can
associate the corresponding InstallShield object with the feature.

294 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

See Also
Creating InstallScript Objects

QuickPatch Projects
InstallShield 2020

A QuickPatch project is a specific type of project recommended for installation authors who want to ship small, single
updates to their users. Changes that are more extensive such as adding custom actions and changing .ini data typically
require a standard patch.

QuickPatch authoring provides a simple alternative to creating a patch configuration in the Patch Design view, even
though it provides less customization. Fundamentally, both patch creation methods produce the same deliverable types:
.msp and .exe files.

With a QuickPatch, you can do any of the following:

• Add new files to the original installation or an earlier QuickPatch.

• Delete files in the original installation.

• Delete files that were added with a previous QuickPatch.

• Perform the same set of above operations on registry entries.

• Remove custom actions that were included with the original installation but that do not apply to the current
QuickPatch project.

The creation of a QuickPatch project always begins with the Create New QuickPatch Wizard. After you have completed the
wizard, you can configure the QuickPatch project settings once the project opens in InstallShield.

See Also
Upgrades Overview
Determining the Best Upgrade Solution
Working with Upgrades, Patches, and QuickPatch Projects

Transform Projects
InstallShield 2020

A transform (.mst file) is a simplified Windows Installer database that contains the differences between two .msi databases.
Transforms enable an administrator to apply modified settings to a database when deploying an installation package.

InstallShield has a transform project type that enables you to edit .msi packages without having to convert them to an
InstallShield (.ism) project. You can save the changes made as a transform (.mst) file.

When you create a transform project or open a transform in InstallShield, the Open Transform Wizard launches to gather
information about the base .msi file and any additional transform files that you want applied to the base .msi file.

See Also
Editing Transforms

InstallShield 2020 User Guide ISP-2600-UG00 295

Chapter 2 Getting Started
Working with Projects

Using Projects
InstallShield 2020

InstallShield allows you to create, edit, upgrade, and save numerous project types—from installation projects to
InstallShield object projects that allow you to reuse functionality within InstallShield.

The pages in this section cover a variety of topics, including how to create a particular project type, how to create project
templates, and what to expect when you upgrade from a different InstallShield product.

See Also
Working with Projects
Project Types

Creating New Projects

InstallShield 2020

There are a number of ways to create a new InstallShield project.

Task To create a new project, do one of the following:

• Click the New Project button on the toolbar or on the InstallShield Start Page.

• Press Ctrl+N.

• On the File menu, click New.

Any of these steps launches the New Project dialog box, from which you can select the project that you want to create.

Using a Template to Create a New Project

Your project templates are listed in the New Project dialog box on the appropriate tab. For more information, see Basing
New Projects on Templates.

Creating a Project From Within Microsoft Visual Studio

You can create an InstallShield project from within the Microsoft Visual Studio workspace. For more information, see
Creating InstallShield Projects in Microsoft Visual Studio.

See Also
Project Types

Opening Projects
InstallShield 2020

Task To open an existing InstallShield project, do one of the following:

• Click the Open Project button on the toolbar.

296 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

• On the File menu, click Open. In the Open dialog box, navigate to the project file.

• Press Ctrl+O.

• Click the Open an existing project link or click a recently opened project link on the InstallShield Start Page.

• Double-click a project file (.ism) on the desktop or in Windows Explorer.

With the exception of clicking a specific file or file link, all of the above options launch the Open dialog box, which enables
you to browse to your project file.

See Also
Opening Projects from Source Code Control
Converting or Importing Visual Studio Projects into InstallShield Projects
Opening Patch Creation Properties Files in Direct Edit Mode

Opening Projects from Source Code Control

InstallShield 2020

An option on the Open dialog box enables you to get the latest version of a project folder from your source control
application.

Task To open a project from source control:

1. On the File menu, click Open. The Open dialog box opens.

2. Click the Source Control button. A login dialog box for your source control program opens.

3. Log on to your source control program and browse to your project folder or database.

InstallShield gets the latest versions of every file in that project to a working directory.

Note • If you do not have a source control application on the system that has InstallShield, the Open dialog box does not
display the Source Control button.

See Also
Opening Projects

Opening Patch Creation Properties Files in Direct Edit Mode

InstallShield 2020

You can open a previously created patch creation properties file from the Open dialog box.

Task To open a patch creation properties (.pcp file):

1. On the File menu, click Open. The Open dialog box opens.

2. In the Files of type list, click Patch Creation Properties Files (*.pcp).

InstallShield 2020 User Guide ISP-2600-UG00 297

Chapter 2 Getting Started
Working with Projects

3. Select the .pcp file you want to edit and click Open.

Your patch project file opens in the Direct Editor.

See Also
Opening Projects

Opening Windows Installer Packages

InstallShield 2020

InstallShield provides the option to either edit MSI packages directly in the IDE in Direct Edit Mode or convert it to an
InstallShield project (.ism), and then edit it as a Basic MSI project in the IDE.

Note • Some functionality may be limited when editing an MSI package in Direct Edit Mode.

Task To open an MSI package in Direct Edit Mode of the IDE:

1. Click the Open Project button on the toolbar. A browse dialog opens.

2. Select Windows Installer Packages (*.msi) from the Files of Type list.

3. Select the MSI package that you want to open.

4. Ensure that the Open as field is set to Auto, and click Open.

Note • By default, the IDE opens an MSI package in Direct Edit Mode.

The Open MSI/MSM Wizard can convert an existing Windows installer (.msi) package to an InstallShield project (.ism) file,
and open the new project to modify in the IDE.

Note • You can also open Patch Creation Project files (.pcp files) in InstallShield and edit them in the Direct Editor.

Opening Merge Modules

InstallShield 2020

The Open MSI/MSM Wizard can convert an existing Windows Installer merge module (.msm file) to an InstallShield project
(.ism) file, and open the new project in the InstallShield IDE.

Task To launch the Open MSI/MSM Wizard:

1. Click the Open Project button on the toolbar. A browse dialog opens.

2. Select Windows Installer Modules (*.msm) from the Files of Type list.

3. Go to the merge module and click Open.

298 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

The Open MSI/MSM Wizard prompts for specific information about the project you are creating, and then opens your new
merge module project in the IDE.

Opening Object Projects

InstallShield 2020

You can open an object project (.ipo or .ipr) that you created using InstallShield Professional. When you open this project in
InstallShield, it is migrated to a merge module (.msm) project.

Placing Merge Modules in the Redistributables View

InstallShield 2020

To associate your merge module with InstallShield installation projects, you can automatically place your merge module
project in the Modules folder so it is available in the Redistributables view for use in setup projects.

Task To automatically place your merge module project in the Modules folder:

Select the “Add to local merge module catalog” option in the Merge Module Options panel of the Release Wizard.

Saving Projects
InstallShield 2020

When you create a new project, it is saved automatically with the name and location that you provide in the New Project
dialog box.

InstallShield enables you to save a copy of the open project as a template or as a new project with a different name and
location.

See Also
Project Templates

Saving a Project with a New Name and Location

InstallShield 2020

When you save your project with a new name and location, a copy of the renamed project file and all of its associated files
and folders are saved in the new location. The next time that you save your project, all changes are saved to this new
location.

Task To save your project with a new name and location:

1. On the File menu, click Save As. The Save As dialog box opens.

2. In the Save in box, select the appropriate location.

InstallShield 2020 User Guide ISP-2600-UG00 299

Chapter 2 Getting Started
Working with Projects

3. Select or clear the Create ‘Project Name’ subfolder and save the project in the created folder check box as
appropriate. In both cases, a <Project Name> subfolder is created in the Project Location box (on the File Locations
tab of the Options dialog box).

If you select the Create ‘Project Name’ subfolder and save the project in the created folder check box, the project
file (.ism) is saved in the <Project Name> subfolder. If you clear the check box, the project file is saved in the location
specified in the Project Location box.

4. If the new project’s GUID should be different than the GUID of the original project, select the Create and assign a new
project GUID to the saved project check box. If the new project’s GUID should be the same GUID of the original
project, clear this check box.

5. To use the name that you specified in the File name box as the value for the Product Name setting (in the General
Information view) of the new project, select the Update the project settings appropriately based on the new
project name check box. If the new project’s Name property should be the same as that of the original project, clear
this check box.

Note • When you save a project with external dependencies, such as InstallScript files, your new project points to the original
copies of these files. Duplicate copies are not made. Therefore, before you delete your original project, ensure that you do not
delete any files that may be used by the new project.

See Also
Save As Dialog Box

Converting from One Project Type to Another Project Type

InstallShield 2020

InstallShield offers support for converting some types of projects to other types of projects.

Table 2-6 • Project Converters

Project Converter How-To Information

Convert Basic MSI project to See Converting a Basic MSI Project to an InstallScript MSI Project.
InstallScript MSI project

Convert InstallScript MSI project to See Converting an InstallScript MSI Project to an InstallScript Project.
InstallScript project

Convert InstallScript project to Use Repackager to convert an InstallScript project to a Basic MSI project.
Basic MSI project

Edition • Repackager is included with AdminStudio.

Convert InstallScript MSI project to Use Repackager to convert an InstallScript MSI project to a Basic MSI project.
Basic MSI project

Edition • Repackager is included with AdminStudio.

300 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

Table 2-6 • Project Converters

Project Converter How-To Information

Convert InstallScript project to This conversion is a two-step process:

InstallScript MSI project
1. Use Repackager to convert an InstallScript project to a Basic MSI project.

2. Use InstallShield to convert the Basic MSI project to an InstallScript MSI

project. See Converting a Basic MSI Project to an InstallScript MSI Project.

Edition • Repackager is included with AdminStudio.

Convert Visual Studio setup project See Converting or Importing Visual Studio Projects into InstallShield Projects.
to InstallShield Basic MSI project

Convert Visual Studio merge module See Converting or Importing Visual Studio Projects into InstallShield Projects.
project to InstallShield Merge
Module project

See Also
Project Types

Converting a Basic MSI Project to an InstallScript MSI Project

InstallShield 2020

Converting your Basic MSI project to an InstallScript MSI project allows you to take full advantage of the scripting
capabilities that are available in InstallShield.

Caution • This conversion is irreversible. After you convert your Basic MSI project to an InstallScript MSI project and save it,
you cannot easily convert your project back to a Basic MSI project. Before you convert your Basic MSI project, it is generally
good practice to first create a back-up copy of it.

Converting Projects

Task To convert your Basic MSI project to an InstallScript MSI project:

1. Open your Basic MSI project.

2. On the Project menu, point to Project Converters, and click Convert to InstallScript MSI project.

Converting Dialogs
Because an InstallScript MSI project uses resource-based dialogs—instead of using the Windows Installer dialog–related
tables—no Windows Installer–based dialogs from your original project are available after the migration. You need to
manually add any custom dialogs.

InstallShield 2020 User Guide ISP-2600-UG00 301

Chapter 2 Getting Started
Working with Projects

Your converted installation project contains the default InstallScript MSI dialogs. To review the default dialogs, go to the
InstallScript view and view the dialogs displayed in the OnFirstUIBefore and OnFirstUIAfter events.

Converting an InstallScript MSI Project to an InstallScript Project

InstallShield 2020

InstallScript MSI projects created using InstallShield, InstallShield DevStudio, or InstallShield Developer can be easily
converted to the InstallScript project type.

Task To convert an existing InstallScript MSI project to an InstallScript project:

1. Open the InstallScript MSI project.

2. On the Project menu, point to Project Converters, and click Convert to InstallScript project.

GUIDs
InstallShield 2020

GUID stands for globally unique identifier. A GUID is 128 bits long, and the algorithm used to generate a GUID guarantees
each GUID to be unique. Because GUIDs are guaranteed to be unique, they can be used to identify COM classes, Product
Codes, and various other codes.

For example, after a product is installed, a key is created under

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall and is named after the installation’s
Product Code. At one time, this key was named after the Product Name. However, this caused a potential conflict. If two
installations were installed on the same machine, and both shared the same Product Name, they would also share the
same registry key. Because a GUID is now used, it guarantees that this conflict does not occur.

An example GUID is {5D607F6A-AF48-4003-AFA8-69E019A4496F}. Any letters in a GUID must be in uppercase.

GUIDs in Your Project

When you create an installation project, there are a number of different GUIDs that are relevant to your project.

Table 2-7 • GUIDs

GUID Name Description

Product Code The product GUID uniquely identifies your application.

Package Code The package code uniquely identifies your installation package.

Project • This GUID is available in the following project types: Basic MSI,
InstallScript MSI, and QuickPatch.

302 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

Table 2-7 • GUIDs (cont.)

GUID Name Description

Package GUID The package GUID uniquely identifies the installation package in the
Advanced UI or Suite/Advanced UI installation.

Project • This GUID is available in Advanced UI and Suite/Advanced UI

projects.

Patch GUID The patch GUID uniquely identifies a patch package.

Project • This GUID is available in the following project types: Basic MSI,
InstallScript MSI, and QuickPatch.

Suite GUID The Suite GUID uniquely identifies your Advanced UI or Suite/Advanced
UI installation.

Project • This GUID is available in Advanced UI and Suite/Advanced UI

projects.

Upgrade Code or Upgrade GUID The upgrade GUID uniquely identifies a family of products for upgrade
purposes. It is important for major upgrades.

Project • This GUID is available in the following project types: Basic MSI,
InstallScript MSI, and QuickPatch.

Project • For information on when you need to change GUIDs in a Basic MSI or InstallScript MSI project, see Major Upgrade vs.
Minor Upgrade vs. Small Update.

Changing the Default Project Location

InstallShield 2020

All new projects are saved by default in the following location:

C:\InstallShield 2020 Projects

To specify a new default location for your installation projects, use the File Locations tab on the Options dialog box.

Note • Although this folder is used for all new installation projects, any existing projects remain in the previous location.

InstallShield 2020 User Guide ISP-2600-UG00 303

Chapter 2 Getting Started
Working with Projects

Reusing Project Elements

InstallShield 2020

You can save several elements in your project to reuse in another project. In some cases, the data must be saved to an
intermediary file and in others you can export it directly to another .ism file. The manner in which you can reuse each
element is described below.

Entire Projects
By saving a project as an InstallShield project template, you can create a project from the template that is almost identical
to the original project.

Registry Entries
When you export registry entries to a REG file, you can import that file into another component’s registry data in the same
project or an entirely different one.

String Entries
You can export a project’s string entries for a specific language to a tab-delimited text file. Typically, you would send the
text file out for translation and then import the string entries back into the project for another language. However, you
could also add the exported string entries to another project by importing the file into the other project.

End-User Dialogs
You can save all of your dialogs to an .rc file, export them individually to InstallShield dialog template files, or export them
directly to another project.

Components
To export a component to another project, right-click on the component and select Export Components Wizard. Follow
through wizard and the component and all of its data are added to the specified project.

Custom Actions
You can export a custom action to another project by right-clicking on the custom action in the Custom Actions explorer
and clicking Export. The Custom Actions explorer is in the Custom Actions and Sequences view (in Basic MSI, InstallScript
MSI, MSI Database, and Transform projects) and the Custom Actions view (in DIM, Merge Module, and MSM Database
projects).

Using a Repository to Share Project Elements

InstallShield 2020

InstallShield supports the use of repositories. A repository is a collection of common elements that can be shared and
reused in different installation projects. Elements that can be stored in a repository include:

• End-user dialogs

• InstallScript files

• Merge modules

304 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

• Project templates

• SQL scripts

• System searches

Repositories provide you with the ability to reuse project elements in multiple projects and strive for consistency. They also
save you from having to duplicate work. For example, if many of the installations for your organization’s products include a
particular custom dialog, you can create that custom dialog once and then publish it to your repository. Any time you want
to use that dialog in another installation, simply add the dialog from your repository to your project.

Two types of repositories are available in InstallShield:

• Local repository—A local repository is your own collection of installation elements that you want to be able to reuse in
multiple projects. A local repository is stored on your local machine, and it is not available to other installation
authors.

• Network repository—A network repository is a collection of installation elements that multiple installation authors
can access and reuse in their projects as needed. A network repository fosters collaboration among installation
authors; it is stored on a network. For information on configuring a network repository, see Setting up a Network
Repository.

Edition • Network repositories are available in the Premier edition of InstallShield only. Local repositories are available in
both the Premier and Professional editions of InstallShield.

See Also
Publishing a Dialog (.isd) File to a Repository
Publishing InstallScript Files (.rul and .h) to a Repository
Publishing a Merge Module to a Repository from Within a Merge Module Project
Publishing Project Templates to a Repository
Publishing SQL Script Files to a Repository
Publishing a System Search to a Repository

Setting up a Network Repository

InstallShield 2020

Edition • Network repositories are available in the Premier edition of InstallShield only.

To configure a network repository, or to change the network repository settings, use the Repository tab on the Options
dialog box.

Project Templates
InstallShield 2020

A project template contains all of the default settings and design elements that you want to use as a starting point when
you create an installation project or merge module project.

You can open a template in InstallShield and edit it as you would a project. To create a template, save any project as a
template. For more information, see Creating Project Templates.

InstallShield 2020 User Guide ISP-2600-UG00 305

Chapter 2 Getting Started
Working with Projects

For instructions on starting a new project based on a template, see Basing New Projects on Templates.

InstallShield project templates serve only as a starting point for new projects. After you have created a project based on a
template, there is no link between the current project and the existing template. If you change an element in the template,
it does not affect the project that you created based on that template. However, you can modify the template and create
another project based on the updated version of the template.

See Also
Creating Project Templates
Reusing Project Elements

Creating Project Templates

InstallShield 2020

The procedure for creating a template file varies, depending on whether you are creating a template for a project type that
uses .ism project files (Basic MSI, InstallScript, InstallScript MSI, Merge Module), or for a project type that uses .issuite
project files.

Creating a Project Template File for Projects that Use .ism Project Files
You can create a project template from any .ism project file; this includes installation projects and merge module projects.
When you create a template from an .ism project file, the template file has an .ist file extension.

Task To create a template (.ist) from an .ism project file:

1. Edit the project to include the desired default settings, user interface, features, and so on.

2. On the File menu, click Save As. The Save As dialog box opens.

3. In the Save As type box, select InstallShield Template (*.ist).

4. Type a file name (with the .ist extension) and select a location for the new template. The recommended location for
templates is a Templates folder within the project location folder.

5. Click OK.

You can open the template in InstallShield and make additional changes. You can use the final version of your template to
create a new project.

Creating a Project Template File for Projects that Use .issuite Project Files
You can designate any Advanced UI or Suite Advanced UI project (.issuite) to be a template. Project files and template files
for these project types have the same file extension: .issuite.

Task To designate that an .issuite project file is a template file and make the template available for selection in the New
Project dialog box:

Right-click in the All Types tab on the New Project dialog box and then click Add New Template. InstallShield lets you
browse to the .issuite file that you want to use as a template, and it adds a new icon for it to the All Types tab.

306 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with Projects

Basing New Projects on Templates

InstallShield 2020

To save time, you can base multiple projects on a single project template that contains default settings and design
elements. The template can be stored somewhere on your system. It can also be stored in a repository.

Task To create a project using a template as a starting point:

1. On the File menu, click New. The New Project dialog box opens.

2. Click the All Types tab.

3. Select the template that you want to use.

Note • To display templates that are stored in a repository, right-click in the box of project types and ensure that Show
Templates in Repository is enabled. To add a template to the tab, right-click in the box of project types and then click
Add New Template. Then browse to the desired template file (.ist file).

4. In the Project Name box, type a name for your project.

5. In the Location box, type the path to the directory where you want to store your template, or click the Browse button
to find it.

6. Click OK. InstallShield creates the new project based on the template that you selected, and the new project is opened
in InstallShield.

The new project is virtually identical to the project template, except that InstallShield generates a new product code (for
installation projects), package code, and upgrade code (for Windows Installer–based installation projects), and a module
ID for merge module projects.

See Also
Using a Repository to Share Project Elements

Publishing Project Templates to a Repository

InstallShield 2020

If you have an existing template that you would like to reuse for other projects or share with other users, you can publish it
to a repository.

Task To publish a template to a repository:

1. On the File menu, click New. The New Project dialog box opens.

2. Click the All Types tab.

3. Right-click the template that you want to publish and then click Publish Template to Repository. The Publish
Wizard opens.

4. Complete the panels in the Publish Wizard.

InstallShield 2020 User Guide ISP-2600-UG00 307

Chapter 2 Getting Started
Project Assistant

After you have created a project that is based on a template in your repository, there is no link between the current project
and the existing repository template. If you make a change to the template and then republish it to the repository, it does
not affect the project that you created based on the template. However, you can create a new project based on the
updated version of the template in the repository.

See Also
Basing New Projects on Templates
Using a Repository to Share Project Elements

Sample Projects
InstallShield 2020

A number of example project (.ism) files have been included with the InstallShield installation. These projects are stored in
the Samples folder. The default location is:

C:\Program Files\InstallShield\2020\Samples

These projects show you how a certain aspect of an installation project—such as release flags—can be implemented.

Project Assistant
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

InstallShield provides a Project Assistant to help you quickly and easily build a basic installation project. The Project
Assistant provides a framework of installation project tasks to guide you through the project creation process and provides
pertinent information along the way.

How the Project Assistant Works

When you create a new installation project or transform, the Project Assistant view automatically opens.

Information that you enter in the Project Assistant is saved directly to the underlying project file. Therefore, you can switch
to the Installation Designer (described below) and view or modify your information using the full power of the InstallShield
Installation Development Environment (IDE). In this way, you can use the Project Assistant to create the foundation for a
more advanced installation where you use the Installation Designer, as needed, to customize your installation.

Integration with the Installation Designer

The Installation Designer tab displays all of the views in the InstallShield interface that are available for your project type.
Here you can add more complex and powerful elements to your installation project. You can create your installation
project using the Project Assistant and then use the Installation Designer to fine-tune project elements.

308 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

The Installation Designer and the Project Assistant run simultaneously. Any changes that you make in one are reflected
instantly in the other. For example, if you remove a feature while using the Installation Designer tab, that feature is no
longer present in your installation project and does not appear in the Project Assistant.

See Also
Using the Project Assistant
Showing or Hiding the Project Assistant

Using the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

When you create a new installation project, the Project Assistant is automatically displayed. The home page has an
installation design diagram to help you visualize the steps that are involved in creating an installation. You can work within
the Project Assistant to create your project or click the Installation Designer tab to further define a basic installation
project.

See Also
Project Assistant

Using the More Options, Other Places, and Help Links Sections in the Project
Assistant
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The left column on each Project Assistant page contains one or more lists of links to help you in creating your installation
and finding information:

• More Options—Provides additional configuration options relating to the specific area on the Project Assistant page.
These are less common options that complete the functionality of the Project Assistant.

InstallShield 2020 User Guide ISP-2600-UG00 309

Chapter 2 Getting Started
Project Assistant

• Other Places—The view in the Installation Designer that corresponds to the current Project Assistant page. Clicking
the link launches the full Installation Designer and activates that view.

• Help Links—This list provides links to help topics pertinent to the current Project Assistant page.

See Also
Project Assistant

Navigating in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

Task To navigate from one page of the Project Assistant to another, do one of the following:

• To navigate directly to a specific page, click the appropriate icon in the navigation bar at the bottom of the page.

• To follow the Project Assistant steps sequentially, do one of the following:

• Click the Next or Back arrow buttons to move forward or backward.

• Press CTRL+TAB to move to the next page and CTRL+SHIFT+TAB to move to the previous page.

• To move back to the Home page and view the installation design diagram, click the Home button on the navigation
bar.

See Also
Project Assistant

Opening the Installation Designer

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

310 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

The Installation Designer tab displays the views in the InstallShield Installation Development Environment (IDE). You can
use this tab to add more complex and powerful elements to your installation project than you can with the Project
Assistant. To open a view in the Installation Designer, click the Installation Designer tab.

Note • The Installation Designer and the Project Assistant run simultaneously. Any changes that you make in one are
reflected instantly in the other.

See Also
Project Assistant

Showing or Hiding the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The Project Assistant provides a simplified view of installation project tasks. You can perform all of the same tasks—and
also further customize your project—through the Installation Designer.

If you prefer to create your InstallShield project entirely from within the Installation Designer, you can hide the Project
Assistant so that its tab is not displayed in the InstallShield interface. Similarly, if the Project Assistant is hidden, you can
choose to display it.

Task To show or hide the Project Assistant:

On the View menu, click Project Assistant.

When the Project Assistant command has a check mark next to it, the tab for the Project Assistant is shown in the
InstallShield interface. When the check mark is not displayed, the Project Assistant is hidden.

If the Project Assistant command does not have a check mark, the Installation Designer becomes the default tab whenever
you create a new project.

See Also
Project Assistant

InstallShield 2020 User Guide ISP-2600-UG00 311

Chapter 2 Getting Started
Project Assistant

Application Information Page

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The Application Information page is where you specify general information about the application your project will install,
including the application’s name and version, your company’s name and Web address, and the application icon.

See Also
Application Lifecycle
Add or Remove Programs in the Control Panel
Company Name and Product Name in Your Installation

Add or Remove Programs in the Control Panel

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The Add or Remove Programs in the Control Panel provides a list of the applications that are installed on a computer
system. You can view information about particular programs and add, modify, or remove programs from Add or Remove
Programs.

The information you provide in the Application Information page of the Project Assistant is used to populate information
for your application’s Add or Remove Programs information when your application is installed.

See Also
General Information View

312 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

Company Name and Product Name in Your Installation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

Your company name and product name are used in several places in your installation project.

How Your Company Name Is Used Throughout Your Installation Project

Your company name is used to set the default installation directory for your application. It is also used in Add or Remove
Programs in the Control Panel for your application on the end user’s system.

How Your Product Name Is Used Throughout the Installation Project

Your product name is used in your application’s entry in Add or Remove Programs (in the support information link) on the
target system. It is also used in setting the default installation directory.

See Also
General Information View
Setting a Destination Folder for the Component’s Files

Installation Requirements Page

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The Installation Requirements page enables you to easily set installation requirements for the target system. For example,
if your application requires a specific operating system in order to run properly, you can indicate that in the first section of
this page.

See Also
Specifying Operating System in the Project Assistant
Creating Custom Installation Requirements
Modifying the Run-Time Message for Software Requirements
When Does the Installation Check for Requirements?

InstallShield 2020 User Guide ISP-2600-UG00 313

Chapter 2 Getting Started
Project Assistant

Specifying Operating System in the Project Assistant

InstallShield 2020

Project • The ability to specify operating in the Project Assistant is available in the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

When you specify operating on the Installation Requirements page of the Project Assistant, InstallShield creates launch
conditions. These conditions are added to the LaunchCondition table of your .msi file; you can view and edit this table in
the Direct Editor.

How InstallShield Creates the Operating System Launch Conditions

When you specify operating on the Installation Requirements page, you are essentially excluding operating systems that
do not support your application.

For example, if you select only the check box for the latest Windows operating system, InstallShield creates a launch
condition to exclude the operating systems that you did not select on the Installation Requirements page. With this type of
launch condition, future versions of Windows operating systems are supported automatically because they are not
excluded in the launch condition.

See Also
Creating Custom Installation Requirements
When Does the Installation Check for Requirements?
Settings for Platforms and Platform Suites

When Does the Installation Check for Requirements?

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

To ensure that the required software or operating system is present on the target system, the installation checks for these
requirements in the beginning of the installation before any files are transferred.

314 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

Modifying the Run-Time Message for Software Requirements

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

If your installation has software requirements and the target system does not have the selected software, a run-time
message is displayed during the installation. You can modify the message that is displayed.

Task To modify the run-time message:

1. In the Project Assistant, open the Installation Requirements page.

2. Select Yes in answer to the software requirements question.

3. Select the software that your application requires. The default run-time message is displayed to the right.

4. Click the run-time message to edit it.

See Also
Installation Requirements Page

Creating Custom Installation Requirements

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

You can create customized installation requirements in the Installation Designer by using the product’s Install Condition
setting. For this setting, you can create conditions that the Windows Installer must evaluate before launching the
installation. For more information, see Setting Product Conditions.

You can also use the System Search Wizard to search for a particular file, folder, registry key, or .ini value on the target
system. The System Search Wizard enables you to create a condition with the search value.

See Also
Conditional Statement Syntax
Specifying Operating System in the Project Assistant

InstallShield 2020 User Guide ISP-2600-UG00 315

Chapter 2 Getting Started
Project Assistant

Installation Architecture Page

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The Installation Architecture page lets you specify the features you want your installation program to display to the end
user. A feature is the smallest separately installable piece of your product from the end user’s standpoint. Individual
features are visible to end users when they select a Custom setup type during installation.

Note • Features can contain subfeatures, subsubfeatures, and so forth, to as many levels as your installation program
requires.

See Also
Creating Installations with Multiple Features
Determining Whether to Create a Multiple-Feature Installation
Default Features
Defining Feature Hierarchy

Adding Features in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

Task To add a feature:

1. In the Project Assistant, open the Installation Architecture page.

2. Select Yes in answer to Do you want to customize your Installation Architecture?

3. To add a main feature, click the Installation Architecture explorer. To add a subfeature, click the feature that you
want to be the parent feature, and then click New. The Project Assistant creates the new feature.

316 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

4. Name the feature or click Rename to name it later.

Determining Whether to Create a Multiple-Feature Installation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

Features are the building blocks of an installation, from the end user’s perspective. Because of this, features should
represent distinct and discrete pieces of functionality within your installation.

If your application has different blocks of functionality, you should create a multiple-feature installation. For example, if
your installation contains your application (.exe file) and a help library (.hlp file), your installation project should contain at
least two features—one for each piece of functionality.

To learn more about creating a multiple-feature installation within the Project Assistant, see Creating Installations with
Multiple Features.

See Also
Creating Features

Creating Installations with Multiple Features

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

You can create an installation with multiple features using the Project Assistant or in the Installation Designer (IDE).

Task To create a multiple-feature installation in the Project Assistant:

1. In the Project Assistant, open the Installation Architecture page.

2. Select Yes to indicate you want to customize your installation architecture.

3. Click the Installation Architecture explorer and then click New. The Project Assistant creates a new feature.

InstallShield 2020 User Guide ISP-2600-UG00 317

Chapter 2 Getting Started
Project Assistant

4. Press F2 or right-click the feature and select Rename to provide a name for the new feature.

5. To add another feature at the same level, click the Installation Architecture explorer and then click New. To create a
subfeature, click the feature that you want to be the parent feature, and then click New. The Project Assistant creates
the new feature.

6. Continue adding features and subfeatures as needed.

To learn about working with features in the Installation Designer, see Creating Features.

See Also
Determining Whether to Create a Multiple-Feature Installation
Features View

Default Features
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The default feature concept exists only in the Project Assistant. All resources (for example, files or registry data) that are
added to an installation project need to be associated with a feature. If a resource is not associated with a feature, it is not
installed to the target system at run time.

Using a default feature simplifies the authoring experience in the Project Assistant. You do not need to worry about
associating project resources with a feature to ensure that they are installed. When you add registry data, create new
shortcuts, or add files when All Application Data is selected, all of these resources are added to the default feature.

Setting the Default Feature

You can set the default feature in the Installation Architecture page of the Project Assistant.

What Happens If There Are No Features or No Default Feature Is Selected?

When you navigate to the Installation Architecture page or add data to the Application Files, Application Shortcuts, or
Application Registry pages, InstallShield selects the first root feature as the default feature. If there are no features,
InstallShield creates one silently.

See Also
Features View

318 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

Defining Feature Hierarchy

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

Top-level features are the highest level in the feature hierarchy. Top-level features might include the application you want
to install, a help library feature, and a sample projects feature.

Beneath the top-level features are subfeatures or child features. This is a feature that is dependent upon another feature
for installation purposes. If the parent (or top-level) feature is not installed to the target system, the child feature is not
installed.

See Also
Creating Features

Application Files Page

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The Application Files page lets you specify the files you want to associate with each of your features.

See Also
Adding Files to a Fixed Folder Location
Viewing Additional Predefined Folders
Adding Files to Features in the Project Assistant
Removing Files from Features in the Project Assistant

Adding Files to Features in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 319

Chapter 2 Getting Started
Project Assistant

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

Task To add a file to a feature:

1. In the Project Assistant, open the Application Files page.

2. In the feature list at the top of the page, select the feature that should contain the file.

3. In Destination Computer explorer, select the folder to which you want to add the file.

4. Click Add Files. The Open dialog box opens.

5. Browse to the file that you want to add.

6. Click Open to add the file to the selected feature. The message “The file you have added ... may have dependencies”
appears.

7. Click Yes if you want to have those dependencies automatically added to your installation project.

Removing Files from Features in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

Task To remove a file from a feature:

1. In the Project Assistant, open the Application Files page.

2. Click the file you want to remove and press Delete.

Adding Files to a Fixed Folder Location

InstallShield 2020

Project • This information applies to the following project types:

320 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

If you know exactly where you want the installation to install your project files on the target system, you can hard-code a
fixed folder destination.

Task To add files to a fixed folder location in the Project Assistant:

1. In the Project Assistant, open the Application Files page.

2. Right-click Destination Computer and click New Folder.

3. For the new folder’s name, type the drive in which the destination is located—for example, C:.

4. Beneath the drive letter folder, further define the destination path by adding subfolders.

See Also
Destination Folders

Viewing Additional Predefined Folders

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The Project Assistant’s Application Files page displays the more commonly used predefined folders. You can view and hide
predefined folders in this page.

Task To display additional predefined folders:

1. In the Project Assistant, open the Application Files page.

2. Right-click Destination Computer and click Show Predefined Folder.

3. In the list of predefined folders, select the folder you want to display.

Tip • To hide predefined folders, deselect them in the list of predefined folders.

See Also
Destination Folders

InstallShield 2020 User Guide ISP-2600-UG00 321

Chapter 2 Getting Started
Project Assistant

Application Shortcuts Page

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The Application Shortcuts page lets you specify shortcuts for your application’s files on the target system’s desktop or Start
menu. By default, this page displays a shortcut for each executable file that you have added to your project through the
Project Assistant. You can delete these, and add shortcuts to other files that you have included in your installation project.

See Also
File Extensions
Creating Shortcuts to Files That Are Not Included in the Installation
Modifying a Default Shortcut in the Project Assistant
Associating a Shortcut’s Target with a File Extension in the Project Assistant

File Extensions
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

File name–extension associations, or file associations, are registry settings that tell Windows what application to use to
open files of a certain type. For example, Windows typically opens text files (files with the .txt extension) with Windows
Notepad, and opens bitmap files (files with the .bmp extension) with Microsoft Paint.

A file extension allows someone to identify the type of file without accessing the file. A suffix (.abc) is appended to the file
name. The file extension is also useful in that another application can recognize whether the application can work with the
file (for example, open the file or modify it), based on the extension.

In InstallShield, you can register your own file extensions by configuring the settings in the Advanced Settings area of a
component in the Components view or the Setup Design view. Registering your file extension instructs the target
machine’s operating system to use your application to open files with your file extension when an end user clicks on a file.

See Also
Registering a File Extension

322 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

Creating Shortcuts to Files That Are Not Included in the Installation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

You can configure your installation to create a shortcut that points to a file that already exists on the target system. This file
does not have to be included in your installation project.

Task To create a shortcut to a file that is not included in the installation:

1. Open the Installation Designer.

2. In the View List under System Configuration, click Shortcuts.

3. In the Shortcuts explorer, right-click the destination directory that you want to contain the shortcut and then click
New Shortcut to Preexisting File. The Browse for Shortcut Target dialog opens.

4. Browse to the target file’s location and enter the file’s name in the File Name setting.

5. Click OK.

6. Configure the shortcut’s settings.

See Also
Creating Shortcuts

Modifying a Default Shortcut in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

InstallShield 2020 User Guide ISP-2600-UG00 323

Chapter 2 Getting Started
Project Assistant

Task To modify a default shortcut:

1. In the Project Assistant, open the Application Shortcuts page.

2. Select the shortcut that you want to modify.

3. Make the required changes as needed.

Associating a Shortcut’s Target with a File Extension in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

You can associate a shortcut’s target with a file extension. When you do this, Windows will use the target file to launch files
with the specified file extension. For example, if you enter .txt, when the end user opens a .txt file, the target file of this
shortcut is launched to open the .txt file.

Task To associate a shortcut’s target with a file extension:

1. In the Project Assistant, open the Application Shortcuts page.

2. Click the shortcut to activate the shortcut options.

3. Select the Associate shortcut with file extension option.

4. Type the file extension that you want to associate with this shortcut’s target—for example, txt. You can add multiple
extensions by separating them with a comma.

Application Registry Page

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The Application Registry page lets you specify any registry data that your application requires.

324 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

See Also
Updating the Registry
Associating Registry Data with Features
Using Variable Data Types in Registry Data
Application Paths
Configuring Registry Data in the Project Assistant
Modifying Registry Data Values in the Project Assistant

Updating the Registry

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The registry is a database for your computer’s configuration information. Information included in a computer’s registry
includes user profiles, hardware and software installed on the computer, and property settings.

How Do I Know What Registry Data My Application Requires?

The application developer should be able to provide registry information for you. Specifically, you will need to know if the
application you are installing requires any user-specific (HKEY_CURRENT_USER) or machine-specific
(HKEY_LOCAL_MACHINE) settings.

The developer can provide a .reg file that you add to your installation. InstallShield allows you to import .reg files into your
installation project.

Configuring Registry Data in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

InstallShield 2020 User Guide ISP-2600-UG00 325

Chapter 2 Getting Started
Project Assistant

Task To configure registry data:

1. In the Project Assistant, open the Application Registry page.

2. Select Yes in answer to the question about configuring registry data.

3. Right-click the registry item to which you want to add the data, select New, and point to Key.

4. Name the key.

5. Right-click the key, select New, and point to the appropriate command. You can pick Default Value, String Value,
Binary Value, DWORD Value, Multi-String Value, or Expandable String Value, depending on the type of data you want to
register.

Modifying Registry Data Values in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

Task To modify registry data:

1. In the Project Assistant, open the Application Registry page.

2. Double-click the data.

If you double-clicked a multi-line string, the Multi-Line String Value dialog box opens. If you double-clicked any other
type of registry data, the Edit Data dialog box opens.

3. Edit the data and click OK.

Associating Registry Data with Features

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

326 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

All the registry data that you add in the Project Assistant’s Application Registry page is added to your project’s default
feature. You can associate your registry data with another feature in the Installation Designer.

Task To use the Installation Designer to associate registry data with a feature other than the default feature:

1. In the View List under System Configuration, click Registry.

2. In the View Filter list, select the feature with which you want to associate the registry data.

3. Create or drag and drop the registry data in the appropriate registry location.

See Also
Updating the Registry
Filtering Registry Entries by Component or Feature

Using Variable Data Types in Registry Data

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

InstallShield allows you to use variable data types or properties when creating registry data for your installation project.

Task To use INSTALLDIR as a variable in the registry (Windows Installer-based projects only):

1. In the Project Assistant, open the Application Registry page.

2. Select Yes to indicate that you want to configure the registry data that your application will install.

3. Right-click HKEY_CLASSES_ROOT, point to New, and select Key.

4. Name the key Installation Location.

5. Right-click the Installation Location key, point to New, and select String Value.

6. Name the string value My Installation Location.

7. Double-click the My Installation Location key. The Edit Data dialog box opens.

8. In the Value Data field, type [INSTALLDIR].

At run time, the value of [INSTALLDIR] is replaced with the installation directory.

InstallShield 2020 User Guide ISP-2600-UG00 327

Chapter 2 Getting Started
Project Assistant

Application Paths
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The application path registry key contains data that Windows uses as a private search path for the specified application’s
.dll files. If you install an application’s .dll files into a directory not found in the PATH environment variable (and not into
the application’s directory), you should set the appropriate application path to include the .dll file directory during
installation. Application path information is stored in the registry under
HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\AppName.exe.

See Also
Specifying an Application Path for a Component

Installation Interview Page

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• MSI Database

The Installation Interview page lets you specify the dialogs you want the end user to see when your installation program
runs. Based on your answers to the questions on this page, the Project Assistant adds the corresponding dialog to your
installation project.

See Also
Specifying Dialogs for Your Installation in the Project Assistant
Allowing End Users to Modify the Installation Location
License Agreements
Creating Selectively Installable Installations
Adding Project Assistant Dialog Support to Projects Upgraded from InstallShield Professional

Specifying Dialogs for Your Installation in the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

328 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

• Basic MSI
• InstallScript
• MSI Database

Note that the option for launching your application when the installation completes is not available in InstallScript projects.

The questions that are displayed on the Installation Interview page of the Project Assistant help you specify which dialogs
you want the end user to see when your installation program runs.

Task To specify dialogs for your installation:

1. Do you want to display a License Agreement Dialog?—Select Yes to browse to your license agreement file.

2. Do you want to prompt users to enter their company name and user name?—Select Yes to display a dialog
requesting this information.

3. Do you want your users to be prompted to modify the installation location of your application?—Select Yes to
present a dialog that allows end users to change the installation location. See Allowing End Users to Modify the
Installation Location for more information.

4. Do you want users to be able to selectively install only certain parts of your application?—Select Yes to allow end
users to select which parts of the application they want to install. See Creating Selectively Installable Installations for
more information.

5. Do you want to give users the option to launch your application when the installation completes?—Select Yes
and browse to your application file. When this option is set to Yes, the final dialog in the installation presents a check
box that allows end users to immediately launch your application upon clicking the Finish button.

Tip • To add a custom graphic to your installation dialogs, click the link in the More Options section of this page to launch the
Dialog Images dialog box.

Allowing End Users to Modify the Installation Location

InstallShield 2020

If you want to provide end users with control over where your software is installed on their system, you can allow them to
modify the installation location.

In a Windows Installer-based installation, the Windows Installer property INSTALLDIR serves as the default installation
directory. When you allow users to modify the installation location, the CustomSetup dialog is presented during the
installation.

In an InstallScript project, TARGETDIR serves as the default installation directory. When you allow users to modify the
installation location, the SdSetupType2 dialog is presented during the installation.

InstallShield 2020 User Guide ISP-2600-UG00 329

Chapter 2 Getting Started
Project Assistant

License Agreements
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• MSI Database

In order to install your product, you may require that your end users agree to certain legal requirements. For example,
most software vendors do not allow end users to copy or distribute their software to others.

Your installation can present an End User License Agreement (EULA) in the License Agreement dialog at run time. The EULA
is a legal contract between you and the end user, with regard to the use of your product.

The License Agreement dialog displays your license agreement text and contains a radio button group (Yes or No). If the
end user does not agree to accept the EULA, your software is not installed and the installation ends.

Task To add a License Agreement dialog to your project in the Project Assistant:

1. In the Project Assistant, open the Installation Interview page.

2. Select Yes to indicate that you want to add a License Agreement dialog.

3. Type the path to your license agreement file or browse to the file.

Project • For Basic MSI and MSI Database projects, the file must be a rich text file (.rtf).

For InstallScript projects, the file type depends on which license dialog that you are using and which parameters you are
passing to it. The SdLicenseEx and SdLicense2Ex functions have support for .rtf files and text files (.txt).

Creating Selectively Installable Installations

InstallShield 2020

You can allow your end users to select which portions of your installation they want to install to their systems. This is a
custom installation, which provides a list of the available features within your installation. The end user can select the
features to install in a dialog presented at run time.

For example, your installation might contain your application’s executable (.exe) file, a documentation (.chm) file, and a
samples file. All of these files are contained in different features, which are provided in an option list to the end user. If the
end user needs only the application, they can select to install the executable file, but not the documentation or samples
file.

See Also
Configuring a Feature’s Install Level Setting

330 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

Installation Localization Page

InstallShield 2020

Edition • Multilingual language support is available in the Premier edition of InstallShield.

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

The Installation Localization page lets you specify the languages your installation supports, and specify string values and
associated identifiers, which you can use in your end user interface to make your installation more easily localizable in
other languages.

Note • You can specify the set of string data that you want to edit in the drop-down menu at the top of the page.

See Also
Localizing String Data from the Project Assistant
How Localized String Data Is Used in the Installation

Localizing String Data from the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Much of the text in your installation project is stored as string entries. To make localizing your installation easier,
InstallShield provides the capability to export your strings for translation and import the translated strings back into your
project.

Task To export all of the string data in your project for translation:

1. In the Project Assistant, open the Installation Localization page.

2. In the data list at the top of the page, select All String Data.

3. In the list of languages, select a language.

4. In the More Options area, click Export localizable strings. The File Name dialog box opens.

InstallShield 2020 User Guide ISP-2600-UG00 331

Chapter 2 Getting Started
Project Assistant

5. Save the text (.txt) file to the location you want.

6. Send the text file to your translation company or department.

Task After the strings in your text file are translated, you can import the strings back into your project:

1. In the Project Assistant, open the Installation Localization page.

2. In the data list at the top of the page, select All String Data.

3. In the list of languages, click the language that matches the strings that you want to import.

4. In the More Options area, click Import localizable strings. The File Name dialog box opens.

5. Browse to your .txt file and click Open. The translated strings are imported back into your project.

See Also
Translating String Entries

How Localized String Data Is Used in the Installation

InstallShield 2020

There are two types of string data in an installation project—string data that is specific to your installation and string data
that is specific to your application.

The majority of the string data in an InstallShield project is used at run time when an end user runs the installation.
However, some of the string data is installed to the target system. For example, a localized shortcut is localized string data
that is installed to the end user’s system.

Build Installation Page

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Tip • The following information applies to releases that are built within InstallShield (without integration with Visual Studio).
For information on building an InstallShield release from within Visual Studio, see Building Releases in Microsoft Visual Studio.

The Build Installation page lets you specify what type of distribution you want to build and, optionally, the location to
which you want to copy the distribution files. It also enables you to digitally sign the package.

See Also
Building Your Installation from the Project Assistant
After Completing the Project Assistant: Next Steps

332 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Project Assistant

Building Your Installation from the Project Assistant

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Tip • The following information applies to releases that are built within InstallShield (without integration with Visual Studio).
For information on building an InstallShield release from within Visual Studio, see Building Releases in Microsoft Visual Studio.

Task To build your installation:

1. In the Project Assistant, open the Build Installation page.

2. Select the installation image types you want to build.

Note • The Single MSI Package option should be selected for machines that already have Windows Installer installed
them since no attempt will be made to check and install the engine if it is not there.

3. If you want InstallShield to automatically copy your installation to another location after the build finishes, click the
Optional distribution settings link for each build option and specify the location.

If you want InstallShield to distribute your installation after the build finishes, click the Optional distribution settings
link for each build option and select the Distribute After Build check box.

4. To digitally sign your Setup.exe file to assure your end users that the code within your application has not been
modified or corrupted, click the Digitally Sign Setup hyperlink. The Digitally Sign Setup dialog box opens.
Configure the settings as needed.

5. Click Build Installations.

The Output window opens, and the Build tab displays information about the progress of the build. The build is finished
when the Build tab displays the log file information.

Tip • The Signing tab in the Installation Designer lets you specify which portions of your installation should be digitally signed
at build time. InstallShield enables you to sign any and all of the following files in a release, depending on what type of project
you are using:

• Windows Installer package (.msi file or .msm file) for Basic MSI, InstallScript MSI, and Merge Module projects
• Setup.exe file for Basic MSI and InstallScript MSI projects
• Media header file for InstallScript projects
• Package (self-extracting single-executable file) for InstallScript projects
• Any files in your release, including your application files

InstallShield 2020 User Guide ISP-2600-UG00 333

Chapter 2 Getting Started
Working with the InstallShield Interface

To learn more, see Digitally Signing a Release and Its Files at Build Time.

Windows Logo • All executable files (including .exe, .dll, .ocx, .sys, .cpl, .drv, and .scr files) in an installation must be digitally
signed for the Windows logo program.

See Also
Digital Signing and Security
Digitally Sign Setup Dialog Box

After Completing the Project Assistant: Next Steps

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

After going through the Project Assistant pages and completing the fields, you have an installation project framework that
you can use as a functional installation or you can further customize to fit your needs.

Further Customizing Your Project

The Installation Designer provides an easy way to access all of the installation creation views available in InstallShield.
Click the Installation Designer tab at the top of the Project Assistant workspace to display the views.

Within the Installation Designer, you can see the View List, which is a list of all available views for the project type that you
are creating. To display the View List on the left side of the workspace, press F4.

Learning About InstallShield Views

For detailed information about each of the InstallShield views, refer to the topics in the View List section of the InstallShield
Help Library.

Working with the InstallShield Interface

InstallShield 2020

The InstallShield interface is a graphical user interface with conventional Windows-based elements such as a menu bar, a
toolbar, and dialog boxes. This section includes topics that explain how to perform basic tasks using these elements and
how to customize the interface.

See Also
Showing or Hiding the Project Assistant
View Reference

334 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

Displaying the View List

InstallShield 2020

Task To see the View List in the InstallShield interface:

1. Click the Installation Designer tab at the top of the InstallShield interface.

2. Do one of the following to display the View List:

• On the View menu, click View List. The View List appears on the left side of the InstallShield interface.

• Click the toolbar’s View List button.

• Press F4 to hide or show the View List.

See Also
View Reference

Opening Views in the InstallShield User Interface

InstallShield 2020

The first step in many InstallShield procedures is to open a particular view in the Installation Development Environment
(IDE).

Task To open a view:

1. Click the Installation Designer tab. The View List is displayed along the left side of the IDE. If the View List is not
displayed, see Displaying the View List.

2. In the View List, select the view you want to open. To see all available views, expand the View List folders.

Working with the Group Box Area in Various Views

InstallShield 2020

A number of views in InstallShield have a group box area that lets you organize the rows in the view. The views that contain
this group box support multiple levels of grouping simply by dragging the column headers and dropping them onto the
group box (the area that says, “Drag a column header here to group that column”). InstallShield displays the rows in the
view hierarchically according to column arrangement in the group box. Examples of views that contain the group box are
the String Editor, Property Manager, the Redistributables, Prerequisites, and Path Variables views.

Note the following tips for working with the group box:

• To move a column header to the group box area, drag the column header and drop it onto the group box.

• To copy a column header onto the group box area, press CTRL while dragging the column header and dropping it onto
the group box. When you do this, the column header is displayed as a column header, and in the group box.

• When you are dropping group box headers onto the group box area, you can drop them onto other column headers.
This enables you to organize rows hierarchically.

InstallShield 2020 User Guide ISP-2600-UG00 335

Chapter 2 Getting Started
Working with the InstallShield Interface

• To remove a column header from the group box, drag it from the group box area and drop it onto the row of column
headers. When you are dragging it over the row of column headers, InstallShield displays arrows to indicate where in
the row the column header would be displayed if you dropped it.

• To sort the items in the grid by a particular column header, click the column header in the group box or in the row of
column headers.

The following examples demonstrate different ways for using the group box to organize content in views.

Default Behavior: Empty Group Box Area

By default, no column headers are displayed in the group box. The following screen shot shows part of the Redistributables
view. Items are sorted by the Name column.

Figure 2-3: Empty Group Box Area

Grouping by One Column Header

If you press CTRL while dragging and dropping one column header onto the group box, InstallShield arranges the rows in
the grid into groups of items. The following screen shot shows part of the String Editor view. Rows are organized to help
identify the recently added and modified strings that need to be translated.

Figure 2-4: Grouping Rows by One Column Header

Grouping by Two Column Headers

If you press CTRL while dragging and dropping one column header onto another column header in the group box,
InstallShield arranges the rows in the grid into multiple groups of items. The following screen shot shows part of the
Redistributables view. Rows are organized to help identify the InstallShield prerequisites and merge modules that have
been added to the project.

336 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

Figure 2-5: Sorting Rows by the Check Box Column and Then the Type Column

Showing or Hiding Toolbars

InstallShield 2020

Task To show or hide a toolbar, do one of the following:

• Right-click a toolbar and select the toolbar that you want to be displayed or hidden.

• On the Tools menu, click Customize. The Customize dialog box opens. Select the check box for each toolbar that you
want to be displayed. Clear the check box for each toolbar that you want to be hidden.

See Also
Adding Buttons and Menus to a Toolbar
Removing Buttons and Menus from a Toolbar
Showing or Hiding Toolbars
Creating Custom Toolbars
Toolbars

InstallShield 2020 User Guide ISP-2600-UG00 337

Chapter 2 Getting Started
Working with the InstallShield Interface

Adding Buttons and Menus to a Toolbar

InstallShield 2020

Task To add a button or menu to a toolbar:

1. Ensure that the toolbar that you want to change is visible.

2. On the Tools menu, click Customize. The Customize dialog box opens.

3. Click the Commands tab.

4. In the Categories box, click the category for the button or menu that you want to add.

5. Drag the button or menu from the Commands box to the appropriate toolbar.

Tip • To create your own custom toolbar, drag the button or menu to the empty gray area near the toolbars.

See Also
Removing Buttons and Menus from a Toolbar
Showing or Hiding Toolbars
Creating Custom Toolbars
Toolbars

Removing Buttons and Menus from a Toolbar

InstallShield 2020

Task To remove a button or menu from a toolbar:

1. Ensure that the toolbar that you want to change is visible.

2. On the Tools menu, click Customize. The Customize dialog box opens.

3. Right-click the button or menu that you want to remove, and then click Delete.

See Also
Adding Buttons and Menus to a Toolbar
Showing or Hiding Toolbars
Creating Custom Toolbars
Toolbars

338 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

Creating Custom Toolbars

InstallShield 2020

Task To create a custom toolbar:

1. On the Tools menu, click Customize. The Customize dialog box opens.

2. Click the Toolbars tab.

3. Click the New button. The New Toolbar dialog box opens.

4. In the Toolbar name box, enter a descriptive name for the toolbar, and click OK.

5. Customize the new toolbar by adding menus or buttons.

See Also
Showing or Hiding Toolbars
Adding Buttons and Menus to a Toolbar
Removing Buttons and Menus from a Toolbar
Toolbars

Docking or Undocking the Output Window

InstallShield 2020

The Output window or its individual tabs can be docked to any side of the workspace in InstallShield, or they can be
dragged to free-floating positions.

If you drag the Output window or one of its tabs to the edge of the InstallShield interface, it becomes a docked window. If
you drag the Output window or one of its tabs away from any of the edges of the InstallShield interface, it becomes
undocked.

Task To undock the Output window:

Drag the title bar of the Output window to the new location. Resize the Output window as needed.

Task To dock the Output window:

Drag the title bar of the Output window to the left, right, top, or bottom edge of the InstallShield interface.

Task To undock a tab on the Output window:

Drag the tab to the new location. Resize the Output window as needed.

InstallShield 2020 User Guide ISP-2600-UG00 339

Chapter 2 Getting Started
Working with the InstallShield Interface

Task To dock one of the Output window tabs:

Drag the tab to the left, right, top, or bottom edge of the InstallShield interface.

See Also
Output Window

Working with the Script Editor Pane in Various Views

InstallShield 2020

Several views in InstallShield have a script editor pane that you can use to write code for your projects. Examples of views
that contain the script editor pane are:

• InstallScript view—When you select a script file in this view, InstallShield displays a script editor pane where you can
write InstallScript code.

• SQL Scripts view—When you select a SQL script in this view, the Script tab shows a script editor pane that lets you
edit your SQL file.

• Custom Actions and Sequences view—When you select a VBScript or JScript custom action in this view, the Script
tab shows a script editor pane that lets you edit your VBScript or JScript file.

This section of the documentation describes how to use the script editors in InstallShield.

See Also
InstallScript View
SQL Scripts View
Custom Actions and Sequences View (or Custom Actions View)

Using Bookmarks in the Script Editors

InstallShield 2020

Bookmarks are markers that let you jump to specific lines within your script with a minimum number of keystrokes.
Bookmarks are visible in the left margin of the script editor. Note that InstallShield does not save bookmarks when you
close your project.

Task To add a new bookmark or clear an existing bookmark:

1. Do one of the following:

• Place the insertion point in the line of your script that you want to contain a bookmark.

• Place the insertion point in the line of your script that contains the bookmark that you want to

2. Press ALT+K.

340 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

Task To move the insertion point to the next line that contains a bookmark:

Press CTRL+K.

Task To move the insertion point to the previous line that contains a bookmark:

Press CTRL+SHIFT+K.

See Also
Keyboard Shortcuts for the Script Editors

Enabling or Disabling Auto Completion in the Script Editors

InstallShield 2020

InstallShield lets you specify whether you want to be able to use automatic completion when you are typing in the script
editor in various views (for example, the InstallScript view and the SQL Scripts view). If auto completion is enabled,
InstallShield displays a pop-up list of alphabetically ordered functions, keywords, constants, and string identifiers that
begin with the letters that you are typing in the script editor. Instead of manually typing the entire word, you can select it in
the pop-up list, and InstallShield adds it to your script.

Auto completion can increase your efficiency because it can reduce the time that you spend typing code. It can also help
you avoid typographical errors in your code.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same auto completion settings are used for all script editors. If you change the settings in the SQL Scripts view, the settings
are also changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

Task To specify whether auto completion should be available in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Auto completion setting, select the appropriate option:

• Yes—InstallShield displays a pop-up list of available functions, keywords, constants, and string identifiers that
begin with the letters that you are typing code in the script editors. This is the default option.

• No—InstallShield does not display a pop-up list when you are typing code in the script editors.

3. In the Include local variables setting, select the appropriate option:

• Yes—InstallShield adds local variables that are defined in InstallScript to the pop-up list of available functions
and other script words that begin with the letters that you are typing code in the InstallScript editor. This is the
default option.

• No—InstallShield does not include local variables in the pop-up list when you are typing code in the InstallScript
editor.

InstallShield 2020 User Guide ISP-2600-UG00 341

Chapter 2 Getting Started
Working with the InstallShield Interface

Note that if you select No, the Functions, Properties, and Methods folders in the center pane of the InstallScript
view do not list any functions, properties, or methods from your script files.

If Yes is selected for this setting and you notice performance issues when you are typing code in the InstallScript
view, you might want to change this setting to No.

Note • The Include local variables setting applies to the script editor in the InstallScript view; it does not have any effect
on the script editors in other views, such as the SQL Scripts view. This setting is ignored if you select No for the Auto
completion setting.

4. Click OK. The Script Editor Properties dialog box closes.

InstallShield enables or disables auto completion in the InstallScript editor as needed.

For details about how auto completion works, see Using Auto Completion when Writing Code in the Script Editors.

See Also
Script Editor Properties Dialog Box

Using Auto Completion when Writing Code in the Script Editors

InstallShield 2020

If auto completion is enabled for the script editors in InstallShield, InstallShield displays a pop-up list of alphabetically
ordered functions, keywords, constants, and string identifiers that begin with the letters that you are typing in the script
editor. The pop-up list contains language-appropriate options, depending on which view you are using. For example, the
script editor in the InstallScript view supports auto completion of InstallScript code. The VBScript script editor in the
Custom Actions and Sequences view supports auto completion of VBScript.

In addition, if auto completion for local variables is enabled, the pop-up list in the script editor of the InstallScript view also
contains local variables.

To learn how to enable auto completion, see Enabling or Disabling Auto Completion in the Script Editors.

Task To use auto completion for a function name, a keyword, a constant, or string identifier:

1. Open the view that contains the appropriate script editor, and select the script that you want to edit.

2. Place the insertion point where you want to enter code in your script.

3. Do one of the following:

• Type the first characters of the function name, keyword, or other script word.

Depending on the view that you are using and the language that is entered in the script editor in that view,
InstallShield displays a pop-up list of alphabetically ordered functions, keywords, and other script words that
begin with the letters that you are typing in the script editor. The first word that matches the characters that you
typed is selected in the list. If no word matches the characters that you typed, no word in the list is selected.

• If you are using the script editor in the InstallScript view and you want to use auto completion for a list of
available string identifiers, enter the string constant operator (@). InstallShield displays a pop-up list of
alphabetically ordered string identifiers.

342 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

4. If the selected word is not the one you want (or no word is selected), select another word in one of the following ways:

• To navigate through the list, use the pop-up list’s scroll bar; then, click the desired word to select it.

• To change the selection to the previous or next word, use the UP ARROW and DOWN ARROW keys.

5. To paste the selected word into your script, double-click the word, or press the ENTER key or the TAB key.

To close the list without pasting the selected word, press ESC or click outside the pop-up list.

See Also
Viewing Function Call Tips for an InstallScript Function in the Script Editor

Enabling or Disabling InstallScript Function Call Tips in the Script Editor

InstallShield 2020

InstallShield lets you specify whether you want InstallShield to display an InstallScript function call tip—a type of tooltip—
when you are entering a function call in your script in the InstallScript view. A function call tip shows a built-in function’s
parameter information. It also shows a description of the built-in function, as well as a description of the parameter that
you are entering.

Function call tips let you see language information within the script editor, without requiring you to switch to a different
window.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same auto completion settings are used for all script editors. If you change the settings in the SQL Scripts view, the settings
are also changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

Task To specify whether function call tips should be shown in the script editor of the InstallScript view:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Show function call tips setting, select the appropriate option:

• Yes—InstallShield displays function call tips when you are entering function calls in your script. This is the default
option.

• No—InstallShield does not display function call tips when you are entering function calls in your script.

3. Click OK. The Script Editor Properties dialog box closes.

InstallShield enables or disables function call tips in the InstallScript editor as needed.

For details about how function call tips work, see Viewing Function Call Tips for an InstallScript Function in the Script
Editor.

See Also
Script Editor Properties Dialog Box

InstallShield 2020 User Guide ISP-2600-UG00 343

Chapter 2 Getting Started
Working with the InstallShield Interface

Viewing Function Call Tips for an InstallScript Function in the Script Editor
InstallShield 2020

If function call tips are enabled, InstallShield shows InstallScript function call tips—a type of tooltip—when you are
entering function calls in your script in the InstallScript view. A function call tip shows a built-in function’s parameter
information. It also shows a description of the built-in function, as well as a description of the parameter that you are
entering.

To learn how to enable function call tips, see Enabling or Disabling InstallScript Function Call Tips in the Script Editor.

Task To view a description of a function, as well as parameter details about that function:

1. Enter a function name in your script by typing it or using automatic function name completion, as described earlier.

2. Type a left parenthesis—(—after the function name. InstallShield displays a function call tip that shows a complete
call to the function, including all of its parameters. The tip also includes a description of the function, as well as a
description of the next parameter that you need to enter. The first parameter appears in blue, by default.

3. Type the parameters as indicated by the call tip. Each time that you type a comma, the next parameter in the function
syntax appears in blue, by default.

4. To close the call tip, type the right parenthesis—). Or, press ESC or click in the script editor pane outside the call tip.

Tip • To view additional details about a particular built-in function, constant, or other InstallScript word, place the insertion
point within that word, and then press F1. The InstallShield Help Library opens, enabling you to learn more about that
particular word.

See Also
Using Auto Completion when Writing Code in the Script Editors

Enabling or Disabling Syntax Highlighting in the Script Editors

InstallShield 2020

InstallShield lets you specify whether you want the script editors in various views in InstallShield to display script files with
color attributes that identify keywords, comments, strings, and other script elements. Each category is displayed in a
different color so that you can easily identify them.

This functionality—called syntax highlighting—helps to improve the readability and context of code. In addition, it can help
you avoid errors that are caused, for example, when you attempt to use a reserved word as a user-defined identifier. It can
also help you locate other errors in your script, such as misspelled keywords, missing quotation marks at the end of a
string, and missing comment characters.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same syntax highlighting and color settings are used for all script editors. If you change the settings in the SQL Scripts
view, the settings are also changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

344 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

Task To specify whether syntax highlighting should be enabled in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Syntax highlighting setting, select the appropriate option:

• Yes—InstallShield uses the syntax highlighting that is defined in the Colors area of the Script Editor Properties
dialog box in all of the script editors. This is the default option.

• No—InstallShield does not use any syntax highlighting in any of the script editors.

3. Click OK. The Script Editor Properties dialog box closes.

InstallShield enables or disables syntax highlighting in the script editors as needed.

InstallShield lets you define the foreground color and background color that is used for each script word category. To learn
how, see Changing Colors for Syntax Highlighting in the Script Editors.

See Also
Script Editor Properties Dialog Box

Changing Colors for Syntax Highlighting in the Script Editors

InstallShield 2020

InstallShield lets you change the colors that are used to differentiate among different script elements in the script editor in
various views (for example, the InstallScript view and the SQL Scripts view). You can change the foreground color (the color
that is used for the text), as well as the background color, for script elements such as comments, functions, and strings.

This functionality—called syntax highlighting—helps to improve the readability and context of code. In addition, it can help
you avoid errors caused, for example, when you attempt to use a reserved word as a user-defined identifier. It can also help
you locate other errors in your script, such as misspelled keywords, missing quotation marks at the end of a string, and
missing comment characters.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same syntax coloring settings are used for all script editors. If you change the settings in the SQL Scripts view, the settings
are also changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

Task To change the syntax highlighting that is used in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Colors area, click the setting for the script element that you want to configure. InstallShield displays foreground
and background buttons in the setting.

3. Do one of the following:

• Click the foreground button or the background button. The Colors dialog box opens, enabling you to select the
color that you want to use.

InstallShield 2020 User Guide ISP-2600-UG00 345

Chapter 2 Getting Started
Working with the InstallShield Interface

• Enter the RGB values for the color that you want to use for the foreground or the background. For example, the
entry 0; 0; 0 / 255; 255; 255 indicates that InstallShield should use black (which has an RGB value of 0; 0; 0)
for the foreground and white (255; 255; 255) for the background. If you do not want to set a color for a particular
area, you can use dashes (-;-;-).

4. Click OK. The Script Editor Properties dialog box closes.

If script highlighting is enabled, InstallShield changes the colors that are used to display text in the script editor as needed.
To learn more, see Enabling or Disabling Syntax Highlighting in the Script Editors.

To make the best use of this functionality, note the following:

• Misspelled reserved words are not recognized by the editor and are not displayed with syntax coloring. If you see in
your script a “reserved word” that is not displayed with indicating attributes, it is possible that it is misspelled.

• Coloring of string literals includes both the opening and closing quotation marks. If the closing quotation mark is
missing, string coloring will extend to the end of the line; in that case, text that should have followed the quotation will
be displayed as though it were part of the string literal.

• Syntax coloring makes it easy to identify comments that open with /* and are not closed properly with */. In that
case, all of the text that follows the comment is displayed with the comment color attribute.

• In lines that include comments starting with two slashes (//), all text from the comment character to the end of the
line is recognized as a comment.

• In the script editor that is displayed in the InstallScript view, InstallShield does not use syntax coloring for files that
have an extension other than .rul or .h (for example, log or report files).

See Also
Script Editor Properties Dialog Box

Changing the Font that Is Used to Display Text in the Script Editors
InstallShield 2020

InstallShield lets you change the font that is used in the script editor in various views (for example, the InstallScript view
and the SQL Scripts view).

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same font is used for all script editors. If you change the font in the SQL Scripts view, the font is also changed in the
InstallScript view the next time that the InstallScript is reloaded in that view.

Task To change the font, font style, or font size that is used to display text in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the General area, click the Font setting, and then click the ellipsis button (...) in this setting. The Font dialog box
opens.

3. Specify the font changes as needed.

4. Click OK. The Font dialog box closes.

346 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

5. Click OK. The Script Editor Properties dialog box closes.

InstallShield changes the font that is used to display text in the script editor as needed.

See Also
Script Editor Properties Dialog Box

Showing or Hiding Line Numbering in the Script Editors

InstallShield 2020

InstallShield lets you specify whether you want the left margin of the script editors in InstallShield to contain line numbers.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same line numbering setting is used for all script editors. If you change the setting in the SQL Scripts view, the settings are
also changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

Task To specify whether line numbering should be enabled in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Line numbering setting, select the appropriate option:

• Yes—InstallShield adds line numbers to the left margin of all of the script editors.

• No—InstallShield does not show any line numbers in the left margin of any of the script editors. This is the default
option.

3. Click OK. The Script Editor Properties dialog box closes.

InstallShield shows or hides line numbering in the script editors as needed.

See Also
Going to a Line Number in a Script that Is Displayed in a Script Editor
Script Editor Properties Dialog Box

Going to a Line Number in a Script that Is Displayed in a Script Editor

InstallShield 2020

Task To move the insertion point to a specific line number in your script:

1. On the Edit menu, click Go To. The Go To Line dialog box opens.

2. In the Line box, type the number of the line where you want to move the insertion point.

3. Click OK.

InstallShield 2020 User Guide ISP-2600-UG00 347

Chapter 2 Getting Started
Working with the InstallShield Interface

See Also
Showing or Hiding Line Numbering in the Script Editors
Script Editor Properties Dialog Box

Enabling or Disabling Automatic Indentation in the Script Editors

InstallShield 2020

InstallShield lets you specify whether you want to use automatic indentation in the script editors when you are writing
code. Auto indentation may help improve readability.

If automatic indentation is enabled, InstallShield indents a new line according to the indentation that is used in the
previous line. When you press ENTER in the script editor pane, the insertion point appears on a new line, positioned
directly beneath the first character of the previous line. To stop indenting a new line, press BACKSPACE; doing so removes
the indentation.

If automatic indention is disabled, a new line is not indented—that is, the insertion point is placed in the first column of the
new line.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same automatic indentation setting is used for all script editors. If you change the setting in the SQL Scripts view, the
settings are also changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

Task To specify whether automatic indentation should be enabled in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Automatic indentation setting, select the appropriate option:

• Yes—InstallShield adds support for automatic indentation in all of the script editors. This is the default option.

• No—InstallShield does not use automatic indentation in any of the script editors.

3. Click OK. The Script Editor Properties dialog box closes.

InstallShield enables or disables automatic indentation in the script editors as needed.

See Also
Script Editor Properties Dialog Box

Setting the Tab Width for the Script Editors

InstallShield 2020

InstallShield lets you specify the width of tabs in the script editor in various views (for example, the InstallScript view and
the SQL Scripts view).

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same tab setting is used for all script editors. If you change the setting in the SQL Scripts view, the settings are also
changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

348 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

Task To specify the width that InstallShield should use for tabs that are entered in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Tab width setting, enter the width—as a multiple of the character space size—that you want for tabs in your
scripts. The default value is 4.

3. Click OK. The Script Editor Properties dialog box closes.

InstallShield adjusts the widths of the tabs in your script as needed.

See Also
Script Editor Properties Dialog Box

Enabling or Disabling Syntax Folding in the Script Editors

InstallShield 2020

InstallShield lets you specify whether you want the script editors in various views in InstallShield to include support for
syntax folding. When syntax folding is enabled, InstallShield adds a plus sign (+) or a minus sign (–) in the margin next to
each line of code that starts an expandable or collapsible block of script. You can click a plus sign to expand hidden code, or
a minus sign to hide code.

Syntax folding can help you minimize the clutter of large scripts and focus on the code that is relevant to the work that you
are currently doing. It can also help you see the overall structure of a script.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same syntax folding setting is used for all script editors. If you change the setting in the SQL Scripts view, the setting is also
changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

Task To specify whether syntax folding should be enabled in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Syntax folding setting, select the appropriate option:

• Yes—InstallShield uses the syntax folding in all of the script editors.

• No—InstallShield does not use any syntax folding in any of the script editors. This is the default option.

3. Click OK. The Script Editor Properties dialog box closes.

InstallShield enables or disables syntax folding in the script editors as needed.

See Also
Script Editor Properties Dialog Box

InstallShield 2020 User Guide ISP-2600-UG00 349

Chapter 2 Getting Started
Working with the InstallShield Interface

Showing or Hiding Whitespace in the Script Editors

InstallShield 2020

InstallShield lets you specify whether you want the script editors in various views in InstallShield to display a symbol or
other mark in place of each instance of whitespace in your script. For example, if you select Yes, InstallShield displays each
space character in the script as a middle dot (·) and each tab character as an arrow. InstallShield also identifies line breaks
when whitespace is enabled.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example,
the same whitespace setting is used for all script editors. If you change the setting in the SQL Scripts view, the setting is also
changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

Task To specify whether whitespace should be shown or hidden in the script editors:

1. Right-click in the script editor pane and click Properties. The Script Editor Properties dialog box opens.

2. In the Show whitespace setting, select the appropriate option:

• Yes—InstallShield shows whitespace characters and symbols in all of the script editors.

• No—InstallShield does not show whitespace characters and symbols in any of the script editors. This is the
default option.

3. Click OK. The Script Editor Properties dialog box closes.

InstallShield shows or hides whitespace characters and symbols in the script editors as needed.

See Also
Script Editor Properties Dialog Box

Dragging and Dropping Text in the Script Editors

InstallShield 2020

The script editors in InstallShield support drag-and-drop text editing, enabling you to move or copy selected text from one
location in your code to another.

Moving Text

Task To move text:

1. Select the text that you want to move.

2. Place the mouse pointer over the selected text.

3. Press and hold down the left mouse button.

4. When you see a small rectangle appear beneath the mouse pointer, move the pointer to the location in your script to
which you want to move the selected text. Continue to hold down the left mouse button while you move the pointer.

350 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Working with the InstallShield Interface

5. When the pointer is at the location in which you want to move the text, release the left mouse button.

Copying Text

Task To copy selected text using the drag and drop method:

1. Select the text that you want to move.

2. Place the mouse pointer over the selected text.

3. Press CTRL, and then press and hold down the left mouse button.

4. When you see a small rectangle and a plus sign beneath the mouse pointer, move the pointer to the location in your
script to which you want to copy the selected text. Continue to hold down CTRL and the left mouse button while you
move the pointer.

5. When the pointer is at the location in which you want to move the text, release the left mouse button.

Printing a Script File from Within a Script Editor

InstallShield 2020

InstallShield lets you print a script that is displayed in the script editors in various views (for example, the InstallScript view
and the SQL Scripts view).

Task To print the script that is displayed in the active script editor pane:

1. On the File menu, click Print. Note that this command is enabled only if the insertion point is in the script editor pane.
The Print dialog box opens.

2. Specify the options that you prefer.

3. Click OK.

Keyboard Shortcuts for the Script Editors

InstallShield 2020

The script editors in InstallShield include support for the following keyboard shortcuts.

Table 2-8 • Keyboard Shortcuts for the Script Editors

Keyboard Shortcut Description

CTRL+C Copies the selected text to the Clipboard.

CTRL+INSERT

CTRL+X Deletes the selected text and puts it in the Clipboard.

SHIFT+DELETE

InstallShield 2020 User Guide ISP-2600-UG00 351

Chapter 2 Getting Started
Working with the InstallShield Interface

Table 2-8 • Keyboard Shortcuts for the Script Editors (cont.)

Keyboard Shortcut Description

CTRL+F Finds the specified text.

CTRL+H Displays the Replace dialog box, which lets you search for text or other characters and
replace them.

CTRL+G Moves to a specified line.

TAB Indents the selected text to the right one tab stop.

CTRL+U Changes the selected text to all lowercase.

CTRL+V Inserts the Clipboard contents at the insertion point.

SHIFT+INSERT

CTRL+Y Redoes the previously undone action.

CTRL+A Selects all of the text in the entire document.

CTRL+Z Undoes the last action.

ALT+BACKSPACE

SHIFT+TAB Outdents the selected text.

CTRL+SHIFT+U Changes the selected text to all uppercase.

CTRL+M Maximize the width of the script editor or restore it to its previous width.

CTRL+I Opens the Function Wizard, which helps you add a function call at the insertion point in
the script that is displayed in the InstallScript view.

ALT+K Switches between adding and removing a bookmark in the line of script that currently
contains the insertion point.

CTRL+K Moves to the line in the script that contains the next bookmark.

CTRL+SHIFT+K Moves to the line in the script that contains the previous bookmark.

See Also
Working with the Script Editor Pane in Various Views

352 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

Configuring Advanced Settings for InstallShield

InstallShield 2020

One of the InstallShield program files is a file called Settings.xml. This file exposes some advanced machine-wide settings
for InstallShield. When you install InstallShield, Settings.xml is installed to one of the following locations, depending on
which language version of InstallShield you are using:

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

The Settings.xml file for the Standalone build is installed in one of the following locations:

• English—Standalone Build Program Files Folder\Support\0409

• Japanese—Standalone Build Program Files Folder\Support\0411

In most cases, you should not modify the Settings.xml file. However, in some cases, you may need to make changes in
this file. This section of the documentation describes some scenarios that would require Settings.xml changes:

• Changing the Timestamp Server for Digital Signatures

• Configuring the Compression Level for Files that Are Streamed into Setup.exe and ISSetup.dll

• Configuring the Maximum Size for .cab Files

• Modifying the List of Portable Executable Files for the Standalone Build

• Adding Support for XML Encoding Options

• Specifying the Location Where All Virtual Packages Should Be Built

• Changing the Default Clone_wait Parameter for the Setup

• Configuring Platform Architecture for Digital Signing

Caution • The Settings.xml file contains critical data; if this file is edited incorrectly, it can cause InstallShield to fail to work.
Use extreme care when editing this file.

Changing the Timestamp Server for Digital Signatures

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch

InstallShield 2020 User Guide ISP-2600-UG00 353

Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

When you specify digital signature information for a release, InstallShield uses VeriSign’s server (http://
timestamp.verisign.com/scripts/timstamp.dll) as the default timestamp server during builds. InstallShield includes a
machine-wide setting that lets you replace that default server with a different timestamp server. The setting also lets you
disable timestamping.

InstallShield 2019 R2 and later supports adding a delay between the successive digital signing, this requires only if the
timestamp server fails handle the successive signing requests.

Required to specify the <DelayBetweenSigning default="1500"/> node in the settings.xml, under <DevStudio/Build> node
in Settings.xml in milliseconds.

Caution • The following instructions require that you modify the Settings.xml file that is installed with InstallShield. This file
contains critical data; if it is edited incorrectly, it can cause InstallShield to fail to work. Use extreme care when editing this file.

Task To configure the timestamp server for digital signatures:

1. Close InstallShield.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language version of InstallShield you are using:

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

3. Create a back-up copy of the Settings.xml file, in case you later need to revert to the original version.

4. Use a text editor or XML file editor to open the Settings.xml file.

5. Search for the <DigitalSignature> element. It looks something like this:

<DigitalSignature Timestamp="http://timestamp.verisign.com/scripts/timstamp.dll"/>

6. To override the timestamp server with a different one, set the value of the Timestamp attribute to the appropriate
URL.

To disable timestamping, use an empty value for the Timestamp attribute:

<DigitalSignature Timestamp=""/>

Note • Disabling timestamping may affect how long your digital signature is considered to be valid.

7. Save the Settings.xml file.

8. Ensure that your XML code is well formed; if it is not well formed, you may have problems using InstallShield. In most
cases, you can identify improperly formed XML code by opening the Settings.xml file in Internet Explorer. You should
be able to expand and contract the major elements of the file; if you cannot, check the code for errors.

In InstallShield 2019 and later, the timestamp server is set to a SHA-2 server to:

• <DigitalSignature Timestamp="http://sha256timestamp.ws.symantec.com/sha256/timestamp"/>

Whenever you build a release that includes digital signature information, InstallShield sets the timestamp according to the
setting that you configured.

354 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

Tip • If you use the Standalone Build to build a release, update the Settings.xml file that is installed with the Standalone
Build. Settings.xml is installed in one of the following locations, depending on which language version of InstallShield you
are using:

• English—Standalone Build Program Files Folder\Support\0409

• Japanese—Standalone Build Program Files Folder\Support\0411

See Also
Digital Signing and Security

Configuring the Compression Level for Files that Are

Streamed into Setup.exe and ISSetup.dll
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

This information does not apply to custom compression, where only the files that are associated with one or more features are
compressed into .cab files.

InstallShield includes a machine-wide setting that lets you specify the compression level that you want to use for files that
are streamed into Setup.exe files and ISSetup.dll files at build time. Following are examples of files that may be
streamed into the Setup.exe files and ISSetup.dll files:

• All of your product’s files (if the release is one in which all of the files are compressed into the Setup.exe setup
launcher)

• InstallShield prerequisite installations that have a location of Extract From Setup.exe

• The .NET Framework installation if it has a location of Extract From Setup.exe

• The Windows Installer installation if it has a location of Extract Engine From Setup.exe

InstallShield also lets you specify particular files (with or without wild-card characters) that should not be compressed
when they are streamed into Setup.exe files or ISSetup.dll files.

Caution • The following instructions require that you modify the Settings.xml file that is installed with InstallShield. This file
contains critical data; if it is edited incorrectly, it can cause InstallShield to fail to work. Use extreme care when editing this file.

Task To configure compression settings for streamed files:

1. Close InstallShield.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language version of InstallShield you are using:

InstallShield 2020 User Guide ISP-2600-UG00 355

Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

3. Create a back-up copy of the Settings.xml file, in case you later need to revert to the original version.

4. Use a text editor or XML file editor to open the Settings.xml file.

5. Search for the <StreamCompression> element. It looks something like this:

<StreamCompression exclude="*.CAB" compressionlevel="-1"/>

6. To prevent certain files or file types from being compressed when they are streamed into Setup.exe files or
ISSetup.dll files, set the value of the exclude attribute to the names of those files. Note the following guidelines:

• To specify more than one file, separate each file name with a comma.

• To indicate a wild-card character, use an asterisk (*).

For example, to specify that .cab files, .exe files, and a file called test.txt should not be compressed, set the value of
the exclude attribute to as follows:

<StreamCompression exclude="*.CAB,*EXE,test.txt" compressionlevel="-1"/>

The default value is *.CAB, since .cab files are a compressed type of file.

7. Do one of the following:

• If you want to use a compression level that offers a balance between the size of the compressed file and the time
that is required to extract the compressed files at run time, set the value of the compressionlevel attribute to -1.
This is the default value.

• To specify a particular compression level, set the value of the compressionlevel attribute to a number from 0 to 9,
where 0 indicates no compression and 9 indicates maximum compression.

In general, when you specify a number from 0 to 9, the higher the number that you specify, the smaller the
resulting compressed file is, and the longer it may take to extract the files at run time.

8. Save the Settings.xml file.

9. Ensure that your XML code is well formed; if it is not well formed, you may have problems using InstallShield. In most
cases, you can identify improperly formed XML code by opening the Settings.xml file in Internet Explorer. You should
be able to expand and contract the major elements of the file; if you cannot, check the code for errors.

Whenever you build a compressed release for one of the applicable project types, InstallShield streams files into Setup.exe
files and ISSetup.dll files according to the settings that you configured.

Tip • If you use the Standalone Build to build a release, update the Settings.xml file that is installed with the Standalone
Build. Settings.xml is installed in one of the following locations, depending on which language version of InstallShield you
are using:

• English—Standalone Build Program Files Folder\Support\0409

• Japanese—Standalone Build Program Files Folder\Support\0411

See Also
Overview of ISSetup.dll
Configuring Advanced Settings for InstallShield

356 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

Configuring the Maximum Size for .cab Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

In addition, it is applicable only if you are building a compressed network image release in which all of the files are embedded
in the single-file .msi package or the Setup.exe setup launcher.

This information does not apply to custom compression, where only the files that are associated with one or more features are
compressed into .cab files.

The .cab file type has some limitations. For example, the maximum size of a single .cab file is 2 GB. In addition, some users
have had trouble signing large .cab files and verifying the digital signature of large signed .cab files.

To work around these limitations, InstallShield enables you to specify on a machine-wide basis the maximum size for each
.cab file that is built for a compressed network image release. When InstallShield is creating the .cab files for your release
and it reaches the .cab file threshold that you configured, it splits the data into two or more .cab files, creating multi-part
.cab files. Note that if you do not want InstallShield to create multi-part .cab files, you can configure InstallShield to store
the data in a single .cab file.

Caution • The following instructions require that you modify the Settings.xml file that is installed with InstallShield. This file
contains critical data; if it is edited incorrectly, it can cause InstallShield to fail to work. Use extreme care when editing this file.

Task To specify whether InstallShield should create multi-part .cab files and—if appropriate—specify the maximum .cab file
size:

1. Close InstallShield.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language version of InstallShield you are using:

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

3. Create a back-up copy of the Settings.xml file, in case you later need to revert to the original version.

4. Use a text editor or XML file editor to open the Settings.xml file.

5. Search for the <CompressedNetworkCABSize> element. It looks something like this:

<CompressedNetworkCABSize default="600"/>

6. Do one of the following:

• To specify the maximum size for .cab files, type the size in MB as the value of the default attribute. In the
aforementioned example, the maximum size is 600. The value should be 2048 or less, since the maximum size of a
.cab file is 2 GB (2048 MB).

InstallShield 2020 User Guide ISP-2600-UG00 357

Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

The default value is 600.

• If you do not want InstallShield to create multi-part .cab files, set the value of the default attribute to -1.

7. Save the Settings.xml file.

8. Ensure that your XML code is well formed; if it is not well formed, you may have problems using InstallShield. In most
cases, you can identify improperly formed XML code by opening the Settings.xml file in Internet Explorer. You should
be able to expand and contract the major elements of the file; if you cannot, check the code for errors.

Whenever you build a compressed network image release for one of the applicable project types, InstallShield creates the
.cab files according to the requirement that you configured in the Settings.xml file. Depending on the value that you
specified in the Settings.xml file, the Media table of the .msi package lists one or more .cab files.

Tip • If you use the Standalone Build to build a release, update the Settings.xml file that is installed with the Standalone
Build. Settings.xml is installed in one of the following locations, depending on which language version of InstallShield you
are using:

• English—Standalone Build Program Files Folder\Support\0409

• Japanese—Standalone Build Program Files Folder\Support\0411

See Also
Configuring Advanced Settings for InstallShield

Configuring the Maximum Size for Virtual Media Memory

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

The Virtual Media Memory type has some limitations. For example, the maximum size of Virtual Media Memory 512MB.

Caution • The following instructions require that you modify the Settings.xml file that is installed with InstallShield. This file
contains critical data; if it is edited incorrectly, it can cause InstallShield to fail to work. Use extreme care when editing this file.

Task To specify whether InstallShield should specify the maximum Virtual Media Memory size:

1. Close InstallShield.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language version of InstallShield you are using:

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

358 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

3. Create a back-up copy of the Settings.xml file, in case you later need to revert to the original version.

4. Use a text editor or XML file editor to open the Settings.xml file.

5. Search for the <CompressedNetworkCABSize> element. It looks something like this:

<CompressedNetworkCABSize default="600"/>

6. Do one of the following:

• To specify the maximum size for .cab files, type the size in MB as the value of the default attribute. In the
aforementioned example, the maximum size is 600. The value should be 2048 or less, since the maximum size of a
.cab file is 2 GB (2048 MB).

The default value is 600.

• If you do not want InstallShield to create multi-part .cab files, set the value of the default attribute to -1.

7. Save the Settings.xml file.

8. Ensure that your XML code is well formed; if it is not well formed, you may have problems using InstallShield. In most
cases, you can identify improperly formed XML code by opening the Settings.xml file in Internet Explorer. You should
be able to expand and contract the major elements of the file; if you cannot, check the code for errors.

Whenever you build a compressed network image release for one of the applicable project types, InstallShield creates the
.cab files according to the requirement that you configured in the Settings.xml file. Depending on the value that you
specified in the Settings.xml file, the Media table of the .msi package lists one or more .cab files.

Tip • If you use the Standalone Build to build a release, update the Settings.xml file that is installed with the Standalone
Build. Settings.xml is installed in one of the following locations, depending on which language version of InstallShield you
are using:

• English—Standalone Build Program Files Folder\Support\0409

• Japanese—Standalone Build Program Files Folder\Support\0411

See Also
Configuring Advanced Settings for InstallShield

Modifying the List of Portable Executable Files for the

Standalone Build
InstallShield 2020

The File Extensions tab on the Options dialog box in InstallShield lets you modify the file extensions that you would like
InstallShield to consider to be portable executable (PE) files. InstallShield uses this list to determine how it should create
components for dynamically linked files that adhere to the best practice component creation method.

If you are using the Standalone Build to build a release, the Options dialog box is not available. However, you can modify
one of the files that is installed in a subfolder of the InstallShield Standalone Build Program Files folder if you want to
modify the list of file extensions that the Standalone Build considers to be PE files. The following instructions explain how.

InstallShield 2020 User Guide ISP-2600-UG00 359

Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

Caution • The following instructions require that you modify the Settings.xml file that is installed with InstallShield. This file
contains critical data; if it is edited incorrectly, it can cause InstallShield to fail to work. Use extreme care when editing this file.

Task To modify the list of file extensions that the Standalone Build considers to be PE files:

1. Close the Standalone Build.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language version of InstallShield you are using:

• English—Standalone Build Program Files Folder\Support\0409

• Japanese—Standalone Build Program Files Folder\Support\0411

3. Create a back-up copy of the Settings.xml file, in case you later need to revert to the original version.

4. Use a text editor or XML file editor to open the Settings.xml file.

5. Search for the PEFileExtensions element. It looks something like this:

<PEFileExtensions default="EXE|DLL|OCX|VXD|CHM|HLB|TLB|AX">

6. Modify the list of file extensions for the default attribute as needed. Note that each file extension is separated with a
vertical bar (|).

7. Save the Settings.xml file.

8. Ensure that your XML code is well formed; if it is not well formed, you may have problems using InstallShield. In most
cases, you can identify improperly formed XML code by opening the Settings.xml file in Internet Explorer. You should
be able to expand and contract the major elements of the file; if you cannot, check the code for errors.

The next time that you use the Standalone Build, it will use the updated list of file extensions.

See Also
File Extensions Tab
Determining the Appropriate Component Creation Method for Dynamically Linked Files
Configuring Advanced Settings for InstallShield

Adding Support for XML Encoding Options

InstallShield 2020

InstallShield lets you specify what type of encoding should be used for an XML file. This setting is available on the Advanced
tab when you select the XML file in the XML File Changes view. If the type of encoding that you want to use is not included in
the list of available encoding options, you can modify one of the files that is installed in a subfolder of the InstallShield
Program Files folder to add additional options. You can add any encoding that is supported by MSXML. The following
instructions explain how.

Caution • The following instructions require that you modify the Settings.xml file that is installed with InstallShield. This file
contains critical data; if it is edited incorrectly, it can cause InstallShield to fail to work. Use extreme care when editing this file.

360 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

Task To add additional encoding options to the Encoding list on the Advanced tab in the XML File Changes view:

1. Close InstallShield.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language version of InstallShield you are using:

• English—InstallShield Program Files Folder\System\0409

• Japanese—InstallShield Program Files Folder\System\0411

3. Create a back-up copy of the Settings.xml file, in case you later need to revert to the original version.

4. Use a text editor or XML file editor to open the Settings.xml file.

5. Search for the ISXML element and its child elements. They look something like this:

<ISXML>
<Encodings>
<Encoding>WINDOWS-1250</Encoding>
<Encoding>WINDOWS-1251</Encoding>
<Encoding>WINDOWS-1252</Encoding>
<Encoding>WINDOWS-1253</Encoding>
<Encoding>WINDOWS-1254</Encoding>
<Encoding>WINDOWS-1255</Encoding>
<Encoding>WINDOWS-1256</Encoding>
<Encoding>WINDOWS-1257</Encoding>
<Encoding>WINDOWS-1258</Encoding>
<Encoding>ISO-8859-1</Encoding>
<Encoding>ISO-8859-2</Encoding>
<Encoding>ISO-8859-3</Encoding>
<Encoding>ISO-8859-4</Encoding>
<Encoding>ISO-8859-5</Encoding>
<Encoding>ISO-8859-6</Encoding>
<Encoding>ISO-8859-7</Encoding>
<Encoding>ISO-8859-8</Encoding>
<Encoding>ISO-8859-9</Encoding>
<Encoding>US-ASCII</Encoding>
<Encoding>UNICODE-1-1-UTF-8</Encoding>
<Encoding>UNICODE-2-0-UTF-16</Encoding>
<Encoding>UNICODE-2-0-UTF-8</Encoding>
<Encoding>ISO-10646-UCS-2</Encoding>
<Encoding>UCS-4</Encoding>
<Encoding>UCS-2</Encoding>
<Encoding>UTF-16</Encoding>
<Encoding Default="true">UTF-8</Encoding>
</Encodings>
</ISXML>

6. Between the opening and closing Encodings tags, add a new line such as this:

<Encoding>Type_of_Encoding</Encoding>

where Type_of_Encoding indicates the encoding that you want to be available. This should be the value that
InstallShield should use for the encoding attribute of your XML document.

7. Save the Settings.xml file.

InstallShield 2020 User Guide ISP-2600-UG00 361

Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

8. Ensure that your XML code is well formed; if it is not well formed, you may have problems using InstallShield. In most
cases, you can identify improperly formed XML code by opening the Settings.xml file in Internet Explorer. You should
be able to expand and contract the <ISXML> and <Encodings> elements; if you cannot, check the code for errors.

The next time that you open the XML File Changes view in InstallShield, you will see the encoding type that you added as
one of the available options in the Encoding used for a new file list on the Advanced tab for an XML file in the XML File
Changes view.

See Also
Advanced Tab for an XML File
Configuring Advanced Settings for InstallShield

Specifying the Location Where All Virtual Packages Should Be

Built
InstallShield 2020

Edition • Support for virtualization is included in the Premier Edition of InstallShield.

When InstallShield converts an .msi package to a virtual package, it saves the virtual package in a subfolder of the folder
that contains the .msi file by default. In some cases, you may want to specify a different location for generating all of the
virtual packages. For example, if the .msi packages that you are converting are in a read-only location, you may need to
override the default virtual package location with an existing writable location.

InstallShield includes a machine-wide setting that lets you specify an existing writable location where all virtual packages
should be built. The following instructions explain how to configure this global setting.

Caution • The following instructions require that you modify the Settings.xml file that is installed with InstallShield. This file
contains critical data; if it is edited incorrectly, it can cause InstallShield to fail to work. Use extreme care when editing this file.

Task To specify the location where all virtual packages should be built:

1. Close InstallShield.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language version of InstallShield you are using:

• English—InstallShield Program Files Folder\System\0409

• Japanese—InstallShield Program Files Folder\System\0411

3. Create a back-up copy of the Settings.xml file, in case you later need to revert to the original version.

4. Use a text editor or XML file editor to open the Settings.xml file.

5. Search for the <Virtualization> element and its child element. They look something like this:

<Virtualization>
<!-- Instructions on how to specify a global path -->
<GlobalBuildRedirectFolder></GlobalBuildRedirectFolder>

362 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

</Virtualization>

6. Enter the global path as the text content for the <GlobalBuildRedirectFolder> element. For example, to create the
virtual packages in a subfolder of \\NetworkFolder\VirtualPackages, use the following:

<GlobalBuildRedirectFolder>\\NetworkFolder\VirtualPackages</GlobalBuildRedirectFolder>

Note that the path must already exist. Do not enclose the path within quotation marks.

7. Save the Settings.xml file.

8. Ensure that your XML code is well formed; if it is not well formed, you may have problems using InstallShield. In most
cases, you can identify improperly formed XML code by opening the Settings.xml file in Internet Explorer. You should
be able to expand and contract the <Virtualization> element; if you cannot, check the code for errors.

Whenever you convert an .msi package to a virtual package in InstallShield, InstallShield uses the path that you specified.

See Also
Creating Customized Virtual Applications
Configuring Advanced Settings for InstallShield

Changing the Default Clone_wait Parameter for the Setup

InstallShield 2020

Caution • The following instructions require that you modify the Settings.xml file that is installed with InstallShield. This file
contains critical data; if it is edited incorrectly, it can cause InstallShield to fail to work. Use extreme care when editing this file.

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

In Installshield 2018, a new setting is introduced in settings.xml for Clone_wait parameter. By default, the original setup is
enabled to wait for the completion of the installation process. If you want to generate the setup launcher without the
embedded Clone_wait option, you can change the setting.

The end users can then override this setting with the command line parameter.

Task To change the default Clone_wait parameter for the setup:

1. Close InstallShield.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language version of InstallShield you are using:

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

3. Create a back-up copy of the Settings.xml file, in case you later need to revert to the original version.

InstallShield 2020 User Guide ISP-2600-UG00 363

Chapter 2 Getting Started
Configuring Advanced Settings for InstallShield

4. Use a text editor or XML file editor to open the Settings.xml file.

5. Search for the <Clone_wait> element and its child element. By default, they look something like this:

<Clone_wait default="Yes"/>

6. Edit and change the default Clone_wait parameter to "No".

<Clone_wait default="No"/>

7. Save the Settings.xml file.

8. Ensure that your XML code is well formed; if it is not well formed, you may have problems using InstallShield. In most
cases, you can identify improperly formed XML code by opening the Settings.xml file in Internet Explorer. Check the
code for errors.

See Also
Miscellaneous

Configuring Platform Architecture for Digital Signing

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch

InstallShield 2020 lets you to select platform architecture for digital signing of files.

Task To configure platform architecture for digital signing:

1. Close InstallShield.

2. Find the Settings.xml file that is installed with InstallShield. Settings.xml is installed in one of the following
locations, depending on which language of InstallShield that you are using:

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

3. Create a backup copy of the Settings.xml file, in case you later need to revert to the original version.

4. Use a text editor or XML file editor to open Settings.xml file.

Note • The file should be opened in Administrator mode for modification.

5. Search for the tag <DigitalSignature>. The actual tag is <DigitalSignature Platform="X86"/>.

364 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Sharing Virtual Machine Settings for Distribution of Releases

6. To use a different platform architecture, set Platform to either X86 or X64.

For example,

• To use 32-bit Signing: <DigitalSignature Platform="X86"/>

• To use 64-bit Signing: <DigitalSignature Platform="X64"/>

Note • Invalid entry will automatically use 32-bit Signing.

7. Save the Settings.xml file.

Note • You cannot use 64-bit signing on a 32-bit Operating System.

Sharing Virtual Machine Settings for Distribution of

Releases
InstallShield 2020

Edition • The ability to distribute releases to virtual machines is available in the Premier edition of InstallShield.

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• Suite/Advanced UI

You can configure releases in your projects so that after each successful build of your installation, InstallShield
automatically reverts a virtual machine (VM) to a designated snapshot, powers on the VM, and copies your installation to
the VM to make it available for testing. You can also alternately perform these testing preparation steps on demand at any
time.

When you use the Configuration setting on the Events tab for a selected release in the Releases view to configure VM
details, InstallShield writes the data that you specify to a file called VMConfigurations.xml. This VMConfigurations.xml
file is a machine-wide file that you can configure once and then use it in other InstallShield projects, as well as share it with
other team members. You can also use this file with the Standalone Build.

The following instructions explain how to share this global file with others.

InstallShield 2020 User Guide ISP-2600-UG00 365

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Task To share the customized VM configuration settings file with another machine that has InstallShield or the Standalone
Build:

1. On your development machine, configure the VM settings for a release in one of your projects. To learn how, see
Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand.

2. Close InstallShield.

3. Find the VMConfigurations.xml file that is installed with InstallShield, and make a copy of it for the other machine.
VMConfigurations.xml is installed in one of the following locations, depending on which language version of
InstallShield you are using:

• English—InstallShield Program Files Folder\Support\0409

• Japanese—InstallShield Program Files Folder\Support\0411

4. Create a back-up copy of the VMConfigurations.xml file that is on the other machine, in case you later need to revert
to the original version, and then overwrite the installed version with the one from your development machine.

If you use the Standalone Build to build a release, update the VMConfigurations.xml file that is installed with the
Standalone Build. VMConfigurations.xml is installed in one of the following locations, depending on which language
version of InstallShield you are using:

• English—Standalone Build Program Files Folder\Support\0409

• Japanese—Standalone Build Program Files Folder\Support\0411

Tip • If you make any manual changes to the XML file in a text editor, ensure that your XML code is well formed; if it is not well
formed, you may have problems using InstallShield. In most cases, you can identify improperly formed XML code by opening
the VMConfigurations.xml file in Internet Explorer. You should be able to expand and contract the <VMConfigurations>
element; if you cannot, check the code for errors.

See Also
Distributing Releases to a Virtual Machine that InstallShield Provisions at Build Time or on Demand

Upgrading from Earlier InstallShield Versions

InstallShield 2020

When you start using InstallShield 2020, you can upgrade installation projects that you created using earlier versions or
different InstallShield products. This section discusses those upgrades.

• Upgrading Projects from InstallShield 2014 or Earlier

• Upgrading Projects from InstallShield 2013 or Earlier

• Upgrading Projects from InstallShield 2012 Spring or Earlier

• Upgrading Projects from InstallShield 2012 or Earlier

• Upgrading Projects from InstallShield 2011 or Earlier

• Upgrading Projects from InstallShield 2010 or Earlier

366 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• Upgrading Projects from InstallShield 2009 or Earlier

• Upgrading Projects from InstallShield 2008 or Earlier

• Upgrading Projects from InstallShield 12 or Earlier

• Upgrading Projects from InstallShield 11.5 or Earlier

Upgrading Projects from InstallShield 2014 or Earlier

InstallShield 2020

The following information describes possible upgrade issues that may occur when you upgrade projects that were created
with InstallShield 2014 and earlier to InstallShield 2020. It also alerts you to possible changes in behavior that you may
notice between new InstallShield 2020 projects and projects that are upgraded from InstallShield 2014 or earlier to
InstallShield 2020.

General Information about Upgrading Projects that Were Created in Earlier Versions of
InstallShield
If you use InstallShield 2020 to open an project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .775 (for an .ism project) or .2014 (for an
.issuite project) before converting it. Delete the .775 or .2014 part from the original project’s file name if you want to reopen
the project in the earlier version of InstallShield. Note that you cannot open InstallShield 2020 projects in earlier versions of
InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2020: InstallShield
2014 and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and InstallShield Developer 8 and earlier.
Note that projects that were created with InstallShield MultiPlatform or InstallShield Universal cannot be upgraded to
InstallShield 2020.

Changes to the List of Supported Versions of Windows for Target Systems

Windows XP SP3 and Windows Server 2003 SP2 are now the minimum versions of Windows that are required for target
systems that run the installations that are created in InstallShield; this applies to all project types.

Removal of Support for Digitally Signing with .spc and .pvk Files
InstallShield no longer has support for using .spc and .pvk files to digitally sign files at build time.

If you configured a release or patch in InstallShield 2014 or earlier to be digitally signed at run time with .spc and .pvk files,
and then you try to open that project in InstallShield 2020, InstallShield displays upgrade warning -6048 (for a release), -
6049 (for a patch), or -6050 (for a QuickPatch project). The warning explains that InstallShield is removing the .pvk file and
the associated password from your project during the upgrade.

Before you can successfully build the release or the patch in InstallShield 2020, you will need to remove the .spc reference
from the release or patch configuration. You can replace it with a .pfx certificate, or with a reference to a certificate in a
certificate store. To learn more, see:

• Digital Signing and Security

• Digitally Signing a Release and Its Files at Build Time

• Signing a Patch Package

InstallShield 2020 User Guide ISP-2600-UG00 367

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• Signing a QuickPatch Package

If you try to build a release or a patch without removing the .spc reference from it, InstallShield displays build error -7347,
stating that the .spc file must be removed.

To learn how to convert an .spc file and a .pvk file to a .pfx file, see Digital Signing and Security.

Automation Interface Changes for Digital Signature Support

The ISWiRelease object no longer includes support for the following read-write properties:

• CorrespondingPrivateKey

• SoftwarePublishingCredentials

If you call those properties, you will encounter an error. Those properties have been replaced with the read-write string
property DigitalCertificateInfo.

To learn more, see ISWiRelease Object.

Removal of SignTool.exe and Signcode.exe from InstallShield Installation

SignTool.exe and Signcode.exe are no longer installed on your machine when you install InstallShield. If you want to
digitally sign your files manually, consider using SignTool.exe, which is installed with Visual Studio and included in the
Microsoft Windows Software Development Kit (SDK).

Changes to the PowerShell Support in Basic MSI and InstallScript MSI Installations
The PowerShell custom action support in Basic MSI and InstallScript MSI installations has been revised. The support no
longer uses the Windows Installer property IS_PS_EXECUTIONPOLICY to indicate the name of the PowerShell execution
policy that you want to be used to run PowerShell custom actions on target systems. Setting this property at run time no
longer has any effect on the installation.

Changes to Default Eligibility Conditions for .msi Packages in Advanced UI and Suite/
Advanced UI Projects
To make it possible to support shared packages in Advanced UI and Suite/Advanced UI projects, InstallShield no longer
needs the previously required MSI Package eligibility conditions for .msi packages. Now you can limit the use of eligibility
conditions of .msi packages to check for run-time environment requirements such as platform.

Now when you add an .msi package to an Advanced UI or Suite/Advanced UI project in InstallShield 2020, InstallShield no
longer creates an MSI Package eligibility condition for that package by default. This behavior applies to new InstallShield
2020 projects, as well as projects that you created in InstallShield 2014 or earlier and then upgrade to InstallShield 2020.

In addition, if you upgrade an InstallShield 2014 or earlier project that contains the old default MSI Package eligibility
condition for an .msi package to InstallShield 2020, InstallShield removes the unnecessary part of the condition from the
Eligibility Condition setting for the package.

In some cases, if you customized the default MSI Package eligibility condition in InstallShield 2014 or earlier, InstallShield
2020 may remove it during the upgrade; in other cases, InstallShield leaves it as is. The actual upgrade behavior depends
on the customization. For example, if you simply added a platform condition, InstallShield may be able to remove the
original MSI Package part of the condition, leaving just the platform condition. However, if the customization is too
complex, InstallShield leaves the condition as is.

It is recommended that you review the eligibility conditions for your .msi packages after upgrading to InstallShield 2020 to
ensure that they are configured as expected.

368 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

If you have customized or somehow otherwise edited the default MSI Package eligibility condition, InstallShield leaves
your custom condition during the upgrade. It is recommended that you review the eligibility conditions for your .msi
packages to ensure that they are configured as expected.

Previously, the default MSI Package condition for the Eligibility Condition setting of .msi packages used asterisks (*) in the
condition’s Product Code and Product Version settings as placeholders for the package’s own product code and product
version.

Changes to the Interpretation of Ampersands in the Wizard Interface of Advanced UI

and Suite/Advanced UI Installations
The interpretation of ampersands in certain areas of the wizard interface of Advanced UI and Suite/Advanced UI projects
has been modified.

For new InstallShield 2020 projects, as well as projects that you created in InstallShield 2014 or earlier and then upgrade to
InstallShield 2020, if you use an ampersand (&) in any of the following areas of the wizard interface of your installation, the
installation now displays the ampersand as a literal character instead of interpreting it as a prefix character for a keyboard
shortcut. The change also applies if any of these strings include a property that resolves to a value that contains an
ampersand.

• The string in the header area of a wizard page or secondary window—This is configured in the Title setting for a wizard
page or window in the Wizard Interface view.

• The caption bar of wizard pages—This is configured in the Wizard Caption setting for the Wizard Pages node in the
Wizard Interface view.

• The supplemental explanation area of a command link control—This is configured in the Note setting for a wizard
page or window.

• The alternate text for an image control—This is configured in the Alt Text setting of an image control on a wizard page
or window.

Furthermore, for most label controls, True is now selected by default for the SS_NOPREFIX subsetting under the Style
setting; previously False was selected by default. A True value for this subsetting ensures that any ampersands that are
included in the string entries for such controls are not inadvertently interpreted as keyboard shortcuts, and that
ampersands in the control's strings are displayed as ampersands in the wizard interface.

These SS_NOPREFIX changes apply to the built-in default and predefined wizard pages and windows that are available for
new InstallShield 2020 projects. If you upgrade an InstallShield 2014 or earlier project to InstallShield 2020, the
SS_NOPREFIX settings are changed automatically for the standard built-in default wizard page and windows. However, no
changes are made automatically to custom wizard pages and windows—including the predefined wizard pages—when you
upgrade these projects to InstallShield 2020; if you want to change the ampersand interpretation of these, you can do so
manually

Previously, to work around problems with an ampersand being used inadvertently to designate a keyboard shortcut in any
of the aforementioned areas of the wizard interface, and instead show a single ampersand, it was possible to use an
escaped ampersand (&&) in place of a single ampersand. However, if you upgrade a project that contains one or more
instances of those workarounds to InstallShield 2020, the escaped ampersand is now displayed literally as two
ampersands. Thus, it may be necessary to review the use of ampersands in the wizard interface of your projects and make
changes as needed.

For more information, see Designating Keyboard Shortcuts and Using Ampersands (&) in the Wizard Interface.

InstallShield 2020 User Guide ISP-2600-UG00 369

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Trialware Support
InstallShield no longer includes support for creating the Try and Die or the Try and Buy/Product Activation types of
trialware. The Trialware view is no longer included in InstallShield.

See Also
What’s New in InstallShield 2015
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 2013 or Earlier

InstallShield 2020

The following information describes possible upgrade issues that may occur when you upgrade projects that were created
with InstallShield 2013 and earlier to InstallShield 2020. It also alerts you to possible changes in behavior that you may
notice between new InstallShield 2020 projects and projects that are upgraded from InstallShield 2013 or earlier to
InstallShield 2020.

General Information about Upgrading Projects that Were Created in Earlier Versions of
InstallShield
If you use InstallShield 2020 to open an project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .774 (for an .ism project) or .2013 (for an
.issuite project) before converting it. Delete the .774 or .2013 part from the original project’s file name if you want to reopen
the project in the earlier version of InstallShield. Note that you cannot open InstallShield 2020 projects in earlier versions of
InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2020: InstallShield
2013 and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and InstallShield Developer 8 and earlier.
Note that projects that were created with InstallShield MultiPlatform or InstallShield Universal cannot be upgraded to
InstallShield 2020.

Changes that Affect All Projects (New and Upgraded Projects)

This section describes changes that affect both new projects and projects that are upgraded from earlier versions of
InstallShield.

Changes that Affect New Projects but Not Upgraded Projects

This section describes changes to InstallShield that may affect new projects but not projects that are upgraded from earlier
versions. Note that you may need to make manual changes to upgraded projects.

See Also
What’s New in InstallShield 2014
Upgrading from Earlier InstallShield Versions

370 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 2012 Spring or Earlier

InstallShield 2020

The following information describes possible upgrade issues that may occur when you upgrade projects that were created
with InstallShield 2012 Spring and earlier to InstallShield 2020. It also alerts you to possible changes in behavior that you
may notice between new InstallShield 2020 projects and projects that are upgraded from InstallShield 2012 Spring or
earlier to InstallShield 2020.

General Information about Upgrading Projects that Were Created in Earlier Versions of
InstallShield
If you use InstallShield 2020 to open an project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .773 (for an .ism project) or .2012.4 (for an
.issuite project) before converting it. Delete the .773 or .2012.4 part from the original project’s file name if you want to
reopen the project in the earlier version of InstallShield. Note that you cannot open InstallShield 2020 projects in earlier
versions of InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2020: InstallShield
2012 Spring and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and InstallShield Developer 8 and
earlier. Note that projects that were created with InstallShield MultiPlatform or InstallShield Universal cannot be upgraded
to InstallShield 2020.

Changes that Affect All Projects (New and Upgraded Projects)

This section describes changes that affect both new projects and projects that are upgraded from earlier versions of
InstallShield.

Change in Requirements for Target Systems

InstallShield no longer supports the creation of installations for Windows 2000 systems. If end users have Windows 2000 on
their machine and they try to run an installation that was built with InstallShield 2013, the installation may run
successfully. Or, unexpected results may occur, unless the project includes launch conditions that prevent end users from
running the installation on this legacy operating system.

For Basic MSI and InstallScript MSI projects, you may want to consider adding a launch condition that displays a message if
end users are running your installation on a Windows 2000 system. For InstallScript projects, you may want to consider
adding InstallScript code that uses the SYSINFO structure variable to check for Windows 2000 systems, and then display a
message if appropriate.

Advanced UI and Suite/Advanced UI installations now require at least Windows Vista and Windows Server 2008.

InstallShield no longer supports the creation of installations for mobile devices. Thus, the Mobile Devices view, the Smart
Device project type, the Palm OS Object, and the Windows Mobile Object are no longer included in InstallShield. If you try
to upgrade a Smart Device project from InstallShield 2012 Spring or earlier to InstallShield 2020, InstallShield 2020 displays
an error message and fails to open the project. If you upgrade a project from InstallShield 2012 Spring or earlier to
InstallShield 2020, and if the project targets desktop platforms and contains other mobile device support, InstallShield
removes the mobile device support during the upgrade and logs a warning.

InstallShield 2020 User Guide ISP-2600-UG00 371

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Change in Requirements for Systems Running InstallShield

The minimum operating system requirement for running InstallShield, the Standalone Build, and the InstallShield
Developer Installation Manifest (DIM) Editor is now Windows XP SP3 or Windows Server 2003 SP2. Previously, the minimum
operating system requirement was an RTM version of either of these operating systems.

Changes for the Virtualization Pack

The Virtualization Pack is included as part of the standalone version of the Premier Edition of InstallShield. It is no longer
available as an add-on for the Professional edition of InstallShield.

Repackager Project Conversion Tool No Longer Included

The Repackager is no longer included in the Premier edition of InstallShield. Repackager is now available only with
AdminStudio.

Changes to the XML Schema for Advanced UI and Suite/Advanced UI Project Files (.issuite)
Advanced UI and Suite/Advanced UI project files (.issuite) are XML-based files. The underlying XML schema for the user
interface part of the file has changed significantly in InstallShield 2020. Many attributes have been moved to child
elements. Conditions, actions, and validations are fundamentally different: element collections are used instead of
attribute strings. The new schema is more explicit about what is configured for the user interface of the installation.

If you create a new Advanced UI or Suite/Advanced UI project in InstallShield 2020, InstallShield automatically uses the
new XML schema for the .issuite file. If you upgrade a project from InstallShield 2012 Spring or earlier to InstallShield 2020,
InstallShield automatically updates the XML schema.

New Predefined Path Variables for Built-in DLL Custom Actions

InstallShield includes two new predefined path variables in projects: ISRedistPlatformDependentFolder and
ISRedistPlatformDependentExpressFolder. The default values for these folders refer to subfolders in the InstallShield
Program Files Folder\Redist folder, which contains 32-bit versions of built-in InstallShield custom action DLLs. If you
create a new InstallShield 2020 project or upgrade an InstallShield 2012 Spring or later project to InstallShield 2020,
InstallShield automatically includes these two predefined path variables in your project. In addition, InstallShield also uses
these path variables in paths such as the source location of built-in InstallShield DLL custom actions; this applies to new
projects as well as upgraded projects. Previously, InstallShield used either of the following locations as the folder that
contained the DLL files: <ISProductFolder>\Redist\Language Independent\i386 or <ISProductFolder>\Redist\Language
Independent\i386 Express. This change is noted for informational purposes.

Automation Interface Changes

If you use the automation interface with InstallShield or the Standalone Build, update your existing code to reflect the new
ProgID: IswiAutoAutomation Interface Version.ISWiProject. The Standalone Automation Interface uses the same
ISWiAutomationAutomation Interface Version.dll file that InstallShield uses, but it is installed to a different location.

Note that if you install the Standalone Build on the same machine as InstallShield, the last ISWiAutomationAutomation
Interface Version.dll file that is registered is the one that is used.

Changes that Affect New Projects but Not Upgraded Projects

This section describes changes to InstallShield that may affect new projects but not projects that are upgraded from earlier
versions. Note that you may need to make manual changes to upgraded projects.

372 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Changes to the Default Wizard Format for the Suite/Advanced UI and Advanced UI Wizard Interface
If you create a new Suite/Advanced UI or Advanced UI project in InstallShield 2020, the default value for the Wizard Format
setting is Glass, a new option. If you upgrade a Suite/Advanced UI or Advanced UI project from an earlier version of
InstallShield to InstallShield 2020, InstallShield does not change the value of the Wizard Format setting; it leaves whatever
value was selected in the earlier version of InstallShield.

You can configure your project to use to a different wizard format if appropriate. To do so, change the value of the Wizard
Format setting that is displayed in the Wizard Interface view when the Wizard Pages node is selected.

For more information, see Selecting the Format for the Wizard Interface.

Changes to the Font Color of Navigation Button Text in Advanced UI and Suite/Advanced UI Installations
In some scenarios, if you upgrade an Advanced UI or Suite/Advanced UI project from InstallShield 2012 Spring or earlier to
InstallShield 2020, the text on the navigation buttons may no longer be legible: the colors for the text and the buttons may
not have enough contrast. This may occur if light font color is specified for the text style that is used for navigation button
text, and if the target system’s colors are configured to use a light color for buttons on windows.

Beginning with InstallShield 2020, Advanced UI and Suite/Advanced UI installations no longer ignore the font color that is
specified for the text style of text that is used on navigation buttons. Thus, when you upgrade your Advanced UI or Suite/
Advanced UI project to InstallShield 2020, you may need to adjust the color of the text style that is used for the navigation
button text. To do so, in the Wizard Interface view, click the Wizard Pages node, and note the text style that is selected for
the Navigation Text Style setting. Then, find that text style under the Styles node in this view, and adjust its settings as
needed.

In InstallShield 2012 Spring or earlier, Advanced UI and Suite/Advanced UI projects ignored the text style color for
navigation button text. At run time, the installation used the font color that Windows used for navigation buttons; the color
was typically black.

New Support for Shell Properties of Shortcuts

The Shortcuts view in InstallShield now has built-in support for setting several Windows Shell properties of shortcuts:

• The Pin to Windows 8 Start Screen setting sets the System.AppUserModel.StartPinOption property by using the
following GUID and property ID combination:

9F4C2855-9F79-4B39-A8D0-E1D42DE1D5F3, 12

• The Prevent Pinning option in the Shell Properties setting sets the System.AppUserModel.PreventPinning property by
using the following GUID and property ID combination:

9F4C2855-9F79-4B39-A8D0-E1D42DE1D5F3, 9

• The Do Not Highlight as New option in the Shell Properties setting sets the
System.AppUserModel.ExcludeFromShowInNewInstall property by using the following GUID and property ID
combination:

9F4C2855-9F79-4B39-A8D0-E1D42DE1D5F3, 8

Windows Installer may generate errors if one or more of these property names (instead of the GUID and property ID) are
used in a package that is run on a version of Windows that does not have support for these properties.

If you used the Shell Properties setting in InstallShield 2012 Spring or earlier to configure Shell properties for a shortcut,
and you upgrade the project to InstallShield 2020, InstallShield does not automatically replace the property names with
the appropriate GUID and property ID combinations. To quickly switch to the GUID and property ID combination, consider

InstallShield 2020 User Guide ISP-2600-UG00 373

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

deleting the old configuration in the Shell Properties view after upgrading your project, and then using the new support to
reconfigure one or more of these properties. As an alternative, you can manually override the entry with the appropriate
GUID and property ID. To learn more about the built-in support in InstallShield, see Setting Shell Properties for a Shortcut.

This support is available for the following project types: Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database,
MSM Database, and Transform.

See Also
What’s New in InstallShield 2013
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 2012 or Earlier

InstallShield 2020

The following information describes possible upgrade issues that may occur when you upgrade projects that were created
with InstallShield 2012 and earlier to InstallShield 2020. It also alerts you to possible changes in behavior that you may
notice between new InstallShield 2020 projects and projects that are upgraded from InstallShield 2012 or earlier to
InstallShield 2020.

General Information about Upgrading Projects that Were Created in Earlier Versions of
InstallShield
If you use InstallShield 2020 to open an project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .772 (for an .ism project) or .2012 (for an
.issuite project) before converting it. Delete the .772 or .2012 part from the original project’s file name if you want to reopen
the project in the earlier version of InstallShield. Note that you cannot open InstallShield 2020 projects in earlier versions of
InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2020: InstallShield
2012 and earlier, InstallShield 12 and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and
InstallShield Developer 8 and earlier. Note that projects that were created with InstallShield MultiPlatform or InstallShield
Universal cannot be upgraded to InstallShield 2020.

Changes that Affect All Projects (New and Upgraded Projects)

This section describes changes that affect both new projects and projects that are upgraded from earlier versions of
InstallShield.

New Default Behavior When Launching an Earlier Version or the Same Version of a Suite/Advanced UI
Installation on Target Systems
InstallShield now includes two Suite Installed conditions in each Advanced UI and Suite/Advanced UI project by default:

• A new Suite Installed exit condition prevents end users from being able to install the current version of the Advanced
UI or Suite/Advanced UI installation over a future newer version of the same Advanced UI or Suite/Advanced UI
installation.

• A new Suite Installed mode condition now causes the Advanced UI or Suite/Advanced UI installation to run in first-
time installation mode if end users install a new version of the Advanced UI or Suite/Advanced UI installation over an
older version of the same Advanced UI or Suite/Advanced UI installation.

374 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

These new default conditions are available in all new Suite/Advanced UI projects. If you upgrade an InstallShield 2012 Suite
project to InstallShield 2020, InstallShield automatically adds these default conditions to the project. To learn more about
these conditions, see Detecting Whether a Specific Version of an Advanced UI or Suite/Advanced UI Installation Is Already
Installed.

Previously, if an end user installed a particular version of a Suite installation on a target system on which a newer version of
the Suite was already installed, the installation could permit the end user to install the older Suite version over the newer
version. In addition, if an end user installed a particular version of a Suite installation on a target system on which the same
version of the Suite was already installed, the Suite installation could run in first-time installation mode. Furthermore, if an
end user installed a new version of a Suite installation on a target system on which an older version of the Suite was already
installed, the Suite installation could run in maintenance mode.

Automation Interface Changes

If you use the automation interface with InstallShield or the Standalone Build, update your existing code to reflect the new
ProgID: IswiAutoAutomation Interface Version.ISWiProject. The Standalone Automation Interface uses the same
ISWiAutomationAutomation Interface Version.dll file that InstallShield uses, but it is installed to a different location.

Note that if you install the Standalone Build on the same machine as InstallShield, the last ISWiAutomationAutomation
Interface Version.dll file that is registered is the one that is used.

Changes that Affect New Projects but Not Upgraded Projects

This section describes changes to InstallShield that may affect new projects but not projects that are upgraded from earlier
versions. Note that you may need to make manual changes to upgraded projects.

Changes to the Default Behavior of New Combo Boxes in the Wizard Interface of Suite/Advanced UI
Projects
If you create a new combo box control on a wizard page or a secondary window in a Suite/Advanced UI project in
InstallShield 2020, the control is a box that contains a drop-down list of predefined values. The box is also a text box that
lets end users enter a custom value. Previously, if you added a new combo box control in InstallShield 2012, the control
contained a drop-down list, but it was not also a text box; that is, end users could not enter a custom value.

If you upgrade the project from InstallShield 2012 to InstallShield 2020, and if the Suite/Advanced UI wizard interface
includes a combo box, the combo box is left as a drop-down list of predefined values, but it is not also a text box. To change
the control to a drop-down list with the text box, set the CBS_DROPDOWNLIST style for this control to False.

See Also
What’s New in InstallShield 2012 Spring
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 2011 or Earlier

InstallShield 2020

The following information describes possible upgrade issues that may occur when you upgrade projects that were created
with InstallShield 2011 and earlier to InstallShield 2020. It also alerts you to possible changes in behavior that you may
notice between new InstallShield 2020 projects and projects that are upgraded from InstallShield 2011 or earlier to
InstallShield 2020.

InstallShield 2020 User Guide ISP-2600-UG00 375

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

General Information about Upgrading Projects that Were Created in Earlier Versions of
InstallShield
If you use InstallShield 2020 to open a project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .771 before converting it. Delete the .771 part
from the original project’s file name if you want to reopen the project in the earlier version of InstallShield. Note that you
cannot open InstallShield 2020 projects in earlier versions of InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2020: InstallShield
2011 and earlier, InstallShield 12 and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and
InstallShield Developer 8 and earlier. Note that projects that were created with InstallShield MultiPlatform or InstallShield
Universal cannot be upgraded to InstallShield 2020.

Changes that Affect All Projects (New and Upgraded Projects)

This section describes changes that affect both new projects and projects that are upgraded from earlier versions of
InstallShield.

Changes in Behavior for Some MSI APIs That Are Called in InstallScript Custom Actions
A change was made to how the InstallScript engine calls Windows Installer API such as MsiGetProperty. The engine now
calls the Windows Installer APIs directly instead of using wrapper APIs that in turn call the Windows Installer APIs. This
change was made to resolve issues with buffer handling and buffer sizes. It applies to all new projects that you create in
InstallShield 2020, as well as projects that you have upgraded from earlier versions of InstallShield to InstallShield 2020.

As a result of this change, you can use the MSI install handle that is passed to a custom action function with all Windows
Installer APIs that require an install handle. Previously, the handle was managed by the InstallScript engine, and it could
not be passed directly to Windows Installer APIs.

Also as a result of this change, any Windows Installer APIs that require a buffer size to be specified now fail if the buffer size
is not correctly specified. Note that 0 is not a valid size; thus, ensure that your code does not pass a zero value for the size of
the buffer.

If you have existing InstallScript custom actions that call Windows Installer APIs, ensure that a large enough buffer size is
specified; if it is not, unexpected results could occur.

The following sample code demonstrates how to retrieve the value of a Windows Installer property value string in
InstallScript and increase the size of the buffer if necessary.

prototype STRING MyGetProperty (HWND, STRING);

//////////////////////////////////////////////////////////////////////////
// MyGetProperty
//
// Return an MSI property string value
// Input Parameters:
// hMSIHandle: Handle to the currently running MSI database
// szPropertyName: Name of property to retrieve
// Output:
// String containing the property value
//////////////////////////////////////////////////////////////////////////

function STRING MyGetProperty (hMSIHandle, szPropertyName)

NUMBER nvBuf, nResult;
STRING szReturn;

376 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

begin

//Retrieve the size of the property value

szReturn = "";

nResult = MsiGetProperty (hMSIHandle, szPropertyName, szReturn, nvBuf);

if (ERROR_MORE_DATA = nResult) then

nvBuf = nvBuf + 1; //increment buffer size for terminating null

//Retrieve the property value

nResult = MsiGetProperty (hMSIHandle, szPropertyName, szReturn, nvBuf);

if (nResult != ERROR_SUCCESS) then

szReturn = "";
endif;
endif;
return szReturn;
end;

Note that if the script had used if ( ERROR_SUCCESS == nResult ) then instead of if ( ERROR_MORE_DATA == nResult
) then, unexpected results could occur.

Build Warning -7235 for Basic MSI Projects

By default, software identification tagging is enabled in all Basic MSI projects. This applies to new projects that you create
in InstallShield 2020, as well as projects that you have upgraded from earlier versions of InstallShield to InstallShield 2020.

If you build a release in a Basic MSI project without entering data in the required identification tag settings (the Unique ID,
Tag Creator, and Tag Creator ID settings in the General Information view), and you leave tagging enabled in the project,
build warning -7235 occurs. This build warning explains that the software identification tag could not be created and
included in the installation because a specific required setting was left blank. To resolve this warning, enter appropriate
value in each specific setting, or select No for the Use Software Identification Tag setting in the General Information view.

COM Extraction Changes

InstallShield supports a new monitoring method for COM extraction. If you are using InstallShield on a Windows Vista or
later system or a Windows Server 2008 or later system, this new method is used by default. The method uses a kernel driver
to monitor the areas of the registry that are modified during dynamic COM extraction at build time and static COM
extraction at design time. It combines the advantages that the earlier methods provided, allowing the DLL to read existing
registries entries and preventing changes to the build machine.

If necessary, you can switch between the three different COM extraction methods by setting the value data of the
UseAPIRegistryHooks registry value, which is in the registry key HKEY_LOCAL_MACHINE\SOFTWARE\InstallShield\RegSpy
(on 32-bit machines) or HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\InstallShield\RegSpy (on 64-bit machines).
Possible REG_DWORD value data are:

• 0—Use API hooking to read existing registry entries for the DLL.

• 1—Use registry redirection to prevent making changes to the registered DLLs on the build machine. If the value is not
set, this is the default behavior on Windows XP and Windows Server 2003 systems.

• 2—Use the new kernel mode monitoring, which combines the advantages of both of the other methods. If the value is
not set, this is the default behavior on Windows Vista and later systems and on Windows Server 2008 and later
systems.

InstallShield 2020 User Guide ISP-2600-UG00 377

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

This functionality applies to the following project types: Basic MSI, DIM, InstallScript MSI, and Merge Module.

String Entries in Merge Module Projects

Each string identifier that is created in a Merge Module project now contains the Merge Module’s module ID GUID. This
applies to all new string identifiers that are created in all new Merge Module projects, as well as new string identifiers that
are created in existing Merge Module projects that were upgraded from InstallShield 2011 or earlier to InstallShield 2020.
Note that if you upgrade a Merge Module project from InstallShield 2011 or earlier to InstallShield 2020, the module ID GUID
is not added to the string identifiers of any existing string entries.

The use of the GUID in string identifiers of Merge Module project string entries helps to minimize or eliminate conflicts that
would occur if the same string identifier is used in a Merge Module project and also in an installation project that contains
that Merge Module, and if different values are assigned to those two string identifiers.

See Also
What’s New in InstallShield 2012
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 2010 or Earlier

InstallShield 2020

The following information describes possible upgrade issues that may occur when you upgrade projects that were created
with InstallShield 2010 and earlier to InstallShield 2020. It also alerts you to possible changes in behavior that you may
notice between new InstallShield 2020 projects and projects that are upgraded from InstallShield 2010 or earlier to
InstallShield 2020.

General Information about Upgrading Projects that Were Created in Earlier Versions of
InstallShield
If you use InstallShield 2020 to open a project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .770 before converting it. Delete the .770 part
from the original project’s file name if you want to reopen the project in the earlier version of InstallShield. Note that you
cannot open InstallShield 2020 projects in earlier versions of InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2020: InstallShield
2010 and earlier, InstallShield 12 and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and
InstallShield Developer 8 and earlier. Note that projects that were created with InstallShield MultiPlatform or InstallShield
Universal cannot be upgraded to InstallShield 2020.

Changes that Affect All Projects (New and Upgraded Projects)

This section describes changes that affect both new projects and projects that are upgraded from earlier versions of
InstallShield.

End of Integration Support for Visual Studio 2003 and Earlier

If you want to create, edit, and build your InstallShield projects directly within Visual Studio, you must use Visual Studio
2005 or later. InstallShield can no longer be integrated with Visual Studio 2003 or earlier.

378 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Deprecation of InstallScript Objects

InstallScript objects have been deprecated in favor of InstallShield prerequisites. In a future release, InstallShield will no
longer be able to create or consume InstallScript objects, and no predefined InstallScript objects will be provided.
Furthermore, the Merge Module Holder Object will not be available. The recommended alternative for InstallScript objects
is InstallShield prerequisites. You can use the InstallShield Prerequisite Editor to begin creating your own InstallShield
prerequisites so that you are ready to use them once the InstallScript object technology becomes obsolete. You can share
these InstallShield prerequisites among InstallScript, InstallScript MSI, and Basic MSI projects.

InstallShield Builds Only Unicode Versions of Setup.exe and Update.exe; Ability to Create ANSI Versions
Is No Longer Available
Now all Setup.exe and Update.exe files that are built in all project types in InstallShield are Unicode. This applies to all
new Basic MSI, InstallScript, InstallScript MSI, and QuickPatch projects that you create in InstallShield 2020. It also applies
to all projects that you have upgraded from earlier versions of InstallShield to InstallShield 2020. Therefore, the settings
that previously enabled you to specify whether you wanted to build a Unicode version or an ANSI version of the setup
launcher have been removed:

• The Setup Launcher Type setting on the Setup.exe tab for a release in the Releases view has been removed from Basic
MSI projects.

• The Update Launcher Type setting was removed from Basic MSI, InstallScript MSI, and QuickPatch projects.

In Basic MSI and InstallScript MSI projects, this setting was on the Advanced tab for a patch configuration in the Patch
Design view.

In QuickPatch projects, this setting was on the Advanced tab in the Build Settings area of the General Information
view.

Changes to Win32 API Definitions

Now that the InstallScript engine has been updated to support Unicode, the Win32 API functions that are prototyped in the
InstallScript header file ISRTWindows.h have been updated. Where applicable, wide (W) versions of API prototypes have
been added in addition to existing ANSI (A) definitions. For some prototypes, no A or W version is specified; in these cases,
the engine now attempt to use the W version. Previously, the A version was used.

If you upgrade an InstallShield 2010 or earlier project to InstallShield 2020, it is possible that these new prototypes could
conflict with user-defined prototypes of the same APIs. It is recommended that the InstallScript-provided prototypes be
used if possible. However, if you want to use your own prototypes for these Windows APIs instead of the ones that are now
prototyped for InstallScript, add ISINCLUDE_NO_WINAPI_H to the list of preprocessor definitions: On the Build menu, click
Settings. On the Compile/Link tab, in the Preprocessor Defines box, enter ISINCLUDE_NO_WINAPI_H. Otherwise, you may
encounter compile errors.

Ensuring that Your InstallScript Code Supports Unicode

If you use any user-defined Win32 APIs or other external DLL prototypes in your InstallScript code, and the APIs have
versions that support Unicode string input, update the prototypes to use BYVAL/BYREF WSTRING or WPOINTER. In
addition, review the API functions in your code that accept structures as input to ensure that those that contain string or
string pointer members are declared as Unicode as appropriate, if the API requires it.

Update your script to call W versions of Win32 APIs if it is currently calling A versions.

Note that now that the InstallScript engine has been updated to support Unicode, you may see changes in the return
values for the InstallScript function StrLength. As a result, you may need to make changes to your InstallScript code calls to
this function.

InstallShield 2020 User Guide ISP-2600-UG00 379

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

StrLength now behaves the same as StrLengthChars; both of these functions return the number of characters in a given
string variable (that is, the number of code units in the UTF-16-encoded string) up to the first null character. This applies to
all InstallScript projects that are created in InstallShield 2020, as well as all InstallScript projects that you have upgraded
from earlier versions of InstallShield to InstallShield 2020. Previously, StrLength returned the number of characters in a
given string variable before a null character in the ANSI code page. The behavior of StrLengthChars has not changed.

Differential Release Support in InstallScript Projects

A differential release that is created in an InstallShield 2011 or later InstallScript project can update a product only if its
earlier InstallScript installation was also created in InstallShield 2011 or later. If you want to use InstallShield 2011 or later
to create an update for a product whose earlier InstallScript installation was created with InstallShield 2010 or earlier, you
should create a full release, instead of a differential release.

This requirement is necessary because of the Unicode support that is new in the InstallShield 2011 InstallScript engine.
After a differential release is used to update an earlier version of a product on a target system, the earlier version of the
installation (along with the earlier engine run time) is used to run any maintenance operations. Because the InstallShield
2010 and earlier versions of the InstallScript engine cannot read the new Unicode storage format, the installation fails.

Uninstalling 64-Bit Registry Entries that Were Installed by the InstallScript Engine
By default, the InstallScript engine now logs the changes that it makes to the 64-bit part of the registry during an
InstallScript or InstallScript MSI installation on 64-bit target systems. Furthermore, the 64-bit registry changes that are
logged by the InstallScript engine are now uninstalled during uninstallation.

Note that if you created an InstallShield 2010 or earlier installation that wrote 64-bit registry data and you create an
upgrade for your product in InstallShield 2020, the existing 64-bit registry entries that were logged by the base installation
are not removed when the product is uninstalled from a target system. The only way to work around this limitation is to
manually remove the registry data during uninstallation.

Script Editor Changes

Pressing CTRL+SPACEBAR from within the script editor pane in the InstallScript view no longer displays a list of built-in
InstallScript functions that are available for auto completion, as it did in InstallShield 2010 and earlier. Now if you want to
see a list of built-in InstallScript functions for auto completion, you simply need to start typing the first letter or letters of
that function. The pop-up list also contains other InstallScript keywords. To learn more, see Using Auto Completion when
Writing Code in the Script Editors.

The context menu that is displayed when you right-click in a script editor pane is now different than it was in InstallShield
2010 and earlier:

• The context menu no longer contains a Show Whitespace command. To show or hide whitespace characters and
symbols in the script editors, use the Script Editor Properties dialog box. This dialog box also lets you modify other
settings in the script editors, such as font, syntax colors, and line numbering. To access this dialog box, right-click in a
script editor and then click Properties.

• The context menu no longer contains a Make Uppercase command or a Make Lowercase command. To make text in
the script editor uppercase, select it and then press CTRL+SHIFT+U. To make it lowercase, select it and then press
CTRL+U.

• The context menu no longer contains a Find command or a Replace command. To perform a search in a script, press
CTRL+F, and then specify the text that you want to find. To search for a string and replace it with something else, press
CTRL+H and then specify the appropriate information. As an alternative, you can use the Find and Replace commands
on the Edit menu.

For more keyboard shortcuts, see Keyboard Shortcuts for the Script Editors.

380 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

The views that contain the revised script editor are the InstallScript view, the SQL Scripts view, and the Custom Actions and
Sequences view (when you are viewing a VBScript or JScript file in this view).

InstallScript Debugger Changes

If you copy the InstallScript Debugger (ISDbg.exe) from your installation development machine to a debug machine so
that you can debug InstallScript code, you must also now copy the file called SciLexer.dll to the same folder on the
debug machine. You can find SciLexer.dll on your installation development machine in the same folder as the ISDbg.exe
file (InstallShield Program Files Folder\System).

For more information, see Debugging an Installation on Any Computer.

Changes that Affect New Projects but Not Upgraded Projects

This section describes changes to InstallShield that may affect new projects but not projects that are upgraded from earlier
versions. Note that you may need to make manual changes to upgraded projects.

DPI Changes and Their Effect on InstallScript Dialogs

If you have an InstallShield 2010 or earlier InstallScript or InstallScript MSI project that contains one or more edited
InstallScript dialogs and you want to upgrade the project to InstallShield 2020 or later, ensure that your machine uses the
same DPI value that was selected when the InstallScript dialogs were edited. Otherwise, the dialogs may be sized
incorrectly at run time.

Note that once you have upgraded the project, you can change the DPI value on your machine at any time as needed; if you
do, the dialogs are sized correctly at run time. Also note that if you upgrade an InstallShield 2020 or later project that
contains one or more edited InstallScript dialogs to a future version of InstallShield, you do not need to use the same DPI
value during the upgrade.

Changing Design-Time and Build-Time Locations of Existing InstallShield Prerequisites in Existing

Projects
InstallShield now lets you specify the folders where InstallShield should search for InstallShield prerequisite files (.prq
files), their associated data files, and their dependencies. Previously, InstallShield searched for .prq files in the following
location only: InstallShield Program Files Folder\SetupPrerequisites.

If you move any InstallShield prerequisites from the InstallShield Program Files Folder\SetupPrerequisites folder
to a new custom location that you have defined on the Prerequisites tab of the Options dialog box (or any of the other
places where search paths can be defined now), you may need to perform the following steps in InstallShield 2010 or
earlier projects when you upgrade them to InstallShield 2020:

1. In the Redistributables view or the Prerequisites view, clear the check box for each InstallShield prerequisite that is
included in your project but is located in a custom location. Also clear the check box for each InstallShield prerequisite
whose data files or dependencies were moved from the default location to a custom location.

2. Click the new Refresh button.

3. Select the check box for each InstallShield prerequisite that you removed from your project in step 1.

InstallShield removes the path of the prerequisite from the ISSetupPrerequisites table of your project. The full path
was stored in this table in InstallShield 2010 and earlier projects. Note that if you only clear a prerequisite’s check box and
then reselect it without clicking the Refresh button, InstallShield continues to use the full path, rather than just the file
name, in the ISSetupPrerequisites table.

InstallShield 2020 User Guide ISP-2600-UG00 381

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

If you upgrade an InstallShield 2010 or earlier project to InstallShield 2020, change the location of an InstallShield
prerequisite, and then add that prerequisite to your project, you do not need to perform the refresh procedure. Also, if you
create a new project in InstallShield 2020, you do not need to perform the refresh procedure. In both cases, InstallShield
does not include the path in the ISSetupPrerequisites table of your project, which enables you to use the custom
search path, instead of the default path.

Preventing an InstallScript MSI Installation from Overwriting a Future Major Version of the Same
Product
The Upgrades view in new InstallScript MSI projects now contains a major upgrade item called ISPreventDowngrade. This
item prevents end users from being able to install the current version of your product over a future major version of the
same product. If you upgrade an InstallScript MSI project from InstallShield 2010 or earlier to InstallShield 2020, the
ISPreventDowngrade item is not added automatically. You can manually add an ISPreventDowngrade item if appropriate.
To learn how, see the Preventing the Current Installation from Overwriting a Future Major Version of the Same Product.

See Also
What’s New in InstallShield 2011
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 2009 or Earlier

InstallShield 2020

The following information describes possible upgrade issues that may occur when you upgrade projects that were created
with InstallShield 2009 and earlier to InstallShield 2020. It also alerts you to possible changes in behavior that you may
notice between new InstallShield 2020 projects and projects that are upgraded from InstallShield 2009 or earlier to
InstallShield 2020.

General Information about Upgrading Projects that Were Created in Earlier Versions of
InstallShield
If you use InstallShield 2020 to open a project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .768 before converting it. Delete the .768 part
from the original project’s file name if you want to reopen the project in the earlier version of InstallShield. Note that you
cannot open InstallShield 2020 projects in earlier versions of InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2020: InstallShield
2009 and earlier, InstallShield 12 and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and
InstallShield Developer 8 and earlier. Note that projects that were created with InstallShield MultiPlatform or InstallShield
Universal cannot be upgraded to InstallShield 2020.

Installing More than One Edition of InstallShield

Only one edition of InstallShield 2020—Premier, Professional, or Express—can be installed on a system at a time.
Previously, it was possible to install the Express edition on the same system that had the Premier or Professional edition of
the same InstallShield version.

Change to the List of Supported Operating Systems for Running InstallShield

The minimum operating system requirement for systems that run InstallShield (the authoring environment) is now
Windows XP or Windows Server 2003. Previously, the minimum operating system requirement was Windows 2000 SP3.

382 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Changes that Affect All Projects (New and Upgraded Projects)

This section describes changes that affect both new projects and projects that are upgraded from earlier versions of
InstallShield.

Setup.exe No Longer Runs on Windows 9x, Windows NT 4, or Windows Me Systems

Setup.exe installations that are created in InstallShield can no longer be run on Windows 9x, Windows NT 4, or Windows
Me. If an end user tries to launch Setup.exe on a Windows 9x or Windows Me system, Windows displays a message box with
the following error: “The FullSetup.exePathAndFileName file expects a newer version of Windows. Upgrade your Windows
version.” On Windows NT 4 systems, Windows displays a message box with the following error:
“FullSetup.exePathAndFileName is not a valid Windows NT application.”

InstallShield no longer lists these legacy operating systems in any of the areas where target operating systems can be
selected. For example, the Installation Requirements tab of the Project Assistant in Basic MSI and InstallScript MSI projects
no longer lists these operating systems. In InstallScript projects, the Platforms tab on the Project Settings dialog box no
longer lists these operating systems.

If you upgrade an InstallScript project that was created in InstallShield 2009 or earlier to InstallShield 2020, and if the
operating system settings in the earlier project contained references to only these legacy operating systems, InstallShield
replaces the legacy operating system options with the option for targeting all supported platforms.

Windows Installer 1.x Redistributables Are No Longer Available

InstallShield no longer includes Windows Installer 1.x redistributables, since they target only legacy versions of Windows
that are no longer supported. Previously, it was possible to add Windows Installer 1.x redistributables to a project through
the Releases view, or through the Release Wizard.

Redistributable for VBScript Runtime Files Is No Longer Available

InstallShield no longer includes the InstallShield object for VBScript Runtime Files. This redistributable targets only legacy
versions of Windows that are no longer supported.

InstallScript Dialog Source Code Changes

The InstallScript code for built-in InstallScript dialogs has been moved from individual InstallScript script files (.rul) to a
single ISRTScriptDialogs.rul file. In addition, the event class drop-down list in the InstallScript view has a new Dialog
Source option. If you select this option, the event handler drop-down list shows all of the built-in InstallScript dialogs. You
can select any dialog in this list to customize its code.

InstallShield supports backwards compatibility: If you imported dialog source code into an InstallShield 2009 or earlier
project and then you upgrade the project to InstallShield 2020, you can still use that dialog code. However, if you want to
use the dialog sources that are now available when you select the dialogs in the event handler drop-down list, you must
first make some changes to your upgraded project. Otherwise, you may encounter compile errors. In order to use the
dialog code: On the Build menu, click Settings. On the Compile/Link tab, in the Preprocessor Defines box, enter the
following:

_ISSCRIPT_NEW_STYLE_DLG_DEFS

After this definition has been added, if any dialogs had previously been imported into the project in earlier versions of
InstallShield, the code in these imported .rul files may cause compile errors. These errors would need to be resolved.

If _ISSCRIPT_NEW_STYLE_DLG_DEFS is not defined, a warning message is displayed when the Dialog Source option is
selected in the event class drop-down list in the InstallScript view.

InstallShield 2020 User Guide ISP-2600-UG00 383

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

The _ISSCRIPT_NEW_STYLE_DLG_DEFS definition is automatically added to all new projects that are created in
InstallShield 2020.

This functionality applies to the following project types: InstallScript, InstallScript MSI, and InstallScript Object.

InstallScript Header File Changes

The InstallScript header files (.h) have been reorganized. As a result, some of the .h files are obsolete. If an InstallScript file
(.rul) in your project references one or more of these obsolete .h files, a compile warning is displayed whenever you
compile your script or build a release. To resolve the warnings, remove any #include statements that reference the
obsolete .h files, and rebuild the release. Also, ensure that ifx.h is referenced in an #include statement in your Setup.rul
file or in other script files that are referenced by Setup.rul.

InstallScript Changes for Windows API Prototypes

The service-related Windows API prototypes (such as CreateServiceA, StartServiceA, and ControlService) are now
prototyped in ISRTWindows.h for all InstallScript, InstallScript MSI, and InstallScript Object projects. They are also now
prototyped in ISRTWindows.h for all Basic MSI and Merge Module projects that include InstallScript custom actions.

If you want to use your own definitions for these Windows APIs instead of the ones that are now prototyped for
InstallScript, add ISINCLUDE_NO_SERVICEAPI to the list of preprocessor definitions: On the Build menu, click Settings. On
the Compile/Link tab, in the Preprocessor Defines box, enter ISINCLUDE_NO_SERVICEAPI. Otherwise, you may encounter
compile errors.

Note that the constant ISINCLUDE_NO_WINAPI_H now suppresses only Windows API prototypes, not Windows constants
or Windows structure definitions.

Patch Creation (Basic MSI, InstallScript MSI)

InstallShield now uses the Windows Installer 4.5 patching technology to create patches. This change is reported for
informational purposes.

New Custom Actions and Database Tables for IIS Support in Basic MSI and InstallScript MSI Projects
If you add IIS support through the Internet Information Services view in a Basic MSI or InstallScript MSI project in
InstallShield, InstallShield automatically adds several DLL custom actions to your project to support the IIS functionality.
In InstallShield 2020, these custom actions have been enhanced to enable you to add applications to Web sites. In addition,
these actions have been renamed to reflect standard naming conventions:

• ISIISCosting—This custom action replaces the caExtractIISSuppFiles action.

• ISIISRollback—This custom action replaces the caRlbackVRoots action.

• ISIISUninstall—This custom action replaces the caRemoveVRoots action.

• ISIISInstall—This custom action replaces the caCreateVRoots action.

• ISIISCleanup—This custom action replaces the caIISCleanup action.

The entry points of each of the DLL custom actions have been renamed to match the corresponding custom action names.

Note that IIS functionality requires administrative privileges. Therefore, each of these DLL custom actions checks the
Privileged property value. The value must be 1; if it is not, an error is displayed at run time. In InstallShield 2009 and earlier,
each of the IIS custom actions had a Privileged = 1 condition. In InstallShield 2020, this condition is no longer set when you
add new IIS Web sites or other IIS data to your project, since the custom actions check the Privileged property value.

384 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

If you upgrade a Basic MSI or InstallScript MSI project that contains IIS support from InstallShield 2009 or earlier to
InstallShield 2020, InstallShield automatically updates and renames the custom actions accordingly. In addition, if the
condition for an old custom action was not modified from the default condition, InstallShield also removes the Privileged =
1 condition. If a condition was modified, InstallShield leaves the existing condition as is. You can manually modify any of
the conditions if appropriate.

In InstallShield 2020, all of the IIS data is stored in the ISIISItem and ISIISProperty tables. In InstallShield 2009 and
earlier, the IIS data was stored in the following tables: ISIISAppPool, ISIISCommon, ISIISMetaData,
ISIISWebServiceExtension, ISVRoot, ISVRootAppMaps, and ISWebSite. If you upgrade a Basic MSI or InstallScript MSI
project that contains IIS support from InstallShield 2009 or earlier to InstallShield 2020, InstallShield automatically moves
the IIS data to the new tables; InstallShield also deletes the old tables from the project.

For more information, see:

• Managing Internet Information Services

• InstallShield Custom Action Reference

Changes for the Redistributables View

The Redistributables view has a new toolbar and group box area that provide robust search and organizational
functionality. Use the new Show Details button in this view to show or hide the details pane for the selected redistributable
in this view. The details pane provides information such as which files a redistributable installs. The Show Details button
replaces the Show Details and Hide Details links that were previously available in the upper-right corner of this view.

The new group box area is below the new toolbar in the Redistributables view. You can drag and drop column headings
onto this group box area to organize the list of redistributables in a hierarchical format. If you want InstallShield to
separate all of the redistributables in the view into two groups—one whose check box is selected and one whose check box
is cleared—drag the check box column to the group box area. This enables you to easily identify all of the redistributables
that are included in your project. The result is similar to the behavior that previously occurred if you right-clicked any
redistributable and then clicked Show Only Selected Items. Note that the Show Only Selected Items command is no longer
available in the Redistributables view.

For more information, see Working with the Group Box Area in Various Views.

Limiting the UI Level of a Chained .msi Package to that of the Main .msi Package
The UI level for a chained .msi package is now limited to be no higher than that of the parent package’s current UI level. For
example, in the following scenario, the chained .msi package is launched silently: you add a chained .msi package to your
project in the Releases view and select Full UI (/qf) for its UI level setting, but the main installation is launched silently (/qn).
Previously, the chained package showed exactly the UI level that was authored in the Releases view of the main
installation; to restore this behavior, set the property ISChainExceedUILevel equal to the value 1.

Encoding and Related Differences for XML File Changes

If you use the XML File Changes view to configure changes for a file that is already present on the target machine, or that is
being installed as part of your installation, the installation now uses the encoding that is specified in that XML file, rather
than the encoding that is specified in the XML File Changes view. This applies to new projects that are created in
InstallShield 2020, as well as projects that are upgraded from InstallShield 2009 or earlier.

In addition, if the "Always create this element if it does not already exist" check box is cleared for an element that is not
present in the target file, its child elements are no longer created. Thus, for an XML file such as //A/B/C, C is not created on
the target system if B is neither present nor set to be created.

InstallShield 2020 User Guide ISP-2600-UG00 385

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Changes to the Major and Minor Version Registry Entries for the Uninstall Key of InstallScript
Installations
InstallScript installations now always create VersionMajor and VersionMinor registry values in the Uninstall key; the names
of these values now match the entries that are created during Basic MSI and InstallScript MSI installations. This applies to
new installations that are created in InstallShield 2020, as well as installations that are upgraded from InstallShield 2009 or
earlier. Previously, in InstallShield 2009 and earlier, the names of the values that InstallScript installations created were
MajorVersion and MinorVersion; these are no longer created.

In order to use the new registry values, the values of the following InstallScript constants have been changed:

• REGDB_VALUENAME_UNINSTALL_MAJORVERSION is now VersionMajor instead of MajorVersion.

• REGDB_VALUENAME_UNINSTALL_MINORVERSION is now VersionMinor instead of MinorVersion.

When the MaintenanceStart function is called, it creates the updated value names in the registry. By default, it also
deletes the old value names if they exist. If you do not want the old value names to be deleted from target systems, you can
use the new REGDB_OPTIONS option called REGDB_OPTION_NO_DELETE_OLD_MAJMIN_VERSION. If you want to
continue using only the old value names, you must delete the new versions after MaintenanceStart returns.

If REGDB_UNINSTALL_MAJOR_VERSION or REGDB_UNINSTALL_MINOR_VERSION is used with the RegDBGetItem

function, RegDBGetItem first checks for the new value; if the new value is found, the function returns the value data from
the new value. If the new value is not found, the function automatically checks for the old value; if the old value is found,
the function returns the value data from the old value.

To provide backwards compatibility, the following new constants are available:

• REGDB_UNINSTALL_MAJOR_VERSION_OLD

• REGDB_UNINSTALL_MINOR_VERSION_OLD

You can specify these constants with the RegDBGetItem, RegDBSetItem, and RegDBDeleteItem functions to get, set, and
delete the old values.

The following new string constants are also available:

• REGDB_VALUENAME_UNINSTALL_MAJORVERSION_OLD is defined as MajorVersion.

• REGDB_VALUENAME_UNINSTALL_MINORVERSION_OLD is defined as MinorVersion.

For more information, see the following in the InstallScript Language Reference:

• REGDB_VALUENAME_UNINSTALL_MAJORVERSION

• REGDB_VALUENAME_UNINSTALL_MAJORVERSION_OLD

• REGDB_VALUENAME_UNINSTALL_MINORVERSION

• REGDB_VALUENAME_UNINSTALL_MINORVERSION_OLD

• REGDB_UNINSTALL_MAJOR_VERSION_OLD

• REGDB_UNINSTALL_MINOR_VERSION_OLD

• REGDB_OPTIONS

• RegDBSetItem

• RegDBGetItem

• RegDBDeleteItem

386 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Removal of the SdShowMsg Dialog from the List of Editable Dialogs

The Dialog Editor does not currently support dialogs, such as SdShowMsg, that do not have a title bar; if you try to
customize the SdShowMsg dialog, it may get corrupted. Therefore, this dialog is no longer displayed in the Dialogs view as
one of the dialogs that you can edit. To customize this dialog, you should use the SdShowMsg call, not the Dialog Editor.

Automation Interface Changes

The value of the eosAll constant for the OSFilter, which is a member of the ISWiComponent and ISWiRelease objects in the
automation interface, has been changed. The new value is 64028880; previously, it was 5308624. If you are using the value
of this constant to configure the list of operating systems for a component or a release through the automation interface,
you must update your script to use the new value.

For more information, see the following:

• ISWiComponent Object

• ISWiRelease Object

Changes for the Locations of InstallScript Run-Time Script, Library, and Header Files
The InstallScript run-time library files that are installed with InstallShield have been consolidated into a central location,
instead of several separate subdirectories. The script, library, and header files are now installed in Src, Lib, and Include
folders in the following directory:

InstallShield Program Files Folder\Script\Isrt

The following folders are no longer installed, since the files within them are consolidated in the above location:

InstallShield Program Files Folder\Script\IISRuntime

InstallShield Program Files Folder\Script\SQLRuntime

InstallShield Program Files Folder\Script\XMLRuntime

Note that because of a name conflict, the Assert.h file in the following location is being renamed as ISAssert.h:

InstallShield Program Files Folder\Script\Isrt\Include

If you create a new project in InstallShield 2020, it uses the new locations of the files. If you upgrade a project from
InstallShield 2009 or earlier to InstallShield 2020, InstallShield updates the projects to use the new locations.

Changes in the Way that Linked Libraries and Their Locations Are Specified
The Compile/Link tab on the Settings dialog box has a new Additional Library Paths box that lets you specify the locations
where the InstallScript compiler should search for InstallScript libraries (.obl files) that are not one of the standard
InstallShield locations. For InstallScript and InstallScript Object projects, the standard locations are:

• <ISProductFolder>\Script\Ifx\Lib

• <ISProductFolder>\Script\Isrt\Lib

For Basic MSI and InstallScript MSI projects, the standard locations are:

• <ISProductFolder>\Script\Iswi\Lib

• <ISProductFolder>\Script\Isrt\Lib

InstallShield 2020 User Guide ISP-2600-UG00 387

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

If you create a new project in InstallShield 2020, InstallShield automatically lists the standard InstallShield script libraries
such as ISRT.obl in the Libraries (.obl) box on the Compile/Link tab. However, InstallShield no longer includes the full path
in that box. If you want to add your own custom libraries, you can specify the library file name in the Libraries (.obl) box,
and the path in the Additional Library Paths box. You do not need to specify the full path and file name in the Libraries (.obl)
box.

If you upgrade a project that was created in InstallShield 2009 or earlier to InstallShield 2020, InstallShield automatically
removes the path of the standard script libraries that are listed in the Libraries (.obl) box. For more information, see
Compile/Link Tab.

Removal of the InstallScript Structure Definition for ISOSVERSIONINFO

The definition of the ISOSVERSIONINFO structure, as well as the corresponding unused global instances of this structure,
has been removed. The equivalent OSVERSIONINFO structure is still available. This definition removal does not cause any
functionality changes; however, if you attempt to use the ISOSVERSIONINFO structure definition or global structure
instances, a compiler error results.

To avoid a compiler error, do either of the following:

• Update the script to use the equivalent OSVERSIONINFO structure, and declare a local instance of this structure if
needed. Update the script to use the appropriate structure member names. (Note that the OSVERSIONINFO member
names are different than the ISOSVERSIONINFO member names.) Following is the definition of OSVERSIONINFO:

typedef OSVERSIONINFO
begin
NUMBER nOSVersionInfoSize;
NUMBER nMajorVersion;
NUMBER nMinorVersion;
NUMBER nBuildNumber;
NUMBER nPlatformId;
STRING szCSDVersion[128];
end;

• Declare the structure and structure instances locally as follows:

// Data structure that contains operating system version information.

// Used by ISCompareServicePack.
typedef ISOSVERSIONINFO // define a structure
begin
LONG ISIOSVersionInfoSize; // Size in bytes of this data structure
LONG ISIMajorVersion; // Major version number of the OS.
LONG ISIMinorVersion; // Minor version number of the OS.
LONG ISIBuildNumber; // Build number of the OS.
LONG ISIPlatformId; // Operating system platform.
STRING szISCSDVersion [128]; // Additional information about OS.
end;

// Variable for the operating system version information data structure.

// Used by ISCompareServicePack.
ISOSVERSIONINFO ISVersion;

// Pointer that points to the OS version information variable.

// Used by ISCompareServicePack.
ISOSVERSIONINFO POINTER pISVersion;

388 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Obsolete Keys Are No Longer Written to Setup.ini for InstallScript Projects

The following keys are obsolete and are no longer written to the Setup.ini file for InstallScript projects: Resource,
EngineVersion, and EngineBinding.

ISCab.exe Is No Longer Available

ISCab.exe is no longer supported. Therefore, it is no longer included with InstallShield.

Changes that Affect New Projects but Not Upgraded Projects

This section describes changes to InstallShield that may affect new projects but not projects that are upgraded from earlier
versions. Note that you may need to make manual changes to upgraded projects.

Changes to Support for Securing Permissions for Files, Folders, and Registry Keys
The General Information view has a new Locked-Down Permissions setting that lets you specify whether you want to use
the new custom InstallShield handling or the traditional Windows Installer handling for all new permissions that you set for
files, folders, and registry keys in your project. The new custom InstallShield handling option offers several advantages
over the traditional Windows Installer handling option.

In all new projects, the default value for this setting is the custom InstallShield handling option. If you upgrade a project
from InstallShield 2009 or earlier to InstallShield 2020, the traditional Windows Installer handling option is the default
value of this setting.

This new setting is available in the following project types: Basic MSI, InstallScript MSI, Merge Module, MSI Database, MSM
Database, and Transform.

For more information, see the following:

• Securing Files, Folders, Registry Keys, and Windows Services in a Locked-Down Environment

• Selecting the Locked-Down Permissions Type for a Project

Changes to the ReadyToInstall Dialog for Beta Windows Installer 5 Support of Per-User Installations
The General Information view has a new Show Per-User Option setting. This setting lets you specify whether you want the
ReadyToInstall dialog—in certain scenarios—to include buttons that let end users indicate how they want to install the
product: for the current user or for all users. The per-user button sets the new Windows Installer property
MSIINSTALLPERUSER equal to 1 to indicate that the package should be installed for the current user. The
MSIINSTALLPERUSER property is available with the beta of Windows Installer 5.

If you create a new Basic MSI project in InstallShield 2020, the ReadyToInstall dialog includes support for the per-user and
per-machine buttons; these buttons are displayed or hidden at run time if appropriate. If you upgrade a Basic MSI project
from InstallShield 2009 or earlier to InstallShield 2020, the ReadyToInstall dialog does not have this support automatically.
You can manually add these buttons and their associated conditions to the ReadyToInstall dialog if appropriate; use the
ReadyToInstall dialog in a new InstallShield 2020 project as a guideline.

Public Directory Properties for Feature Destinations Are Added to SecureCustomProperties

When you specify a location for the Destination setting of a feature and the location includes a public directory property,
InstallShield now adds that property to the SecureCustomProperties property to allow end users to change the
destination after the product has been advertised. This occurs in new projects that are created in InstallShield 2020. The
change is also made for all feature destinations if you upgrade a project from InstallShield 2009 or earlier to InstallShield
2020.

InstallShield 2020 User Guide ISP-2600-UG00 389

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

This change applies to the following project types: Basic MSI and InstallScript MSI.

Changes to the Conditions for the InstallWelcome Dialog and the ResolveSource Action
The condition on the InstallWelcome dialog and the ResolveSource action has been changed to Not Installed for all new
Basic MSI projects that are created in InstallShield 2020. The conditions were changed so that the InstallWelcome dialog
and the ResolveSource action can be used for a first-time installation with a patch. If you upgrade a Basic MSI project from
InstallShield 2009 or earlier to InstallShield 2020, the conditions are not changed automatically. If you want the dialog and
action to be used for a first-time installation with a patch, you can change the conditions in your upgraded project to Not
Installed.

Improvements to the .rtf File Size Limit for the SdLicenseRtf and SdLicense2Rtf Functions
The file size limit for the .rtf files that are used with the InstallScript dialog functions SdLicenseRtf and SdLicense2Rtf is
now 16 MB instead of 64 KB. Previously, if the file size was more than 64 KB, part of the EULA text was missing from the
license dialog at run time.

Note that if you had overridden the SdLicenseRtf or SdLicense2Rtf functions in your script in InstallShield 2009 or earlier
and then upgraded that project to InstallShield 2020, you would need to manually change the size limit by updating the
SendMessageTimeout call with the EM_EXLIMITTEXT message in DLG_INIT. The iParam parameter (the fourth parameter)
of the SendMessageTimeout call needs to be changed. The SendMessageTimeout call should be changed to this:

SendMessageTimeout( hEdit, EM_EXLIMITTEXT, 0, 0xffffff );

Previously, the code contained this:

SendMessageTimeout( hEdit, EM_EXLIMITTEXT, 0, 0 );

Removal of the OnResolveSource Event Handler from InstallScript MSI Installations

The InstallScript event handler OnResolveSource has been removed from InstallScript MSI projects. The Windows Installer
now handles all source resolution. If you added the OnResolveSource event to an InstallScript MSI project in InstallShield
2009 or earlier and then you upgrade that project to InstallShield 2020, that event will no longer be called.

Changes to the Way that a Log File Is Displayed from the SetupCompleteSuccess Dialog in Basic MSI
Installations
The ShowMsiLog custom action now launches Notepad.exe from the SystemFolder directory, instead of from the
WindowsFolder directory. Thus, if your installation is run on Windows Vista or later and the end user indicates on the
SetupCompleteSuccess dialog that they want to view the log file, the installation launches Notepad.exe from the
SystemFolder directory. This change was made because on Windows Server 2008 Standard Edition, Notepad.exe is
available in the System32 directory, but not the Windows directory.

Note that behavior is available by default in all new Basic MSI projects that are created in InstallShield. If you upgrade an
InstallShield 2009 or earlier Basic MSI project to InstallShield 2020, InstallShield does not automatically change the
behavior. You can manually change the behavior if necessary: In the Custom Actions and Sequences view, click the
ShowMsiLog action. (If this action is not displayed, right-click the Custom Actions node and then click Show All Custom
Actions.) Set the Filename & Commandline setting as follows:

[SystemFolder]notepad.exe "[MsiLogFileLocation]"

Thus, the value should contain [SystemFolder] instead of [WindowsFolder].

390 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Changes for ALLUSERS Property in InstallScript MSI Installations

Beginning with InstallShield 2010, the ALLUSERS property is set to 1 by default in all new InstallScript MSI projects. This is
the recommended implementation, since most installations must be run in a per-machine context with administrative
privileges. This value is also recommended to help avoid ALLUSERS-related issues when an InstallScript MSI installation is
run silently.

If you upgrade a project that was created with InstallShield 2009 or earlier to InstallShield 2020, InstallShield does not
automatically change the value of the ALLUSERS property or add this property if it was not defined in the earlier project.

InstallScript Installations No Longer Include _Setup.dll

InstallScript installations no longer include _Setup.dll. Some earlier versions (DevStudio 9 and InstallShield X) did not log
_Setup.dll for uninstallation. As a result, this file was left behind in the Disk1 folder location (DISK1TARGET) after
uninstallation. If an update was created with a later InstallShield version (InstallShield 10.5 through InstallShield 2009) and
the update was for an original installation that was created with DevStudio 9 or InstallShield X, _Setup.dll was deleted
during uninstallation because _Setup.dll was logged by the update. Since _Setup.dll is not included in InstallScript
installations that are created with InstallShield 2020, the _Setup.dll file may now be left behind. Therefore, if you are
updating from an installation that was created with DevStudio 9 or InstallShield X, you may need to delete the _Setup.dll
file manually (DISK1TARGET ^ "_Setup.dll") during uninstallation to ensure that the uninstallation is complete.

Saving a Project as an Earlier Version

InstallShield no longer has support for downgrading a project. That is, you cannot save an InstallShield 2020 project as an
InstallShield 2009 or earlier project.

Trialware Support
The only edition of InstallShield that includes the Trialware view is the Premier edition. This edition lets you create the Try
and Die type of trialware. InstallShield no longer includes support for creating the Try and Buy/Product Activation type of
trialware.

Web Projects
The Web project type is no longer listed as one of the types of new projects that you can create in InstallShield. To use the
same functionality that was available with a Web project in InstallShield 2009 and earlier, create a Basic MSI project, and
then add a Web site in the Internet Information Services view.

The only difference between a Web project and a Basic MSI project was that a new Web project automatically contained a
predefined folder for the IISROOTFOLDER directory in the Files and Folders view. All of the files that you add to the
IISROOTFOLDER directory are installed to the Web server’s root directory on the target system. InstallShield adds
predefined folder for the IISROOTFOLDER directory to a Basic MSI project when you add a Web site to the project. Thus, a
Basic MSI project that contains at least one Web site configured in the Internet Information Services view is equivalent to a
Web project that was created in InstallShield 2009 or earlier.

Compact Projects
InstallShield no longer has support for Compact projects.

Visual Studio Integration

Microsoft Visual Studio can be integrated with only one version of InstallShield Premier Edition or InstallShield
Professional Edition at a time. The last version of InstallShield that is installed or repaired on a system is the one that is
used for Visual Studio integration.

InstallShield 2020 User Guide ISP-2600-UG00 391

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

See Also
What’s New in InstallShield 2010
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 2008 or Earlier

InstallShield 2020

The following information describes possible upgrade issues that may occur when you upgrade projects that were created
with InstallShield 2008 and earlier to InstallShield 2020. It also alerts you to possible changes in behavior that you may
notice between new InstallShield 2020 projects and projects that are upgraded from InstallShield 2008 or earlier to
InstallShield 2020.

General Information about Upgrading Projects that Were Created in Earlier Versions of
InstallShield
If you use InstallShield 2020 to open a project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .766 before converting it. Delete the .766 part
from the original project’s file name if you want to reopen the project in the earlier version of InstallShield. Note that you
cannot open InstallShield 2020 projects in earlier versions of InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2020: InstallShield
2008, InstallShield 12 and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and InstallShield
Developer 8 and earlier. Note that projects that were created with InstallShield MultiPlatform or InstallShield Universal
cannot be upgraded to InstallShield 2020.

Changes that Affect All Projects (New and Upgraded Projects)

This section describes changes that affect both new projects and projects that are upgraded from earlier versions of
InstallShield.

New Default Setup Launcher Value for New Releases: Windows Installer Is Not Included
When you create a new release in a Basic MSI or InstallScript MSI project, the redistributable for the Windows Installer
engine is no longer included by default:

• If you use the Release Wizard to create a new release, the Setup Launcher panel is where you specify whether to
include the Windows Installer. The default value for the Support these operating systems setting is Do not install
Windows Installer. Previously, the default value was Both Windows 9X and NT.

• If you create a new release by right-clicking the Releases explorer in the Releases view, the default value for the Setup
Launcher setting on the Setup.exe tab is now Yes (no MSI engine included). Previously, the default value for this
setting was Yes (include Windows NT & Windows 9x MSI engine).

This change applies to all new releases that are created in new InstallShield 2020 projects.

If you upgrade a project from InstallShield 2008 or earlier to InstallShield 2020, this change applies to all new releases;
InstallShield does not automatically change the value for releases that were originally created in the earlier InstallShield
version.

392 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Upgrade and Patch Validation

When you build QuickPatch projects, InstallShield now runs patch and upgrade validation. Therefore, when you build a
QuickPatch package in InstallShield 2020, you may see validation errors and warnings. If you built a QuickPatch project in
InstallShield 2008 or earlier, InstallShield did not run the upgrade and patch validation; thus, patch or upgrade validation
errors or warnings were never displayed at build time.

In addition, the Val0015 warning now checks the ISSelfReg table in QuickPatch projects and in patches that are created
through the Patch Design view in Basic MSI and InstallScript MSI projects. If a QuickPatch or patch project adds a row to the
ISSelfReg table, Val0015 warns you that the patch will be uninstallable. Previously, Val0015 did not check for entries in
this table.

File Compression for Files that Are Streamed into Setup.exe and ISSetup.dll at Build Time
If you build a release that uses a Setup.exe setup launcher or a ISSetup.dll file, InstallShield now compresses files that it
streams into the Setup.exe file or the ISSetup.dll file at build time. The default compression level that InstallShield uses
offers a balance between file size and time that is required to extract the compressed files at run time. This applies to new
Basic MSI and InstallScript MSI projects as well as existing Basic MSI and InstallScript MSI projects that are upgraded from
InstallShield 2008 or earlier to InstallShield 2020.

If you want to change the compression level or you do not want to use any compression, you can override the default level
through a machine-wide setting. For more information, see Configuring the Compression Level for Files that Are Streamed
into Setup.exe and ISSetup.dll.

Previously, InstallShield did not include any support for compressing files that were streamed into the Setup.exe file or the
ISSetup.dll file at build time. Thus, if you compare a release that was built in InstallShield 2008 or earlier with the same
release that is built with the default compression level in InstallShield 2020, you may notice that the file size of Setup.exe
or ISSetup.dll is slightly different. In addition, the time that is required to extract files may be slightly different.

Multi-Part .cab Files

InstallShield now has a default limit of 600 MB for each .cab file that it creates at build time for a network image release in
which the compression type is the standard compression type (not custom compression) and all of the files are embedded
in a single-file .msi package or a Setup.exe setup launcher. When InstallShield is creating the .cab files for this type of
release and it reaches this limit, it splits the data into two or more .cab files, creating multi-part .cab files. This applies to
new Basic MSI and InstallScript MSI projects as well as existing Basic MSI and InstallScript MSI projects that are upgraded
from InstallShield 2008 or earlier to InstallShield 2020.

You can modify the .cab size limit if necessary. In addition, if you do not want InstallShield to create multi-part .cab files,
you can configure it to create single .cab files. For more information, see Configuring the Maximum Size for .cab Files.

Previously, InstallShield did not create multi-part .cab files, and there was no built-in limit for the .cab file size.

Automation Interface and Standalone Build

If you have existing automation scripts that work with the InstallShield Automation Interface, you no longer need to
change the library name from IswiAutoN to SAAutoN (where N indicates the version number) throughout the scripts in order
to use them with the Standalone Automation Interface.

The Standalone Build that is available with InstallShield Premier Edition now uses the same directory structure that
InstallShield uses.

The ISCmdBld.exe file that is used for command-line builds with InstallShield is now installed with the Standalone Build.
Previously, the Standalone Build used IsSaBld.exe, a different file, for command-line builds.

InstallShield 2020 User Guide ISP-2600-UG00 393

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

FlexNet Connect Support in InstallScript Projects

InstallScript projects no longer include an Update Notifications view, which is used to add FlexNet Connect support to an
installation.

Note the following details about FlexNet Connect support in InstallScript projects:

• InstallShield does not add ISUS.obl to the list of libraries (or enable any other FlexNet Connect functionality) when
ISEnableUpdateService is changed to 1 in the InstallShield table. The ISUS.obl library is no longer supported.

• If you upgrade an InstallScript project from InstallShield 2008 or earlier to InstallShield 2020, InstallShield
automatically disables FlexNet Connect support and removes the ISUS.obl from the list of linked script libraries.

• The InstallScript constants and functions for FlexNet Connect still compile. However, all of the functions—except for
UpdateServiceGetAgentTarget—now return ISERR_NOT_IMPLEMENTED. UpdateServiceGetAgentTarget returns
null ("").

• All calls to the InstallScript functions for FlexNet Connect were removed from the default InstallScript code. In the
OnUpdateUIBefore event handler, the code for UpdateServiceOnEnabledStateChange was removed. In the
OnMoveData event handler, the code blocks for UpdateServiceRegisterProduct and UpdateServiceCreateShortcut
were removed.

Note that if you upgrade an InstallScript project from InstallShield 2008 or earlier to InstallShield 2020 and you had
overridden these events in the earlier version of your project, the aforementioned functions are called. This should not
cause any problems. The functions now return ISERR_NOT_IMPLEMENTED.

Also, the OnFirstUIAfter event handler was updated to not include the option of calling SdFinishUpdate, which was
disabled previously by default.

• All FlexNet Connect–related run-after-reboot functionality was removed. Therefore, the product is not registered with
FlexNet Connect after a reboot.

• When you build an InstallScript project, InstallShield no longer adds any FlexNet Connect–related files to the media.

• ISUS.obl will no longer be supported and thus will not be provided with the product.

FlexNet Connect Support in InstallScript MSI Projects

The following FlexNet Connect–related functions have been deprecated for InstallScript MSI projects:

• GetUpdateStatus—This function always returns FALSE.

• SetUpdateStatus—This function returns ISERR_NOT_IMPL.

• GetUpdateStatusReboot—This function always return FALSE.

• SetUpdateStatusReboot—This function returns ISERR_NOT_IMPL.

All calls to the SetUpdateStatus and SetUpdateStatusReboot functions were removed from the default InstallScript
code.

Multilanguage Support in Basic MSI and InstallScript MSI Projects

If an installation includes multilanguage support and end users launch Setup.exe again (after the product is already
installed) to run the installation in maintenance mode, the language selection dialog is no longer displayed. The
maintenance dialogs are displayed in the same language that was used to originally install the product.

394 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Similarly, if a multilanguage minor upgrade or small update is run to update an earlier version of an already installed
product, the language selection dialog is not displayed. The upgrade dialogs are displayed in the same language that was
used to originally install the product.

This behavior helps ensure that the same language that was used to run the original installation and install its features is
also used to repair the original installation, as well as to add other features that were not originally installed but are
installed during maintenance mode or upgrades.

InstallScript Multi-Instance Support

For an InstallScript multilanguage, multi-instance installation that displays the language selection dialog, the instance
selection dialog is now displayed before the language selection dialog. The dialog order change enables end users to select
a different language for a new instance of the product. If end users specify in the instance selection dialog that they want to
maintain an existing instance, the language selection dialog is not displayed. Note that when the instance selection dialog
is displayed, it is displayed in the same language that would be used to display the language selection dialog.

If multiple instances of a non-multi-instance installation are installed through the Setup.exe /ig command-line
parameter, the language selection dialog is displayed only during a first-time installation; it is not displayed during
maintenance mode. This helps ensure that the same language that was used to run the original installation and install its
features is also used to repair the original installation, as well as to add other features that were not originally installed but
are installed during maintenance mode.

During an InstallScript full-release installation that does not display the instance selection dialog—such as an installation
that is run in silent mode or with the Setup.exe -hide_usd command-line parameter—the installation automatically
installs a new instance. This behavior occurs for all new InstallShield 2020 projects, as well as projects that are upgraded
from earlier versions to InstallShield 2020. In InstallShield 2008, /hide_usd resulted in the first installed instance being
maintained, and silent mode resulted in a new instance being installed. In InstallShield 12 and earlier, the first installed
instance would be maintained in both the /hide_usd and silent mode scenarios.

For a differential media, the first instance read is updated.

During a non-multi-instance installation on a system where two or more instances are installed (using the Setup.exe /ig
command-line parameter), the instance selection dialog is displayed. The instance selection dialog does not allow a new
instance to be installed during a non-multi-instance installation because a non-multi-instance installation does not
generate a new random GUID for the new instance. The instance selection dialog includes the “default” instance (the
instance whose GUID matches the product code) if it installed and it is one of the instances that can be maintained. This
behavior applies to all new InstallShield 2020 projects, as well as projects that are upgraded from earlier versions of
InstallShield.

If a single instance is installed, the installation automatically attempts to maintain the installed instance; it does not show
the instance selection dialog. Note that is true even if the installed instance is not the default instance. As a result of this
behavior, if the default instance is not installed but a non-default instance is installed (using the /ig parameter), it is not
possible to install or maintain the default instance without (a) first uninstalling the non-default instance or (b) specifying
the GUID of the default instance through the /ig parameter. Therefore, if you support using the /ig parameter to install
multiple instances, it is recommended that you always use this parameter. This behavior applies to all new InstallShield
2020 projects, as well as projects that are upgraded from earlier versions of InstallShield.

For InstallShield 2008, if a non-multi-instance installation was run on a target system that had multiple instances installed,
the instance selection dialog was not displayed; in this case, the default instance was always used. For InstallShield 12 and
earlier, if a non-multi-instance installation was run on a target system that had multiple instances installed, the instance
selection dialog was displayed; this dialog did not allow a new instance to be displayed (because a non-multi-instance
installation does not generate a new random GUID for the new instance). However, the title bar of the dialog indicated that
the end user should select an instance to update; it should have indicated that the end user should select an instance to
update or maintain.

InstallShield 2020 User Guide ISP-2600-UG00 395

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Changes for SdRegisterUser, SdRegisterUserEx, SdCustomerInformation, and

SdCustomerInformationEx in InstallScript MSI Installations
In an InstallScript MSI installation, the following InstallScript text substitutions now map directly to Windows Installer
properties:

• IFX_PRODUCT_REGISTEREDOWNER maps to the Windows Installer property USERNAME.

• IFX_PRODUCT_REGISTEREDCOMPANY maps to the Windows Installer property COMPANYNAME.

Therefore, when these InstallScript variables are set and retrieved, the corresponding Windows Installer properties are set
and retrieved. The default values for these variables are no longer read from the registry; instead the Windows Installer
properties are used by default. To use the previous functionality, you can set the variables manually through the following
sample code:

// Registered Owner (Only load from registry if pre-loaded value (from log file) is "")
if( !StrLengthChars( IFX_PRODUCT_REGISTEREDOWNER ) ) then
szValue = "";
RegDBGetItem( REGDB_WINCURRVER_REGOWNER, szValue );
if( StrLengthChars( szValue ) ) then
IFX_PRODUCT_REGISTEREDOWNER = szValue;
endif;
endif;

// Registered Company (Only load from registry if pre-loaded value (from log file) is "")
if( !StrLengthChars( IFX_PRODUCT_REGISTEREDCOMPANY ) ) then
szValue = "";
RegDBGetItem( REGDB_WINCURRVER_REGORGANIZATION, szValue );
if( StrLengthChars( szValue ) ) then
IFX_PRODUCT_REGISTEREDCOMPANY = szValue;
endif;
endif;

In an InstallScript MSI installation, the various registration-related dialogs—SdRegisterUser, SdRegisterUserEx,

SdCustomerInformation, and SdCustomerInformationEx—now set IFX_PRODUCT_REGISTEREDOWNER,
IFX_PRODUCT_REGISTEREDCOMPANY, and IFX_PRODUCT_REGISTEREDCOMPANY as appropriate based on the end users’
selections. This automatically updates the corresponding Windows Installer properties.

When a null string ("") is specified for either svName or svCompany for the any of the registration-related dialog functions
(SdRegisterUser, SdRegisterUserEx, SdCustomerInformation, or SdCustomerInformationEx), the functions use the
appropriate variable (determined from the corresponding Windows Installer property) as the default. Previously, the
variables were used only if both svName and svCompany were null; for SdCustomerInformation and
SdCustomerInformationEx, the values were read directly from the Windows Installer properties, bypassing the script
variables.

If a null string ("") is specified for the svSerial parameter, the default value for the serial number field is now set to
IFX_PRODUCT_REGISTEREDSERIALNUM. Previously in this case, the dialog displayed no value.

The following InstallScript variables are new or have been changed:

• DISABLE_PERUSERBTN—This existing variable indicates that the per-user radio button should be disabled (or
hidden) in cases that it would normally be enabled. This variable is always initialized to FALSE. Previously, this value
was initialized to TRUE on Windows 9x systems; otherwise, it was FALSE.

• DISABLE_ALLUSERBTN—This existing variable indicates that the all-user radio button should be disabled (or hidden)
in cases that it would normally be enabled. This variable is always initialized to FALSE. Previously, this value was

396 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

initialized to TRUE if the operating system was not Windows 9x and the end user was not an administrator or power
user.

• HIDE_DISABLED_BTNS—This new variable indicates that the all-user and per-user radio buttons should be hidden
instead of being disabled. The default value is TRUE. Note that if this variable is set to TRUE, both radio buttons are
hidden if either button is determined to be disabled.

The registration dialogs now automatically disable (or hide) the per-user radio button on Windows 9x regardless of the
value of DISABLE_ALLUSERBTN. Previously, the per-user radio button was disabled only if DISABLE_PERUSERBTN was
FALSE.

Note also that the registration dialogs automatically disable (or hide) the all-users radio button if the end user is not an
administrator or power user, regardless of the value of DISABLE_ALLUSERBTN. This behavior has not changed.

These changes apply to all new InstallScript MSI projects that are created in InstallShield 2020, as well as InstallScript MSI
projects that were created in earlier versions of InstallShield and then upgraded to InstallShield 2020.

Proxy Server Support

You may want to configure your installation to download certain files only if they are needed on the target system. For
example, the Windows Installer engine, the .NET Framework, and some InstallShield prerequisites may already be present
on some or most target systems. Instead of embedding these files in your installation (which would increase your overall
installation size), you can configure your project so that only the ones that are needed are downloaded at run time.

If your end users access the Internet through a proxy server and your installation is configured to download files, the
installation now uses the system proxy settings that are manually configured in Internet Explorer during the download.
This occurs even if another browser on the target system is the default browser.

Note that InstallShield does not include support for the Automatically Detect Settings functionality in Internet Explorer. (If
end users have the Automatically Detect Settings check box selected in Internet Explorer for their LAN connection and the
installation needs to download files, the installation fails because the files cannot be downloaded. If it is possible that your
end users may have the Automatically Detect Settings check box selected in Internet Explorer for their LAN connections,
you may want to embed all of the files in your installation rather than configure them to be downloaded; if the files are
embedded, the failures can be avoided.) However, InstallShield does support the Automatic Configuration Script
functionality that is set up for LAN connections in Internet Explorer.

This is the behavior for all new projects in InstallShield 2020, as well as all projects that are created in earlier versions and
then upgraded to InstallShield 2020.

In InstallShield 2008 and earlier, the installation attempted to use the proxy server settings that were configured in
whatever browser was the default browser. However, this was not always possible, and it caused some problems:

• If Netscape 6 or 7 was the default browser, the Netscape 4 settings were used. If Netscape 8 or 9 was the default
browser, the system (Internet Explorer) settings were used.

• If Netscape 4 settings were used, only the proxy server list was read and imported correctly. The proxy bypass list was
read, but it was not imported correctly.

• Non–Internet Explorer 4 compatible settings such as the auto-proxy script setting were not imported.

• The method that the installation used for determining the default browser was not compatible on Windows Vista.
Therefore, on Windows Vista systems, an installation may not have detected the default browser correctly.

InstallShield 2020 User Guide ISP-2600-UG00 397

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Web Downloader Option to Wrap a 1.x .msi Package into a .cab File Is No Longer Available
InstallShield no longer includes an option to specify that an .msi package should be wrapped into a .cab file. This option
was previously available for the Web Downloader type of media in Basic MSI and InstallScript MSI projects in which the
Windows Installer 1.1 or 1.2 was included. The recommended method is to use Windows Installer 2.0 or later and to
digitally sign the package.

Status Text in InstallScript MSI Projects

The OnFirstUIBefore, OnMaintUIBefore, OnAdminInstallUIBefore, OnAdminPatchUIBefore, OnPatchUIBefore, OnUninstall,
and OnResumeUIBefore event handlers in an InstallScript MSI project now include SetStatusExStaticText calls by default
in all new InstallScript MSI projects. This new default code sets status text for the STATUSEX dialog; the status text that is
displayed is now appropriate for the type of operation (first-time installation, maintenance, uninstallation, repair, etc.)
being performed. Previously, it was necessary to manually add the SetStatusExStaticText calls; otherwise, the status text
that was displayed did not correspond with the type of operation being performed.

Note that if you upgrade an InstallScript MSI project from InstallShield 2008 or earlier to InstallShield 2020 and you had
overridden one or more of the updated events in the earlier version of your project, you must manually add the
SetStatusExStaticText code to these events.

Changes for the InstallScript Variable SHELL_OBJECT_FOLDER

You can specify SHELL_OBJECT_FOLDER (for InstallScript or InstallScript MSI projects) or <SHELL_OBJECT_FOLDER> (for
InstallScript projects) in the Display Name setting for a folder in the Shortcuts view. Then you can define the display name
for the folder at run time by setting the SHELL_OBJECT_FOLDER variable in your script before the shortcut is created. The
shortcut is typically created during file transfer.

To use this functionality in an InstallScript MSI installation, any letters that are specified for the Key Name setting of the
folder in the Shortcuts view must be all uppercase (for example, NEWFOLDER1).

SHELL_OBJECT_FOLDER is now initialized to the same value as IFX_PRODUCT_NAME during initialization. Note that these
variables are not synchronized once initialized; therefore, if you change one and want the other to change, you must
change both manually.

Note that also as part of this change, the default OnFirstUIBefore event handler code in InstallScript MSI projects no longer
includes the following line of code:

SHELL_OBJECT_FOLDER = @PRODUCT_NAME;

If you have an InstallScript MSI project that was created in InstallShield 2008 or earlier and you modified the default
OnFirstUIBefore code, InstallShield does not remove this line from your code when you upgrade your project to
InstallShield 2020.

To learn more, see SHELL_OBJECT_FOLDER.

Change in Behavior for the InstallScript Function FeatureFileEnum

If you use the question mark (?) as a wild-card character for the szQuery parameter of the InstallScript function
FeatureFileEnum, the function now uses the question mark as a substitute for exactly one character. If you used the
question mark as a wild-card character with FeatureFileEnum in a project that you created in an earlier version of
InstallShield, you may need to change your InstallScript code when you upgrade it to InstallShield 2020. In earlier versions
of InstallShield, the function used the question mark as a substitute for one or zero characters.

For example, if you create a new InstallScript project with default settings and add the following InstallScript code to your
project, the dialog that is displayed at run time does not display anything.

398 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

#include "ifx.h"

LIST listFiles;

program

listFiles = ListCreate( STRINGLIST );

FeatureFileEnum( MEDIA, "DefaultFeature", "Default?Component", listFiles, NO_SUBDIR );
SdShowInfoList( "", "", listFiles );

endprogram

In installations that were created earlier versions of InstallShield, the dialog displayed DefaultComponent.

All InstallScript Installations Now Support Showing Update UI

All InstallScript projects now support showing the update user interface (UI). Previously, the General Information view and
the Project Settings dialog box had a confusing option that enabled the update UI to be disabled. If the update UI was
disabled, the MEDIA_FLAG_UPDATEMODE_SUPPORTED flag was not set for MEDIA_FIELD_MEDIA_FLAGS, and the
OnSetUpdateMode event handler did not set the UPDATEMODE variable when appropriate. As a result, the update UI was
not shown.

Note that changing the value of ISShowUpdateUI in the InstallShield table (which the previous option updated) no longer
has any effect.

It is possible to duplicate the previous functionality through the following methods:

• Override the OnSetUpdateMode event and update the function to return before setting the UPDATEMODE variable.
The installation never shows the update UI.

• Override the OnMaintUIBefore event and change the call for FeatureRemoveAllInMediaAndLog to
FeatureRemoveAllInMedia.

Changes for the Certified for Windows Vista Validation Suites

The two Certified for Windows Vista validation suites that help you determine whether your installation or merge module
meets the requirements for the Windows Vista logo program have been revised. They now consist of only the InstallShield
ICEs (ISICEs). The Microsoft-created ICEs (ICE01 through ICE99) have been removed, since they are available in the Full MSI
Validation Suite for installation packages and in the Merge Module Validation Suite for merge modules.

In addition, these two suites have been renamed:

• The new name for the Certified for Windows Vista Validation Suite (plus InstallShield ICEs) is InstallShield Certified for
Windows Vista Validation Suite.

• The new name for the Certified for Windows Vista Merge Module Validation Suite (plus InstallShield ICEs) is
InstallShield Certified for Windows Vista Merge Module Validation Suite.

For more information about the validation and the Certified for Windows Vista program, see:

• Requirements for the Windows Logo Program

• Validating Projects

Updated InstallScript Objects and Object Templates

A number of improvements were made to the InstallScript objects and InstallScript object templates that are available for
use with InstallShield 2020 InstallScript projects.

InstallShield 2020 User Guide ISP-2600-UG00 399

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

If you have an Internet connection, you can use the Check for Updates feature in InstallShield to obtain the updated
InstallScript objects and object templates for the version of InstallShield that you are using. To check for updates: On the
Tools menu, click Check for Updates. InstallShield launches a window or dialog, which checks for updates.

Changes that Affect New Projects but Not Upgraded Projects

This section describes changes to InstallShield that may affect new projects but not projects that are upgraded from earlier
versions. Note that you may need to make manual changes to upgraded projects.

Unicode and ANSI Versions of the Setup.exe and Update.exe Bootstrappers

InstallShield now enables you to specify whether you want to create a Unicode version or an ANSI version of the Setup.exe
setup launcher for a Basic MSI project. Previously, if your Basic MSI project included a setup launcher, InstallShield always
built an ANSI version; it did not include support for building a Unicode version.

A Unicode setup launcher can correctly display double-byte characters in the user interface of the setup launcher,
regardless of whether the target system is running the appropriate code page for the double-byte-character language. An
ANSI setup launcher displays double-byte characters in the setup launcher dialogs if the target system is running the
appropriate code page. However, it displays garbled characters instead of double-byte characters in those dialogs if the
target system is not running the appropriate code page.

If you create a new release in a Basic MSI project in InstallShield 2020, the default setup launcher type is Unicode. In
addition, if you create a new patch configuration or a new QuickPatch project in InstallShield 2020, the default update
launcher type is Unicode.

If you upgrade a Basic MSI project from InstallShield 2008 or earlier to InstallShield 2020, the setup launcher type for any
existing releases is ANSI. You can override the type if appropriate.

Similarly, if you upgrade a Basic MSI project or a QuickPatch project from InstallShield 2008 or earlier to InstallShield 2020,
the update launcher type for any existing patch is ANSI. You can override the type if appropriate.

Dynamic File Links

When you add or modify a dynamic file link in a project, you can specify which component creation method you want
InstallShield to use: a new best practice method or the previously available one-component-per-directory method. These
methods are applicable to dynamic file linking in Basic MSI, InstallScript MSI, and Merge Module projects.

If you create a new dynamic file link in InstallShield 2020, InstallShield uses the best practice method by default.

All dynamic file links that are created in InstallShield 2008 or earlier use the one-component-per-directory method. If you
have a project with dynamic file links and you upgrade it from InstallShield 2008 or earlier to InstallShield 2020,
InstallShield continues to use the one-component-per-directory method for creating the components of those already
present dynamic file links. For any new dynamic file links that you create in the upgraded project, the best practice method
is used by default. For detailed information about the two component creation methods, as well as guidance on which
method you should use, see Determining the Appropriate Component Creation Method for Dynamically Linked Files.

IIS Web Sites and Associated Components

InstallShield now includes support for installing IIS Web sites without any virtual directories. In addition, InstallShield now
lets you associate a Web site with a component. As a result of these enhancements, a Web site is created on a target
machine if a virtual directory or a component that is associated with it is installed.

400 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

If you add a new Web site through the Internet Information Services view in InstallShield 2020, InstallShield automatically
associates that Web site with a component. If you upgrade an InstallShield 2008 or earlier project that already has an IIS
Web site, InstallShield does not automatically associate that Web site with a component. Use the General tab that
InstallShield displays when you select a Web site in the Internet Information Services view if you want to associate the
selected Web site with a component.

Note that if a Web site is associated with a component, the Web site’s Delete Web Site on Uninstall check box now
corresponds with the Permanent setting for that component in a Basic MSI or InstallScript MSI project, or with the Uninstall
setting for that component in an InstallScript project. That is, if you select or clear the Delete Web Site on Uninstall check
box for a Web site, InstallShield automatically updates the value of the component’s Permanent setting or Uninstall
setting, as appropriate.

Simplification of QuickPatch Packages

The new Streamline QuickPatch setting on the Advanced tab in a QuickPatch project determines how InstallShield builds
QuickPatch packages. A streamlined QuickPatch package typically has fewer new subfeatures and custom actions than a
non-streamlined QuickPatch package.

In some cases, InstallShield cannot streamline the QuickPatch package. For example, if you configure the QuickPatch
package to remove an installed file, InstallShield cannot streamline it.

When you create a new QuickPatch project, the default value for the Streamline QuickPatch setting is Yes. However, when
you upgrade a QuickPatch project from InstallShield 2008 or earlier to InstallShield 2020, the value for this setting is No.
You can change this value if appropriate. For more information, see Specifying Whether to Streamline the QuickPatch
Package.

Default Condition for the SetARPINSTALLLOCATION Custom Action

By default, all new Basic MSI and InstallScript MSI projects contain the built-in InstallShield custom action
SetARPINSTALLLOCATION. This custom action, which sets the value of the ARPINSTALLLOCATION property to the fully
qualified path for the product’s primary folder, is scheduled for the Installation Execute sequence, and it has no condition.
In InstallShield 2008 and earlier, the default condition for this custom action was Not Installed. With this default Not
Installed condition, the custom action is not run during maintenance mode, and this results in a blank value for the
ARPINSTALLLOCATION property. To avoid this behavior in a project that you upgrade from InstallShield 2008 or earlier to
InstallShield 2020, open the Custom Actions and Sequences view and delete the Not Installed value from the Install Exec
Condition setting for this custom action.

New Sequence Location for the MigrateFeatureStates Action

By default, the MigrateFeatureStates action is now sequenced immediately after the CostFinalize action in all new Basic
MSI and InstallScript MSI projects. If you use the SQL Scripts view to add SQL support to the new project, InstallShield now
schedules the InstallShield built-in custom action ISSQLServerFilteredList after the MigrateFeatureStates action. In
InstallShield 2008 and earlier, the ISSQLServerFilteredList was sequenced before the MigrateFeatureStates action, and this
caused run-time error 2601. To avoid this error in a project that you upgrade from InstallShield 2008 or earlier to
InstallShield 2020, open the Custom Actions and Sequences view and move the ISSQLServerFilteredList action after the
MigrateFeatureStates in the Installation User Interface sequence.

Template Summary Property Changes

You can specify a value for the Template Summary property in the General Information view or for a product configuration
in the Releases view. If you try to enter an invalid value (for example, if you indicate multiple platforms or you use more
than one semicolon), InstallShield displays a warning message box and does not allow you to change the value for the
property.

InstallShield 2020 User Guide ISP-2600-UG00 401

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Earlier versions of InstallShield permitted you to enter invalid values. If you upgrade an InstallShield 2008 or earlier project
to InstallShield 2020, InstallShield does not automatically change the invalid value. However, you can manually update the
value if appropriate. For more information, see Using the Template Summary Property.

Welcome Assistant Removed

The Welcome Assistant, which was displayed the first time that you opened InstallShield, is no longer included.

InstallShield MSIPackageDiff Replaced by InstallShield MSI Diff

The tool called InstallShield MSIPackageDiff is no longer included with InstallShield. It has been replaced by a more
powerful tool called InstallShield MSI Diff. You can launch InstallShield MSI Diff from within InstallShield: On the Tools
menu, point to Difference, and then click InstallShield MSI Diff.

For more information, see InstallShield MSI Diff.

See Also
What’s New in InstallShield 2009
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 12 or Earlier

InstallShield 2020

The following information describes changes that may affect projects that are upgraded from InstallShield 12 or earlier to
InstallShield 2020.

Upgrading Projects Created in Earlier Versions of InstallShield

If you use InstallShield 2020 to open a project that was created with an earlier version, InstallShield 2020 displays a
message box that asks you if you want to convert the project to the new version. If you reply that you do want to convert it,
InstallShield creates a backup copy of the project with a file extension such as .765 before converting it. Delete the .765 part
from the original project’s file name if you want to reopen the project in the earlier version of InstallShield. Note that you
cannot open InstallShield 2020 projects in earlier versions of InstallShield.

You can upgrade projects that were created with the following versions of InstallShield to InstallShield 2008: InstallShield
12 and earlier, InstallShield DevStudio, InstallShield Professional 7 and earlier, and InstallShield Developer 8 and earlier.
Note that projects that were created with InstallShield MultiPlatform or InstallShield Universal cannot be upgraded to
InstallShield 2008.

End of Support for Windows 9x, Windows NT 4, and Windows Me on Target Systems
InstallShield no longer supports the creation of installations for Windows 9x, Windows NT 4, and Windows Me systems. If
end users have one of these operating systems on their computer and they try to run an installation that was built with
InstallShield 2020, unexpected results may occur, unless the project includes launch conditions that prevent end users
from running the installation on any of these legacy operating systems.

For Basic MSI and InstallScript MSI projects, you may want to consider adding launch conditions that display a message if
end users are running your installation on any of the legacy systems. For InstallScript projects, you may want to consider
adding InstallScript code that uses the SYSINFO structure variable to check for these legacy systems, and then display a
message if any of these legacy systems are present.

To learn more, see:

402 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• Specifying Operating System in the Project Assistant

• Platforms Tab

• Platforms Dialog Box

• Modify Property Dialog Box/Release Wizard—Platforms Panel

COM Extraction
When you use InstallShield to extract COM information from a COM server, InstallShield puts the data in the Registry table,
instead of in the TypeLib table. Microsoft strongly advises against using the TypeLib table.

Unused Directories Automatically Removed from .msi File at Build Time by Default
Note that if you upgrade a Basic MSI, InstallScript MSI, or Merge Module project that was created in InstallShield 12 or
earlier to InstallShield 2020, the new Keep Unused Directories setting on the Build tab in the Releases view is set to No.
Therefore, if a directory that is listed in the Directory column of the Directory table is not referenced in any known location
in the .msi file, InstallShield removes it from the Directory table of the .msi file that it creates at build time. For Basic MSI
and InstallScript MSI projects, this occurs after any merge modules are merged, but only directories that are present in the
.msi file are removed; therefore, if a merge module contains new unused directories in its Directory table, the new unused
directories are added to the installation.

Changes for ALLUSERS and for the CustomerInformation Dialog

Beginning with InstallShield 2008, the ALLUSERS property is set to 1 by default in all new Basic MSI projects. This is the
recommended implementation, since most installations must be run in a per-machine context with administrative
privileges.

If you upgrade a project that was created with InstallShield 12 or earlier to InstallShield 2020, InstallShield does not
automatically change the value of the ALLUSERS property or add this property if it was not defined in the earlier project.

Also new with InstallShield 2008, by default, the CustomerInformation dialog in all new Basic MSI projects does not display
the radio button group that enables end users to specify whether they want to install the product for all users or for only
the current user. This is the recommended implementation for this dialog.

If you upgrade a project that was created with InstallShield 12 or earlier to InstallShield 2020, InstallShield does not
automatically change the CustomerInformation dialog.

To learn more, see:

• Per-User vs. Per-Machine Installations

• ALLUSERS

Windows Server 2003 Conditions and 64-Bit Windows XP Conditions for Setup
Prerequisites
The operating system version number is 5.2 for both Windows Server 2003 and 64-bit Windows XP. As a result, prerequisites
that were created in InstallShield 12 and that required Windows Server 2003 could be installed on 64-bit Windows XP
systems, and those that required Windows XP could not be installed on 64-bit Windows XP systems.

To resolve this issue, the Setup Prerequisite Editor in InstallShield 2008 has been enhanced to enable you to specify
whether the target system is required to be a workstation, a server, or a domain controller.

InstallShield 2020 User Guide ISP-2600-UG00 403

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

To resolve this issue for an existing prerequisite that includes a Windows Server 2003 requirement or a 64-bit Windows XP
requirement, open the prerequisite in the Setup Prerequisite Editor in InstallShield 2008. On the Conditions tab, select the
condition that needs to be corrected and click Modify. In the Select which platform the prerequisite should be run on
box, select the appropriate operating system requirement. Doing this correctly sets the new Product (OS) Type setting to
the appropriate workstation, server, or domain controller value.

Automation Interface
The Display Save Options dialog setting was removed from the Releases view. Therefore, the WebSaveOptionsDlg
property, which corresponds with that setting, is no longer available for the ISWiRelease object of automation interface.

New Default Value for the Cache Path Setting for a Release
The default value for the Cache Path setting for a compressed release in the Releases view is now set to
[LocalAppDataFolder]Downloaded Installations. The previous default value was [WindowsFolder]Downloaded
Installations, which may not be available to users on locked-down systems. If you migrate a project from InstallShield 12
or earlier to InstallShield 2020, the Cache Path setting is not automatically changed. Therefore, you may want to change
that value.

InstallScript One-Click Install Installations

Setup.exe is no longer used as the setup player for InstallScript One-Click Install installations; Setup.ocx is now used
instead. In order for a Setup.ocx file to be included in an installation, the new Generate One-Click Install setting in the
Releases view must be set to Yes. If you upgrade an InstallScript project from InstallShield 12 or earlier to InstallShield 2020
and the Create Default Web Page setting in the Releases view is set to Yes, InstallShield sets the Generate One-Click Install
setting to Yes automatically during the upgrade. However, if the Create Default Web Page setting is set to No and you
intend to distribute the installation over the Internet, you must manually select Yes for the Generate One-Click Install
setting after upgrading the project.

All functionality that is related to the Save And/or Run Setup dialog box has been removed from InstallShield. If you want to
give end users the option of downloading and saving the installation (or creating an icon on the desktop), you need to
implement this within your installation’s Web page, and handle the download and save operations through the Web page.

To pass data to a launched One-Click Install installation, use the is::CmdLine parameter and the CMDLINE script variable.
Previously, it was possible to pass data from the Web page to the installation; however, this support has been removed.
Note that the only valid value for the first parameter of SetProperty is now is::CmdLine.

To learn more about One-Click Install installations, see One-Click Install Installations in InstallScript Projects.

Patch Creation for Basic MSI and InstallScript MSI Projects

InstallShield now uses version 3.1 of Patchwiz.dll to create patches.

DemoShield Support
DemoShield is no longer being sold. In addition, it is no longer supported. Therefore, InstallShield no longer includes any
DemoShield integration.

Changes for the Windows Vista Validation Suites

The validation suites that help you determine whether your installation meets installation requirements for the Windows
Vista logo program have been renamed:

404 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• The new name for the Windows Vista Quality Validation Suite (plus InstallShield ICEs) is Certified for Windows Vista
Validation Suite (plus InstallShield ICEs).

• The new name for the Windows Vista Quality Merge Module Validation Suite (plus InstallShield ICEs) is Certified for
Windows Vista Merge Module Validation Suite (plus InstallShield ICEs).

In addition, three of the InstallShield ICEs have been moved to the InstallShield Best Practice Suite.

For more information about the validation and the Certified for Windows Vista program, see:

• Requirements for the Windows Logo Program

• Validating Projects

To learn about the validators that are now available as InstallShield Best Practices, see:

• ISBP17 (which was previously known as ISICE13)

• ISBP18 (which was previously known as ISICE14)

• ISBP19 (which was previously known as ISICE15)

See Also
What’s New in InstallShield 2008
Upgrading from Earlier InstallShield Versions

Upgrading Projects from InstallShield 11.5 or Earlier

InstallShield 2020

For InstallShield 12, a number of improvements were made to the InstallScript MSI architecture to resolve issues with
security (COM/DCOM) and other areas that can cause some installations to fail for various reasons. The architecture was
improved for InstallShield 12 to resolve these issues and to make InstallScript MSI a more reliable project type. The
improvements also help increase the reliability of InstallScript projects, as well as Basic MSI projects that include
InstallScript custom actions.

The following table compares the earlier design with the current design:

Table 2-9 • Architecture Changes

In InstallShield 11.5 and Earlier In InstallShield 12 and Later

Each InstallScript custom action is handled by Each InstallScript custom action is handled by
ISScriptBridge.dll (a C++ MSI DLL), which forwards ISSetup.dll (a single C++ MSI DLL), which contains the full
actual script execution to the ongoing IDriver.exe InstallScript engine.
process.

A set of engine files is required. They must be installed by No engine files or ISScript.msi file is required.
ISScript.msi before the primary installation begins. ISSetup.dll is self-contained.

All InstallScript custom actions execute in a shared Each InstallScript custom action is independent and has
IDriver.exe process. The IDriver.exe process remains its own self-contained lifecycle. From the custom action
resident until a final shutdown custom action is required. entry point, ISSetup.dll starts the script engine, executes
the relevant script, and shuts down the engine.

InstallShield 2020 User Guide ISP-2600-UG00 405

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Advantages of the Architecture Changes That Were Introduced in InstallShield 12

The architecture in InstallShield 12 and later has several advantages over the earlier architecture:

• End users no longer encounter error 1607, error 1608, or other COM/DCOM run-time errors that are related to finding
the running IDriver.exe file. When these errors occurred under the earlier model, they were difficult to resolve, often
requiring changes to DCOM settings. Also, the reliance on the running object table made the model brittle across the
spectrum of usage scenarios, including Fast User Switching and Windows Terminal Services.

• The engine binding is static. No shared engine files are installed to Program Files\Common Files\InstallShield.
The reliance in InstallShield 11.5 and earlier on shared engine files made the model brittle because separate
installations were not isolated. Changes to one engine version could break an existing installation. Isolation,
especially for an installer, is one key to reliability.

• The ISScript.msi file (the InstallScript engine installer) is no longer needed. The earlier model required an
ISScript.msi file to execute prior to the primary .msi file. Because the full application was not contained in a single
.msi file, the installation essentially required a bootstrap for Basic MSI installations that had InstallScript custom
actions. This was very inflexible for enterprises that use Active Directory for managed environments. Also, it was
confusing for advanced users who expect the main .msi file to be self-contained. InstallScript MSI installations still
require a bootstrap, so that requirement is no different than the earlier architecture; however, Basic MSI installations
with InstallScript custom actions no longer require a bootstrap.

• Fewer InstallShield custom actions are needed to run the installation. The earlier model relied on a deep coupling
between startup and shutdown custom actions that could easily fail. If one of the required custom actions was
deleted or moved, the installation would not work properly.

Disadvantages of the Architecture Changes That Were Introduced in InstallShield 12

The disadvantages of the architecture in InstallShield 12 and later include the following:

• InstallScript events are not available in Basic MSI and merge module projects; therefore, all InstallScript code for these
project types must be run by InstallScript custom actions. Global variables do not share state between these custom
action invocations. Therefore, you can declare a global variable in one InstallScript custom action script and then use
that global variable throughout the script. However, if your Basic MSI installation has a second InstallScript custom
action, the global variable declared in the first script is not available to the second script.

With the earlier model, InstallScript developers were able to use script code in any of the InstallScript events in Basic
MSI projects, and any InstallScript global variables shared state. This allowed setup authors to write custom actions
with a more holistic view and sense of continuity across the installation. However, because global variables are
generally discouraged in programming, the new limitation should actually result in better-written InstallScript code.

• In-memory objects must be serialized in order to be shared between custom action invocations. With the earlier
model, InstallScript developers could store complex object-based data in global variables. As with the
aforementioned disadvantage, this may actually result in better InstallScript code.

Upgrading InstallShield 11.5 and Earlier Projects

The extensive rearchitecture that has been introduced in InstallShield 12 may require some manual changes when you
upgrade projects that were created with InstallShield 11.5 or earlier to InstallShield 2020.

406 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Task To upgrade your project:

1. Before you convert your project, create a backup version of your project file and any InstallScript files.

2. Open InstallShield 2020.

3. On the File menu, click Open. The Open dialog box opens.

4. Browse to select the project file (.ism) of the InstallShield 11.5 or earlier project that you want to upgrade. A dialog box
opens, prompting you to specify whether you want to upgrade the project.

5. Click Yes.

InstallShield upgrades your project and saves a backup copy of the project file (.ism).

To learn about possible manual changes that you may need to make to upgraded projects, see the following:

• Upgrading InstallShield 11.5 or Earlier Basic MSI Projects that Have InstallScript Custom Actions

• Upgrading InstallShield 11.5 or Earlier InstallScript MSI Projects

• Upgrading InstallShield 11.5 or Earlier InstallScript Projects

• Upgrading InstallShield 11.5 or Earlier QuickPatch Projects that Have InstallScript Custom Actions

• Creating Standard Patches for InstallShield 11.5 and Earlier InstallScript MSI Projects

• Upgrading InstallShield 11.5 or Earlier InstallScript MSI Object Projects or Projects that Contain This Type of Object

See Also
Global vs. Local Variables

Upgrading InstallShield 11.5 or Earlier Basic MSI Projects that Have

InstallScript Custom Actions
InstallShield 2020

The following sections explain details about upgrading Basic MSI projects that were created in InstallShield 11.5 or earlier
to InstallShield 2020.

Global Variables, Global Pointers, and SUPPORTDIR

With InstallShield 12 and later, when a Basic MSI installation executes an InstallScript custom action, the compiled
InstallScript is loaded before the action is called, and it is unloaded after the action completes. Thus, each InstallScript
custom action executes in its own session with complete InstallScript engine loading and unloading. This behavior is
different than with InstallShield 11.5 and earlier: the compiled InstallScript was loaded once before the first InstallScript
custom action that was used by the InstallScript was executed, and it was unloaded at the end of the installation after all
InstallScript custom actions were completed.

A major implication of this change in behavior is that global variables and pointers are no longer maintained between
individual InstallScript custom action calls:

• If you need to store a value across multiple custom action calls, you must use some external mechanism such as the
registry, Windows Installer properties, or an external data file to store the information between calls. If you choose to

InstallShield 2020 User Guide ISP-2600-UG00 407

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

use Windows Installer properties in deferred, commit, or rollback InstallScript custom actions, see the guidelines in
Windows Installer Properties and Deferred, Commit, and Rollback InstallScript Custom Actions.

• If you need to use a COM object or some other global object across custom action calls, you must initialize the object
for each individual custom action call in order for the object to be valid.

Another implication of this change is that each custom action initializes and uses its own individual SUPPORTDIR. Therefore,
you cannot share information across individual calls using files in SUPPORTDIR, since each custom action invocation will
have its own unique SUPPORTDIR. You can share information using FOLDER_TEMP or some other file location.

Note that FOLDER_TEMP may not be the same path for all of your InstallScript custom actions. If you have some InstallScript
custom actions that run in system context and some that do not, they will have different temp paths if the package is
running in an elevated state. The InstallScript custom actions run in the context of a different user, so storing files in the
temp directory and retrieving it later may not work in certain scenarios.

Windows Installer Properties and Deferred, Commit, and Rollback InstallScript Custom
Actions
Deferred, commit, and rollback InstallScript custom actions in Basic MSI installations have access to only some of the built-
in Windows Installer properties: CustomActionData, ProductCode, and UserSID. If you want an InstallScript custom action
to access any other properties (such as SUPPORTDIR) during deferred, commit, or rollback execution, you need to pass them
as CustomActionData. You can do so by scheduling an immediate set-a-property type of custom action (or, for example, an
immediate InstallScript custom action with the MsiSetProperty function) to set a property that matches the name of the
custom action. The value of this property is then available in the CustomActionData property within the deferred custom
action.

For example, if you want to access a property such as SUPPORTDIR, you could create an immediate custom action that is
called MyCustomActionName and that sets the MyCustomActionName property to [SUPPORTDIR], and then substitute
"SUPPORTDIR" with "CutomActionData" in the MsiGetProperty call:

MsiGetProperty(hMSI, "CustomActionData", szSupportDir, nLen)

For more details, see the following:

• Accessing or Setting Windows Installer Properties Through Deferred, Commit, and Rollback Custom Actions

• Obtaining Context Information for Deferred Execution Custom Actions

Note that failure to compensate for an unavailable Windows Installer property may cause unexpected results during
installation. For example, since in a deferred action, MsiGetProperty(hMSI, "INSTALLDIR", szInstallDir, nLen) sets
szInstallDir to the empty string, szInstallDir ^ szFile may refer to a file in the current directory instead of a file in
[INSTALLDIR]. The current directory for a deferred custom action is often [SystemFolder].

Deferred, commit, and rollback InstallScript custom actions do not have access to the ProductLanguage property. If your
installation includes multilanguage support and it also has a deferred, commit, or rollback InstallScript custom action that
needs access to the language in which the end user is running the installation, the installation assumes that this language
is the installation’s default language. This could be a problem if an end user runs the installation in a language other than
the default language. However, deferred, commit, and rollback custom actions do not typically display any user interface,
so this would usually not be a problem.

Predefined InstallScript Event Handler Functions

The predefined InstallScript event handler functions are no longer available in Basic MSI projects with InstallScript custom
actions. In InstallShield 11.5 and earlier, the following InstallScript event handler functions were available for Basic MSI
projects:

408 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• OnBegin

• OnMoving

• OnMoved

• OnEnd

InstallShield no longer supports these event handler functions for Basic MSI projects that have InstallScript custom
actions. They are not called once the project is rebuilt with InstallShield 12 and later. Note that these event handler
functions still compile in InstallShield 12 and later; they are just not called.

If you use these event handler functions in your project, you need to manually schedule custom actions that call these
functions. To learn how, see Creating and Scheduling InstallScript Custom Actions that Call InstallScript Event Handlers for
Basic MSI Projects.

InstallShield InstallScript Scripting Engine Merge Module

Beginning with InstallShield 12, the InstallShield scripting engine merge module is no longer available for inclusion in Basic
MSI projects. In InstallShield 11.5 and earlier, you could use this merge module to distribute the InstallScript engine for
installations that did not include Setup.exe. InstallShield 12 and later automatically includes the InstallScript engine as
part of ISSetup.dll in Basic MSI installations that have InstallScript custom actions, regardless of whether Setup.exe is
used. Therefore, you do not need this merge module in InstallShield 2020 projects.

If you use InstallShield 2020 to try to build a release for a project that has this merge module, you may encounter a build
error such as the following one:

ISDEV : error -4075: File not found. An error occurred merging Module
'InstallShieldScriptingEngine.4F635B62_07BF_4779_B74E_D80C29D508E3:0' for Feature 'NewFeature1'.

To resolve this build error, remove this merge module from your project; you can do so by clearing its check box in the
Redistributables view.

Changes to the InstallScript Engine Files

With InstallShield 12 and later, Basic MSI installations that include InstallScript custom actions no longer install
InstallScript engine files to the following directory:

<COMMONFILES>\InstallShield\Driver\<Version>\Intel 32

For InstallShield 11.5 and earlier Basic MSI projects with InstallScript custom actions, several files were stored in the
Binary table:

• Setup.inx

• Isconfig.ini

• Isrt.dll

• ISScriptBridge.dll

• _isresXXXX.dll (where XXXX is the language—one .dll was included for each language included in the installation)

• StringxXXXX.txt (where XXX is the language—one .txt was included for each language in the installation)

For InstallShield 12 and later, all of these files (except ISScriptBridge.dll, which is no longer used) are stored inside the
ISSetup.dll file, and that is the only file that is stored in the Binary table.

InstallShield 2020 User Guide ISP-2600-UG00 409

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

The InstallScript engine file changes have not been known to cause any upgrade issues. These changes are reported for
informational purposes.

See Also
Run-Time Behavior for Basic MSI Installations with InstallScript Custom Actions
Upgrading Projects from InstallShield 11.5 or Earlier

Creating and Scheduling InstallScript Custom Actions that Call InstallScript Event Handlers for
Basic MSI Projects
InstallShield 2020

For InstallShield 12 and later, the predefined InstallScript event handler functions are no longer available in Basic MSI
projects with InstallScript custom actions. In InstallShield 11.5 and earlier, the following InstallScript event handler
functions were available for Basic MSI projects and InstallScript MSI object projects:

• OnBegin

• OnMoving

• OnMoved

• OnEnd

InstallShield no longer supports these event handler functions for Basic MSI projects that have InstallScript custom
actions. They are not called once the project is rebuilt with InstallShield 2020. Note that these event handler functions still
compile in InstallShield 2020; they are just not called.

Similarly, these same predefined InstallScript event handler functions are not supported in InstallScript MSI object projects
that are converted to merge module projects automatically when they are opened in InstallShield 2020. The functions are
not called once the converted merge module project is built in InstallShield 2020.

If you have these events in your Basic MSI or InstallScript MSI object project and you upgrade your project to InstallShield
2020, you need to manually schedule custom actions that call the event handler functions. The following instructions
explain how to do so.

Task To manually schedule InstallScript custom actions that call the predefined InstallScript event handler functions:

1. Open the upgraded project in InstallShield 2020.

2. Make the appropriate changes to your InstallScript file:

a. In the View List under Behavior and Logic, click InstallScript.

b. Find the OnBegin, OnMoving, OnMoved, and OnEnd event handler functions in your script. You can quickly find a
function by clicking the function name in the center pane of the view.

c. Rename the functions to an alternate name to avoid conflicts with existing function prototypes automatically
included in ifx.h. For example:

• MyOnBegin

• MyOnMoving

• MyOnMoved

410 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• MyOnEnd

d. Update the existing functions to take a single HWND parameter. For example:

function MyOnBegin(hMSI) begin end;

e. Add appropriate prototypes for these new functions:

export prototype MyOnBegin(HWND);

export prototype MyOnEnd(HWND);
export prototype MyOnMoved(HWND);
export prototype MyOnMoving(HWND);

3. Add InstallScript custom actions that call your renamed InstallScript event handler functions:

a. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI projects) or
Custom Actions (in merge module projects).

b. In the center pane, right-click the Custom Actions explorer and then click New InstallScript. InstallShield adds
an InstallScript custom action.

c. Type a name for the custom action; use the same name that you used to rename the InstallScript functions. For
example:

• MyOnBegin

• MyOnMoving

• MyOnMoved

• MyOnEnd

d. Select the new InstallScript custom action that you created.

e. Set the Function Name setting to the name of the InstallScript function.

f. For the In-Script Execution setting, specify the value that is indicated in the table below.

4. Schedule the InstallScript custom action for the appropriate part of the installation:

a. In the View List under Behavior and Logic, click Custom Actions and Sequences.

b. Right-click the action or dialog that you want your InstallScript custom action to follow and click Insert. The
Insert Action dialog box opens, providing a list of all the actions and dialogs that are currently associated with
your project.

c. Select the InstallScript custom action that you created. If appropriate, enter a condition in the Condition box for
launching the InstallScript event.

d. Click OK.

To match the previous functionality as closely as possible, set the in-script execution in step 3f and schedule the
InstallScript custom actions in step 4b as follows:

Table 2-10 • Scheduling the Custom Actions

Custom Action In-Script Execution Location in the Sequence

MyOnBegin Immediate (default) One of the first actions in the Installation User Interface sequence.

InstallShield 2020 User Guide ISP-2600-UG00 411

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Table 2-10 • Scheduling the Custom Actions (cont.)

Custom Action In-Script Execution Location in the Sequence

MyOnMoving Deferred in system In the Installation Execution sequence, between the InstallInitialize and
context AllocateRegistrySpace actions.

MyOnMoved Deferred in system In the Installation Execute sequence, between the ScheduleReboot and
context InstallFinalize actions.

MyOnEnd Immediate (default) The last event in the Installation Execute sequence after the InstallFinalize
action. (In previous releases, OnEnd was called after all other events as a
result of the installation completing.)

Note the following:

• Global variables and pointers are no longer maintained between individual InstallScript custom action calls. In
addition, each InstallScript custom action initializes and uses its own individual SUPPORTDIR. Therefore, you cannot
share information across individual calls using files in SUPPORTDIR. For more information, see Global Variables, Global
Pointers, and SUPPORTDIR.

• Most Windows Installer properties are not available to deferred, commit, and rollback InstallScript custom actions.
For more information, see Windows Installer Properties and Deferred, Commit, and Rollback InstallScript Custom
Actions.

Upgrading InstallShield 11.5 or Earlier InstallScript MSI Projects

InstallShield 2020

The following sections explain details about upgrading InstallScript MSI projects that were created in InstallShield 11.5 or
earlier to InstallShield 2020.

Global Variables, Global Pointers, and SUPPORTDIR

With InstallShield 2020 and earlier versions, when an InstallScript MSI installation initializes, it loads the compiled
InstallScript file, and it calls InstallScript events in this “main” loaded InstallScript file as necessary during the installation.

However, for InstallShield 12 and later, when a function within the InstallScript is called by the Windows Installer engine as
an InstallScript custom action, the custom action behaves like an InstallScript custom action in a Basic MSI installation.
That is, the function is executed in a completely separately loaded script instance; the script is loaded before the action is
called and unloaded after the action completes. Thus, each InstallScript function that is called by the Windows Installer
engine as an InstallScript custom action executes in its own session with complete InstallScript engine loading and
unloading. This behavior is different than with InstallShield 11.5 and earlier: the custom actions were called in the single
main loaded script file instance that was loaded during initialization and unloaded at the end of the installation.

A major implication of this change in behavior is that InstallScript functions that are called as InstallScript custom actions
no longer have access to global variables and pointers that are maintained by the main executing script file:

• If you need to interact with the main executing InstallScript file to perform tasks such as using or changing global
variables or modifying objects that are maintained by the main executing script file (which includes updating the
status bar or logging script operations for uninstallation), your function must be called from an InstallScript event—
not as an InstallScript custom action. Functions that are called from InstallScript events are executed in the main

412 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

InstallScript instance. (Exception: Some InstallScript error events such as OnFilesInUse are called as a result of an
error message from the Windows Installer engine. The Windows Installer engine launches these InstallScript error
events as InstallScript custom actions; thus, the limitations of InstallScript custom actions also apply to these
InstallScript events.)

• If you need to store a value across multiple InstallScript custom action calls, you must use some external mechanism
such as the registry, Windows Installer properties, or an external data file to store the information between calls. If you
choose to use Windows Installer properties in deferred, commit, or rollback InstallScript custom actions, see the
guidelines in Windows Installer Properties and Deferred, Commit, and Rollback InstallScript Custom Actions.

• If you need to use a COM object or some other global object across custom action calls, you must initialize the object
for each individual custom action call in order for the object to be valid.

Another implication of this change is that each custom action initializes and uses its own individual SUPPORTDIR. Therefore,
you cannot share information across individual calls using files in SUPPORTDIR, since each custom action invocation will
have its own unique SUPPORTDIR. You can share information using FOLDER_TEMP or some other file location.

Note that FOLDER_TEMP may not be the same path for all of your InstallScript custom actions. If you have some InstallScript
custom actions that run in system context and some that do not, they will have different temp paths if the package is
running in an elevated state. The InstallScript custom actions run in the context of a different user, so storing files in the
temp directory and retrieving it later may not work in certain scenarios.

Windows Installer Properties and Deferred, Commit, and Rollback InstallScript Custom
Actions
Deferred, commit, and rollback InstallScript custom actions in InstallScript MSI installations have access to only some of
the built-in Windows Installer properties: CustomActionData, ProductCode, and UserSID. If you want an InstallScript
custom action to access any other properties (such as SUPPORTDIR) during deferred, commit, or rollback execution, you
need to pass them as CustomActionData. You can do so by scheduling an immediate set-a-property type of custom action
(or, for example, an immediate InstallScript custom action with the MsiSetProperty function) to set a property that
matches the name of the custom action. The value of this property is then available in the CustomActionData property
within the deferred custom action.

For example, if you want to access a property such as SUPPORTDIR, you could create an immediate custom action that is
called MyCustomActionName and that sets the MyCustomActionName property to [SUPPORTDIR], and then substitute
"SUPPORTDIR" with "CutomActionData" in the MsiGetProperty call:

MsiGetProperty(hMSI, "CustomActionData", szSupportDir, nLen)

For more details, see the following:

• Accessing or Setting Windows Installer Properties Through Deferred, Commit, and Rollback Custom Actions

• Obtaining Context Information for Deferred Execution Custom Actions

Note that failure to compensate for an unavailable Windows Installer property may cause unexpected results during
installation. For example, since in a deferred action, MsiGetProperty(hMSI, "INSTALLDIR", szInstallDir, nLen) sets
szInstallDir to the empty string, szInstallDir ^ szFile may refer to a file in the current directory instead of a file in
[INSTALLDIR]. The current directory for a deferred custom action is often [SystemFolder].

Deferred, commit, and rollback InstallScript custom actions do not have access to the ProductLanguage property. If your
installation includes multilanguage support and it also has a deferred, commit, or rollback InstallScript custom action that
needs access to the language in which the end user is running the installation, the installation assumes that this language

InstallShield 2020 User Guide ISP-2600-UG00 413

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

is the installation’s default language. This could be a problem if an end user runs the installation in a language other than
the default language. However, deferred, commit, and rollback custom actions do not typically display any user interface,
so this would usually not be a problem.

Changes to the DoInstall Function

The DoInstall function now launches the setup executable file of the child installation instead of using the already-running
installation engine to run the child installation. This change should be automatic; that is, it should not require any changes
to existing InstallScript code. The child installation may take slightly longer to initialize than in previous versions because
the installation executable file needs to initialize. For more information, see DoInstall.

Note that now calling DoInstall is similar to calling LaunchAppAndWait. When the installation is run from any removable
media, such as a CD-ROM or a floppy disk, the Setup.exe file on Disk1 may not be available during the entire installation. (If
Setup.exe becomes unavailable while it is running, the operating system sometimes displays a prompt to request that the
end user insert the correct disk, and this may cause the installation to fail.) Therefore, to avoid this problem, the Setup.exe
file is copied to a Temp folder, and the installation is relaunched from there. The original Setup.exe then terminates.
However, when this happens, DoInstall (or LaunchAppAndWait, if it is called) behaves as if the installation has completed,
and it does not wait.

Several workarounds for this issue exist. One method is to use the /Clone_wait parameter when you are launching the
child installation; as a result of this workaround, the launched installation keeps the original launched process running,
and the parent installation then waits. Note, however, that this may cause problems if the original CD containing
Setup.exe is not available throughout the entire installation. This includes multiple-CD installations, where the first CD is
not available during some parts of the installation.

The only other way to avoid this problem is to add code that determines the ID of the child processes of the launched
process and wait for the child process to complete.

Changes to Disk1 Files

InstallShield no longer places the following file on the Disk1 image of the built installation because it is no longer needed:

ISScript<version>.msi

In InstallShield 12 and later, the following file is placed on the Disk1 image of the built installation:

ISSetup.dll

The Disk1 file changes have not been known to cause any upgrade issues. These changes are reported for informational
purposes.

Changes to the InstallScript Engine Files

With InstallShield 12 and later, InstallScript MSI installations no longer install InstallScript engine files to the following
directory:

<COMMONFILES>\InstallShield\Professional\Runtime\<MajorVersion>\<MinorVersion>\Intel32

For InstallShield 11.5 and earlier InstallScript MSI projects, several files were stored in the Binary table:

• Setup.inx

• Isconfig.ini

• Isrt.dll

• ISScriptBridge.dll

414 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• _isresXXXX.dll (where XXXX is the language—one .dll was included for each language included in the installation)

• StringxXXXX.txt (where XXX is the language—one .txt was included for each language in the installation)

For InstallShield 12 and later, all of these files (except ISScriptBridge.dll, which is no longer used) are stored inside the
ISSetup.dll file, and that is the only file that is stored in the Binary table.

The InstallScript engine file changes have not been known to cause any upgrade issues. These changes are reported for
informational purposes.

InstallScript-Related Custom Actions

Several built-in InstallScript-related custom actions were eliminated in InstallShield 12 for InstallScript MSI projects. If you
upgrade an InstallScript MSI project from InstallShield 11.5 or earlier to InstallShield 2020, InstallShield removes these
built-in custom actions from your project. Because these custom actions have been removed, some existing InstallScript
event handler functions that were previously called by the custom actions are now called directly from InstallScript. For
more information, see Creating and Scheduling InstallScript Custom Actions that Call InstallScript Event Handlers for
InstallScript MSI Projects.

Changes for Deploying an InstallScript MSI Installation Without a Setup.exe File

To allow InstallScript MSI installations to be run without the Setup.exe file so that the packages can be deployed through
technologies such as Active Directory, you may be able to use the instructions that are described in Knowledge Base article
Q108166 - HOWTO: Deploying an MSI Wrapped with an InstallShield Script-Based Setup.exe. However, if you follow the
procedure that is described in that article and users launch the .msi file directly, some of the InstallScript events (such as
OnMoved) are never called. The reason that they are not called is that some of the InstallScript event handler functions that
were previously called by built-in InstallScript-related custom actions are not called, since the InstallScript-related custom
actions have been removed.

For more information, see Creating and Scheduling InstallScript Custom Actions that Call InstallScript Event Handlers for
InstallScript MSI Projects.

See Also
Run-Time Behavior for InstallScript MSI Installations
Upgrading Projects from InstallShield 11.5 or Earlier

Creating and Scheduling InstallScript Custom Actions that Call InstallScript Event Handlers for
InstallScript MSI Projects
InstallShield 2020

Several built-in InstallScript-related custom actions were eliminated in InstallShield 12 for InstallScript MSI projects. If you
upgrade an InstallScript MSI project from InstallShield 11.5 or earlier to InstallShield 2020, InstallShield removes these
built-in custom actions from your project. Because these custom actions have been removed, some existing InstallScript
events that were previously called by the custom actions are now called directly from InstallScript. This article identifies
the eliminated custom actions and explains how add custom actions that call these InstallScript events so that the
scheduling is similar to the scheduling used in InstallShield 11.5 and earlier.

The eliminated custom actions also may affect your InstallScript MSI installation if you allow the installation to run without
the Setup.exe file so that the packages can be deployed through technologies such as Active Directory. The procedure for
implementing this is described in Knowledge Base article Q108166 - HOWTO: Deploying an MSI Wrapped with an
InstallShield Script-Based Setup.exe. Note that if you follow the procedure that is described in that article and end users
launch the .msi file directly, some of the InstallScript events are never called. The reason that they are not called is that

InstallShield 2020 User Guide ISP-2600-UG00 415

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

some of the InstallScript event handler functions that were previously called by built-in InstallScript-related custom
actions are not called, since the InstallScript-related custom actions have been removed. If you configure your installation
according to the Q108166 article, you may also need to follow the instructions below to add custom actions that call the
built-in InstallScript events.

The following built-in InstallScript-related custom actions were eliminated in InstallShield 12. They are removed from
InstallScript MSI projects when they are upgraded from InstallShield 11.5 or earlier to InstallShield 2020:

• ISCleanupSuccess

• ISCleanUpSuspend

• ISCleanUpUserTerminate

• ISCleanupFatalExit

• ISMsiServerStartup

• ISRebootPatchHandler

• ISRollbackCleanup

• ISStartup

• OnCheckSilentInstall (For details about changes for this custom action, see OnCheckSilentInstall.)

• OnFeaturesInstalled

• OnFeaturesInstalling

• OnInstallFilesActionAfter

• OnInstallFilesActionBefore

• OnMoved

• OnMoving

Because these custom actions have been removed, some existing InstallScript event handlers that were previously called
by the custom actions are now called directly from InstallScript. This includes the following InstallScript event handlers
that are called immediately before file transfer:

• Feature functions for Installing and Uninstalling

• OnGeneratedMSIScript

• OnGeneratingMSIScript

• OnInstallFilesActionBefore

• OnMoving

It also includes the following InstallScript event handlers that are called immediately after file transfer:

• Feature functions for Installed and Uninstalled

• OnMoved

• OnInstallFilesActionAfter

416 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

These changes were made to make global variables and global pointers available for these InstallScript event handler
functions. However, because previously the events were called from custom actions, the sequence of these events in
relation to other custom actions that are called directly by Windows Installer has changed. Therefore, you may need to
adjust your InstallScript code appropriately to account for these changes.

Except in the case of the feature event handlers, it is also possible to add custom actions that call these event handler
functions so that the scheduling is similar to the scheduling used in InstallShield 11.5 and earlier. However, global variables
and global pointers are not maintained between calls, as discussed in the Global Variables, Global Pointers, and
SUPPORTDIR section.

Calling OnFeatureInstalling, OnFeatureUninstalling, OnFeatureInstalled, or OnFeatureUninstalled from a custom action

during file transfer does not have any effect on the installation. This is because these functions are called from InstallScript
just before file transfer, and they do not have any effect when they are called more than once.

Task To manually schedule an InstallScript custom action that calls a predefined InstallScript event handler function:

1. Open the upgraded project in InstallShield 2020.

2. Make the appropriate changes to your InstallScript file:

a. In the View List under Behavior and Logic, click InstallScript.

b. Find the event handler function in your script. You can quickly find a function by clicking the function name in the
center pane of the view.

c. Rename the function to an alternate name to avoid conflicts with existing function prototypes automatically
included in ifx.h. For example:

• MyOnGeneratingMSIScript

• MyOnMoving

• MyOnMoved

d. Update the existing function to take a single HWND parameter. For example:

function MyOnGeneratingMSIScript(hMSI) begin end;

e. Add appropriate prototypes for this new function:

export prototype MyOnGeneratingMSIScript(HWND);

3. Add an InstallScript custom action that calls your renamed InstallScript event handler function:

a. In the View List under Behavior and Logic, click Custom Actions and Sequences.

b. In the center pane, right-click the Custom Actions explorer and then click New InstallScript. InstallShield adds
an InstallScript custom action.

c. Type a name for the custom action; use the same name that you used to rename the InstallScript function. For
example:

• MyOnGeneratingMSIScript

• MyOnMoving

• MyOnMoved

d. Select the new InstallScript custom action that you created.

InstallShield 2020 User Guide ISP-2600-UG00 417

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

e. Set the Function Name setting to the name of the InstallScript function.

f. For the In-Script Execution setting, specify the value that is indicated in the table below.

4. Schedule the InstallScript custom action for the appropriate part of the installation:

a. In the View List under Behavior and Logic, click Custom Actions and Sequences.

b. Right-click the action or dialog that you want your InstallScript custom action to follow and click Insert. The
Insert Action dialog box opens, providing a list of all the actions and dialogs that are currently associated with
your project.

c. Select the InstallScript custom action that you created. If appropriate, enter a condition in the Condition box for
launching the InstallScript event.

d. Click OK.

To match the previous functionality as closely as possible, set the in-script execution in step 3f and schedule the
InstallScript custom actions in step 4b as follows:

Table 2-11 • Scheduling the Custom Actions

In-Script
Custom Action Execution Location in the Sequence

OnGeneratingMSIScript Immediate In the Installation Execute sequence between the

(default) RemoveExistingProducts and InstallInitialize actions

OnMoving Deferred in In the Installation Execute sequence between the InstallInitialize and
system context AllocateRegistrySpace actions

OnFeaturesInstalling, Deferred in In the Installation Execute sequence between the InstallInitialize and
which calls all the feature system context AllocateRegistrySpace actions (after OnMoving)
Installing and Uninstalling
events that are defined.
Note: This will not have any
effect, as explained above.

OnInstallFilesActionBefore Deferred in In the Installation Execute sequence between the MoveFiles and
system context InstallFiles actions

OnFeaturesInstalled, which Deferred in In the Installation Execute sequence between the ScheduleReboot
calls all the feature system context and InstallFinalize actions (before OnMoved)
Installed and Uninstalled
events that are defined.
Note: This will not have any
effect, as explained above.

OnMoved Deferred in In the Installation Execute sequence between the ScheduleReboot

system context and InstallFinalize actions (before OnGeneratedMSIScript)

OnInstallFilesActionAfter Deferred in In the Installation Execute sequence between the InstallFiles and
system context PatchFiles actions

418 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Table 2-11 • Scheduling the Custom Actions (cont.)

In-Script
Custom Action Execution Location in the Sequence

OnGeneratedMSIScript Immediate In the Installation Execute sequence between the ScheduleReboot

(default) and InstallFinalize actions (after OnMoved)

Note the following:

• Global variables and pointers are no longer maintained between individual InstallScript custom action calls. In
addition, each InstallScript custom action initializes and uses its own individual SUPPORTDIR. Therefore, you cannot
share information across individual calls using files in SUPPORTDIR. For more information, see Global Variables, Global
Pointers, and SUPPORTDIR.

• Most Windows Installer properties are not available to deferred, commit, and rollback InstallScript custom actions.
For more information, see Windows Installer Properties and Deferred, Commit, and Rollback InstallScript Custom
Actions.

OnCheckSilentInstall
In InstallShield 11.5 and earlier, the OnCheckSilentInstall custom action automatically called the OnMsiSilentInstall
InstallScript event if the InstallScript MSI installation was being installed silently without using Setup.exe (for example, if
the following command-line was used: Msi.exe /i<Package> /qn). In InstallShield 12 and later, this event is not called in
InstallScript MSI installations. However, you can add a custom action that calls the OnMsiSilentInstall event handler
function. To do so, use the aforementioned instructions, noting the following scheduling requirements in steps 3f and 4b:

Table 2-12 • Scheduling the OnCheckSilentInstall Custom Action

In-Script
Custom Action Execution Location in the Sequence

OnCheckSilentInstall Immediate As the first action in the Installation Execute sequence

(default)

Also, to require that the InstallScript event run only in the expected scenario, add the following code to the event:

cchValueBuf = MAX_PATH;
// Check whether Setup.exe is being used, if so just return.
MsiGetProperty(nHandle, "ISSETUPDRIVEN", szValueBuf, cchValueBuf);
if(StrLengthChars(szValueBuf)) then
return ISERR_SUCCESS;
endif;

Upgrading InstallShield 11.5 or Earlier InstallScript Projects

InstallShield 2020

The following sections explain details about upgrading InstallScript projects that were created in InstallShield 11.5 or
earlier to InstallShield 2020.

InstallShield 2020 User Guide ISP-2600-UG00 419

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Including InstallScript Objects in InstallScript Projects

InstallScript installations created in InstallShield 2020 cannot consume objects that were created with InstallShield 11.5 or
earlier.

If you upgrade an InstallScript project to InstallShield 2020, all references to any InstallShield objects are updated to point
to the InstallShield 2020 versions of the objects. If the new version object is not present on the system, an error indicating
that the object could not be found is displayed at build time.

For instructions on acquiring the InstallShield 2020 objects, see Obtaining Updates for InstallShield.

Changes to the DoInstall Function

The DoInstall function now launches the setup executable file of the child installation instead of using the already-running
installation engine to run the child installation. This change should be automatic; that is, it should not require any changes
to existing InstallScript code. The child installation may take slightly longer to initialize than in previous versions because
the installation executable file needs to initialize. For more information, see DoInstall.

Note that now calling DoInstall is similar to calling LaunchAppAndWait. When the installation is run from any removable
media, such as a CD-ROM or a DVD, the Setup.exe file on Disk1 may not be available during the entire installation. (If
Setup.exe becomes unavailable while it is running, the operating system sometimes displays a prompt to request that the
end user insert the correct disk, and this may cause the installation to fail.) Therefore, to avoid this problem, the Setup.exe
file is copied to a Temp folder, and the installation is relaunched from there. The original Setup.exe then terminates.
However, when this happens, DoInstall (or LaunchAppAndWait, if it is called) behaves as if the installation has completed,
and it does not wait.

Several workarounds for this issue exist. One method is to use the /Clone_wait parameter when you are launching the
child installation; as a result of this workaround, the launched installation keeps the original launched process running,
and the parent installation then waits. Note, however, that this may cause problems if the original CD containing
Setup.exe is not available throughout the entire installation. This includes multiple-CD installations, where the first CD is
not available during some parts of the installation.

The only other way to avoid this problem is to add code that determines the ID of the child processes of the launched
process and wait for the child process to complete.

Setup.exe Changes
The /deleter command-line parameter for Setup.exe is no longer needed. If you specify this parameter, the installation
will not run. Note that InstallScript installations no longer clone the installation immediately when they are launched
(unless, for example, the installation is running from the temp folder because the /runfromtemp parameter is specified), so
/deleter is no longer needed.

The /clone_nowait command-line parameter for Setup.exe is no longer needed. If you specify this parameter, Setup.exe
ignores it. Note that InstallScript installations no longer wait for the cloned installation to complete by default unless the /
Clone_wait parameter is specified. For more information on /Clone_wait, see Setup.exe and Update.exe Command-Line
Parameters.

Like InstallScript MSI and Basic MSI installations, InstallScript’s Setup.exe file returns meaningful return codes. Therefore,
if you are checking the return value of Setup.exe, in InstallShield 11.5 and earlier, it would always be 0; in InstallShield 12
and later, Setup.exe returns an appropriate return value. For details on the possible return codes, see Setup.exe Return
Values and Run-Time Errors (InstallScript Projects).

420 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Changes to Disk1 Files

InstallShield no longer places the following files on the Disk1 image of the built installation because they are no longer
needed:

• Engine32.cab

• Setup.ibt

In InstallShield 12 and later, the following files are placed on the Disk1 image of the built installation:

• ISSetup.dll

• _Setup.dll

The Disk1 file changes have not been known to cause any upgrade issues. These changes are reported for informational
purposes.

Changes to the InstallScript Engine Files

With InstallShield 12 and later, InstallScript installations no longer install InstallScript engine files to the following
directory:

<COMMONFILES>\InstallShield\Professional\Runtime\<MajorVersion>\<MinorVersion>\Intel32

This change has not been known to cause any upgrade issues. This change is reported for informational purposes.

See Also
Upgrading Projects from InstallShield 11.5 or Earlier

Upgrading InstallShield 11.5 or Earlier QuickPatch Projects that Have

InstallScript Custom Actions
InstallShield 2020

QuickPatch projects that are created in InstallShield 12 and later for InstallScript MSI projects can only patch media that
were also created with InstallShield 12 and later. If you want to use InstallShield 2020 to create an update for an
application whose previous InstallScript MSI installation was created with InstallShield 11.5 or earlier, you should create a
create a minor-upgrade package instead of a QuickPatch, and use the Patch Design view to create a standard patch.
Subsequent patches from this version can be created as QuickPatch projects.

Creating a QuickPatch for a Basic MSI project (with or without InstallScript custom actions) has not been known to cause
any issues.

See Also
Upgrading Projects from InstallShield 11.5 or Earlier

InstallShield 2020 User Guide ISP-2600-UG00 421

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Creating Standard Patches for InstallShield 11.5 and Earlier InstallScript MSI
Projects
InstallShield 2020

InstallShield 12 and later does not support the creation of InstallScript MSI patches (using the Patch Design view) where
both the latest and previous setups were created with InstallShield 11.5 or earlier. Creating a patch where the latest setup
is created with InstallShield 12 or later and the previous setup was created with InstallShield 11.5 or earlier has not been
known to cause any issues.

See Also
Upgrading Projects from InstallShield 11.5 or Earlier

Upgrading InstallShield 11.5 or Earlier InstallScript MSI Object Projects or

Projects that Contain This Type of Object
InstallShield 2020

InstallShield 11.5 and earlier included the InstallScript MSI Object type of project. This project type is no longer available in
InstallShield.

Upgrading InstallScript MSI Object Projects

If you open an InstallScript MSI Object project in InstallShield 2020, InstallShield will convert it to a merge module project.

Predefined InstallScript event handlers are not available in merge module projects that have InstallScript custom actions.
Therefore, if you have an InstallShield 11.5 or earlier InstallScript MSI object project that uses InstallScript event handler
functions, you must manually schedule custom actions that call these functions when the project is converted to a merge
module project in InstallShield 2020. To learn how, see Creating and Scheduling InstallScript Custom Actions that Call
InstallScript Event Handlers for Basic MSI Projects.

Note that InstallShield 2020, as well as earlier and later versions of InstallShield, can consume InstallShield 2020 merge
modules that have InstallScript custom actions.

Upgrading Projects that Contain InstallScript MSI Objects

Building upgraded projects that contain already-built InstallScript MSI objects (.imm files) will fail; these objects cannot be
consumed in InstallShield 2020. If you try to do so, a build error such as the following one occurs:

ISDEV : error -4075: File not found. An error occurred merging Module
'InstallShieldMSIObjectName.4F635B62_07BF_4779_B74E_D80C29D508E3:0' for Feature 'NewFeature1'.

where “InstallShieldMSIObjectName.4F635B62_07BF_4779_B74E_D80C29D508E3:0” is information that is specific to the

missing InstallScript MSI object. To resolve this build error, remove this InstallScript MSI object from your project; you can
do so by clearing its check box in the Redistributables view.

See Also
Merge Module Projects
Build Errors and Warnings

422 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Upgrading Projects Created with InstallShield Express

InstallShield 2020

If you have an InstallShield project that was created using versions 2.1 through 5.x of InstallShield Express, that project is
automatically upgraded to a Basic MSI project when you open it in InstallShield 2020. InstallShield 2020 converts
InstallShield Express projects to a Basic MSI project because it is the comparable project type.

To learn how to convert your upgraded project to an InstallScript MSI project, see Converting a Basic MSI Project to an
InstallScript MSI Project.

Task To upgrade an Express project:

Open the project in InstallShield. A dialog box opens to ask if you would like to upgrade your project.

• Click Yes to upgrade your project. Your project opens in InstallShield.

• Click No to leave the project unopened.

A backup copy of your original project is created and stored in the location specified in the dialog box.

InstallShield 2020 preserves the logic and dialog of the Setup Types view when it migrates Express 2.x projects (.iwz) to a
Basic MSI project in InstallShield 2020. In earlier versions of Express, setup types were based on components. In Express 2.x
projects (.iwz), components were replaced by features, and file groups are now mapped to destination folders instead of
components.

When you upgrade an Express 2.x project (.iwz) to a Basic MSI project in InstallShield 2020, you can edit setup types by
changing a feature’s Install Level property and dialog control events.

Note • Billboard properties from Express projects will not be migrated since they are not supported in Basic MSI projects. You
will receive warning 701 when the billboards property is specified in earlier Express projects.

If you migrate an Express project with a language that is not installed with your current version of InstallShield, you will lose
support for that language. Language support is available in the Premier edition of InstallShield.

See Also
Converting a Basic MSI Project to an InstallScript MSI Project

Upgrading Projects Created with InstallShield Professional

InstallShield 2020

You can upgrade projects that were created using InstallShield Professional. When you are using InstallShield 2020 and you
open an installation project that was created with InstallShield Professional, your project is automatically upgraded. This
enables you to immediately work with your project in InstallShield 2020.

Projects that were created using InstallShield Professional were composed of several .ini files referenced by an .ipr file. In
InstallShield 2020, your installation project is one file—an .ism file.

InstallShield 2020 User Guide ISP-2600-UG00 423

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

First Step: Opening Your Installation Project

Task To open an installation project created in InstallShield Professional:

1. Open InstallShield.

2. On the File menu, click Open. The Open dialog box opens.

3. Select the InstallShield Professional project file (.ipr) that you would like to open.

4. Click Open.

Your project opens in InstallShield, and the extension changes from .ipr to .ism. A backup of your original .ipr project is
saved as ProjectName.ipr.bak in the same folder.

Next Steps: Modifying Your Installation Project

After you upgrade your installation project, you can use the views, menus, wizards, and other parts of the InstallShield user
interface to modify your project settings.

You may also need to make changes to the upgraded project; see Migrating from InstallShield Professional 6.x and
Migrating from InstallShield Professional 5.x.

Note • In InstallShield 2020, support files are linked to a subfolder of the project folder; in InstallShield Professional, support
files were physically copied to a subfolder of the project folder.

See Also
Script Changes: Lexicon Conversion
Adding Project Assistant Dialog Support to Projects Upgraded from InstallShield Professional
Upgrade Errors (Upgrading from InstallShield Professional)
Upgrade Warnings (Upgrading from InstallShield Professional)
ISAlias Table

Migrating from InstallShield Professional 6.x

InstallShield 2020

When you upgrade an InstallShield Professional 6.x installation to InstallShield 2020, note the following:

• You can quickly convert a script that uses a program...endprogram block to an event-based script that calls all
appropriate event handler functions except the user interface and file transfer functions. For details, see OnShowUI.

• The new simplified model for Internet installations eliminates many of the Ether object’s methods and all of its
properties and subobjects (while providing InstallScript enhancements that let you handle any Internet-specific
requirements). If your Internet installation used any of these properties and methods, see Replacing Obsolete
Properties and Methods.

• Installations created in version 6.x contained a number of automatically created string entries; the installation used
these string entries to get information. These string entries were redundant—they contained the same information
contained in the Project Settings property sheet. InstallShield 2020 simplifies matters by allowing the information
specified in the project settings to be used at runtime.

424 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Note that using this information is not required; you can continue using your existing string entries as before by simply
leaving them intact in your project.

If you want your migrated installation to automatically use the information from your project’s Project Settings
property sheet, delete the following string entries from your project:

COMPANY_NAME

PRODUCT_NAME

PRODUCT_KEY

PRODUCT_VERSION

TITLE_CAPTIONBAR

FOLDER_NAME

TITLE_MAIN

Also, update any script code that may be using one of these string entries to use the new corresponding system
variable instead, as shown in the following table:

Table 2-13 • String Entries and Corresponding New System Variables

String Entry System Variable

COMPANY_NAME IFX_COMPANY _NAME

PRODUCT_NAME IFX_PRODUCT_NAME

PRODUCT_KEY IFX_PRODUCT_KEY

PRODUCT_VERSION IFX_PRODUCT_VERSION

TITLE_CAPTIONBAR IFX_SETUP_TITLE

FOLDER_NAME IFX_PRODUCT_NAME

TITLE_MAIN IFX_SETUP_TITLE

Note that you can remove only a subset of these string values if you want some values to be read from the string
entries and some to be read from the project settings. If you retain any of these string values, be sure to modify them
as required, rather than changing the unused project settings; in particular, when creating an update installation, be
sure to update the value of the PRODUCT_VERSION string entry if it exists.

• If your installation uses an event-based script and you have overridden the default OnSetUpdateMode event handler
code, a message such as the following may be displayed at run time: “The installed version of the application could
not be determined. The setup will now terminate.” If this error occurs, add code that manually sets
IFX_INSTALLED_VERSION during the OnSetUpdateMode event. For sample code, see the default code that is included
in the OnSetUpdateMode event of a new InstallShield 2020 InstallScript project.

• If your installation uses an event-based script and you have overridden the default OnFirstUIBefore event handler
code, you must replace the following code (from the 6.x version of OnFirstUIBefore) in order to install files to the
appropriate default location:

TARGETDIR = PROGRAMFILES ^ @COMPANY_NAME ^ @PRODUCT_NAME;

with the following code (from the new default OnFirstUIBefore code) to set TARGETDIR:

InstallShield 2020 User Guide ISP-2600-UG00 425

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

/* Handles both end users with administrative or power user privileges and
end users without such privileges. */
if ( ALLUSERS ) then
TARGETDIR = PROGRAMFILES ^ IFX_COMPANY_NAME ^ IFX_PRODUCT_NAME;
else
TARGETDIR = FOLDER_APPDATA ^ IFX_COMPANY_NAME ^ IFX_PRODUCT_NAME;
endif;

/* Handles both standard and multi-instance installations. */

if( MAINT_OPTION = MAINT_OPTION_MULTI_INSTANCE && MULTI_INSTANCE_COUNT > 0) then
nLoop = 1;
svDir = TARGETDIR;
while(ExistsDir(TARGETDIR) = EXISTS)
NumToStr(szTargetDirAppendix,nLoop);
TARGETDIR = svDir + szTargetDirAppendix;
nLoop = nLoop + 1;
endwhile;
endif;

If you are using a procedural script (one with a program…endprogram block), you need to update the code in which
you set TARGETDIR in order to set the default target directory appropriately for users without administrator privileges.

• If your installation uses an event-based script and you have overridden the default OnMaintUIBefore event handler
code, and during uninstallation you want to remove all features including those that are not listed in the media but
only in the log file (see FeatureRemoveAllInMediaAndLog for more information), then you must replace the following
code (from the 6.x version of OnMaintUIBefore):

case REMOVEALL: ComponentRemoveAll();

with the following code (from the new default OnMaintUIBefore code):

MediaGetData( MEDIA, MEDIA_FIELD_MEDIA_FLAGS, nMediaFlags, szIgnore );

case REMOVEALL:
/* Properly handles updating. */
if( nMediaFlags & MEDIA_FLAG_UPDATEMODE_SUPPORTED ) then
FeatureRemoveAllInMediaAndLog();
else
FeatureRemoveAllInMedia();
endif;

If you are using a procedural script that supports script-based uninstallation you need to update your call to
ComponentRemoveAll appropriately.

• If your script calls RegDBSetItem to alter the registry entries that are created by MaintenanceStart (or DeinstallStart),
and it makes those calls to RegDBSetItem in an event handler that is called before the OnMoved handler (for example,
OnMoving or <feature name>_OnInstalled), you must move those calls to RegDBSetItem. MaintenanceStart is now
called in the OnMoveData event handler’s default code, whereas previously MaintenanceStart was called
automatically immediately after the maintenance/uninstallation feature was installed and before any other features
were installed.

• The InstallShield Professional 6.x default event handler code included the following lines in both OnFirstUIBefore and
OnMaintUIBefore:

SetStatusWindow( 0, "" );
Enable( STATUSEX );
StatusUpdate( ON, 100 );

426 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

In InstallShield 2020, this code has been relocated to the default OnMoveData event handler code, so you have the
following options:

• If you have not customized this code, you do not need to do anything because the redundant calls will not cause
a problem. You can safely remove this code from OnFirstUIBefore and OnMaintUIBefore if you want to avoid code
duplication.

• If you have customized this code and you want these customizations to apply regardless of what user interface
(UI) event is called, you should remove the code from OnFirstUIBefore and OnMaintUIBefore, then override the
OnMoveData event and place the customized code in place of the default code.

• If you have customized the code and you want specific code depending on what UI event is called, you should
override OnMoveData, comment out the default code, and continue to use your existing code. Note that in this
case, if your installation supports updating you may also want to customize OnUpdateUIBefore.

• The 6.x default event handler code included the following commented-out code in the OnFirstUIBefore and
OnMaintUIBefore events:

// TO DO: if you want to enable background, window title, and caption bar title
// SetTitle( @TITLE_MAIN, 24, WHITE );
// SetTitle( @TITLE_CAPTIONBAR, 0, BACKGROUNDCAPTION );
// Enable( FULLWINDOWMODE );
// Enable( BACKGROUND );
// SetColor( BACKGROUND, RGB( 0, 128, 128 ) );

If you activated this code and would like to provide a consistent UI experience regardless of what UI event is called,
you can remove this code from OnFirstUIBefore and OnMaintUIBefore and then override OnShowUI and customize
the code appropriately.

• Many Windows API functions are declared in included header files (.h files) in InstallShield 2020. If any of these
functions are also explicitly declared in your script code, do one of the following:

• Remove your function declaration and use the declaration provided by InstallShield Professional.

• If you are creating a script that needs to be compilable in both InstallShield 2020 and earlier versions, surround
your declaration with code like the following:

#if _ISCRIPT_VER < 0x700

prototype ...
#endif

You may also need to update code that calls a Windows API function, if the declaration defined by InstallShield
Professional is different than your declaration.

• In order that the end user interface flows smoothly, by default the installation initialization dialog box remains
displayed until the script displays a dialog box. To close the installation initialization dialog box, call
Disable(DIALOGCACHE) or any dialog box function.

Migrating from InstallShield Professional 5.x

InstallShield 2020

Project • This information applies to InstallScript Object projects.

InstallShield 2020 User Guide ISP-2600-UG00 427

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Script Changes
The basic structure of an InstallShield Professional 5.x script is supported in the InstallScript project type in InstallShield
2020. To compile a Professional 5.x script in InstallShield, you must first make the following changes:

Preprocessor Directives
• Include the following statement at the beginning of your script:

#include "ifx.h"

• Remove any #define statements for SD_SINGLE_DIALOGS and its associated SD_<dialog name> constants.

• You may need to remove some #define statements that define Windows constants if those statements result in
compiler errors. Many Windows constants are defined in Ifx.h (which is in the InstallShield Program Files
Folder\Script\Isrt\Include subfolder) or its included files.

Built-In Functions
• Remove the following functions, which were supported in Professional 5.x but are not supported in InstallShield 2020.
Some of these functions will compile, but they will not give the expected results. Where possible, supported
alternatives are suggested.

Table 2-14 • Obsolete Professional 5.x Functions

Professional 5.x Function Suggested Alternative

AppCommand None. (Appropriate only for platforms using the Program Manager shell,
which are no longer supported.)

AddProgItemEx AddFolderIcon

CmdGetMsg Windows API function GetMessage (call CmdGetHwndDlg to get the dialog
handle)

CmdGetParam1 Windows API function GetMessage (call CmdGetHwndDlg to get the dialog
handle)

CmdGetParam2 Windows API function GetMessage (call CmdGetHwndDlg to get the dialog
handle)

CommitSharedFiles The actions performed by this function in Professional 5.x are done
automatically in InstallShield 2020.

CreateProgGroupEx AddFolderIcon

DeleteGroup DeleteProgramFolder

DeleteProgItem DeleteFolderIcon

ExitProgMan None. (Appropriate only for platforms using the Program Manager shell,
which are no longer supported.)

GetGroupNameList GetFolderNameList

GetItemNameList None. (Appropriate only for platforms using the Program Manager shell,
which are no longer supported.)

428 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Table 2-14 • Obsolete Professional 5.x Functions (cont.)

Professional 5.x Function Suggested Alternative

QueryProgGroup None. (Appropriate only for platforms using the Program Manager shell,
which are no longer supported.)

RegDBCreateKey RegDBCreateKeyEx

RegDBCreateKeyValue RegDBCreateKeyValueEx

RegDBGetKeyValue RegDBGetKeyValueEx

RegDBSetKeyValue RegDBSetKeyValueEx

ReloadProgGroup None. (Appropriate only for platforms using the Program Manager shell,
which are no longer supported.)

ReplaceProgItem None. (Appropriate only for platforms using the Program Manager shell,
which are no longer supported.)

ShowGroup None. (Appropriate only for platforms using the Program Manager shell,
which are no longer supported.)

• Call Disable(LOGGING) before any code that makes changes to the target system that you do not want logged for
uninstallation, and call Enable(LOGGING) after that code. This is necessary because logging of changes for
uninstallation is automatically enabled before any script code is executed.

Note that this is different from Professional 5.x installations in which logging did not begin until DeInstallStart was
called. If you have any installation actions that previously were not logged because they occurred before
DeInstallStart, you will need to add an additional Disable(LOGGING) call before these installation actions to disable
logging manually.

If you want your installation to display a background, you must call Enable(BACKGROUND). In InstallShield 2020, the
background is disabled by default, whereas in Professional 5.x it was enabled by default. (In event-based scripts, code
for customizing and displaying a background exists in comment lines at the beginning of the default code for
OnFirstUIBefore. To activate this code, remove the slash characters at the beginnings of the desired lines.)

Note that some user-interface functions, such as PlaceBitmap, will not work properly (nor return a negative value to
let you know they failed) if the installation background is not enabled.

• It is no longer necessary to call RegDBSetItem with the argument REGDB_UNINSTALL_NAME to set the value of
[DisplayName] under the uninstallation key. This is now done when MaintenanceStart or DeinstallStart is called.

• Calling SetColor with STATUSBAR as its argument will not have any effect in InstallShield 2020; status bars are drawn
using system colors.

• When you call StrGetTokens, if the first (or last) character of szString matches a character in szDelimiterSet, a null
string ("") is not inserted in the list as the first (or last) element. Instead, the characters between the first and second
(or last and next to last) delimiters are inserted in the list as the first (or last) element.

• When you call StrGetTokens, if a wildcard character is included in the filename specified by szSrcFile, the filename
part of szTargetFile is not ignored as in previous versions of InstallShield Professional; instead, all of szTargetFile is
treated as the target path to which each source file is copied to with its existing name. For example, CopyFile(
"C:\\*.*", "D:\\File.txt" ) copies files to a folder named File.txt on the D drive.

InstallShield 2020 User Guide ISP-2600-UG00 429

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• WaitOnDialog now returns IDCANCEL when the end user selects the system menu’s Close command or clicks the title
bar’s Close button from a custom dialog. In previous versions, DLG_CLOSE was returned in these cases.

• If you pass GetSystemInfo a first argument of DRIVE and a third argument that is a UNC path, the function correctly
returns a negative value. Previously it returned zero, falsely indicating success, although due to operating system
limitations UNC paths are not supported in that case.

• When you call ParsePath with its third argument set to PATH and its second argument set to a UNC path that includes
only a server name without a trailing backslash (for example, "\\\\TheServer"), the function correctly sets the first
argument equal to a double backslash ("\\\\"). In Professional 5.x, the function would set the first argument equal to a
single backslash ("\\").

• The Professional 5.x Help Library listed specific numeric return values, other than 0 (zero) for success, for some
functions. Some of these numeric values have changed for InstallShield 2020; a script used in InstallShield 2020
should compare a function’s return value only to the constants that are currently listed in that function’s help.

• In order for the end-user interface to flow smoothly, by default the installation initialization dialog remains displayed
until the script displays a dialog. To close the installation initialization dialog, call Disable(DIALOGCACHE) or any
dialog function.

• ComponentMoveData’s second argument no longer returns useful data.

• Passing a pointer to a string as the fourth argument of SendMessageTimeout no longer gives the expected result. To
pass string data to SendMessageTimeout, see the Additional Information section of the SendMessageTimeout topic.

Predefined Constants
• Remove the following constants, which were supported in Professional 5.x but are not supported in InstallShield 2020:

COMPONENT_VALUE_ALWAYSOVERWRITE

COMPONENT_VALUE_NEVEROVERWRITE

COMPONENT_VALUE_NEWERDATE

COMPONENT_VALUE_NEWERVERSION

COMPONENT_VALUE_OLDERDATE

COMPONENT_VALUE_OLDERVERSION

COMPONENT_VALUE_SAMEORNEWDATE

COMPONENT_VALUE_SAMEORNEWERVERSION

COMPONENT_FIELD_DESTINATION

COMPONENT_FIELD_OVERWRITE

• Remove statements that assign values to the following predefined variables (for example, TARGETDISK="C:\\";). Such
statements will not compile in InstallShield 2020; these constants are now read-only.

CMDLINE

COMMONFILES

ERRORFILENAME

FOLDER_DESKTOP

430 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

FOLDER_PROGRAMS

FOLDER_STARTMENU

FOLDER_STARTUP

ISRES

ISUSER

ISVERSION

MODE

PROGRAMFILES

SUPPORTDIR

TARGETDISK (The value of this variable is automatically updated when TARGETDIR is changed.)

UNINST

WINDIR

WINDISK

WINSYSDIR

WINSYSDISK

DLLs
• When you called a DLL function in Professional 5.x, all string arguments were passed by reference; in InstallShield
2020, you can pass a string argument by value. To specify the method for passing an argument, in the function
prototype, precede the argument’s data type with the BYREF or BYVAL keyword; for example, MyDLL.MyFunc(BYREF
NUMBER, BYVAL STRING). The InstallShield 2020 compiler includes the following compiler warnings to encourage the
use of the appropriate keyword.

• If your script includes DLL function calls where neither BYREF nor BYVAL has been specified, you receive compiler
warning W7507. To eliminate this warning, add the appropriate keyword to the function prototype.

• If you specify a literal string for a string argument that is passed by reference, you receive compiler warning
W7511. To eliminate this warning, add the BYVAL keyword to the function prototype.

When you call a function in an external DLL, make sure the same calling convention is used in the script and the DLL. In
Professional 5.x, the installation engine always used the stdcall convention but would sometimes overlook an
inconsistent DLL convention. The InstallShield 2020 engine does not; it generates an error (exception 0x80040704)
when the wrong calling convention is used.

In your script, you can declare a calling convention, either cdecl or stdcall, when declaring a DLL function. For
example:

prototype cdecl MyDLL.MyFunction (INT, INT);

If you do not explicitly declare a calling convention, InstallShield uses stdcall.

• In InstallShield 2020, InstallScript arrays are internally formatted as OLE Automation safe arrays, not native C or C++
arrays. To pass an InstallScript array to a DLL function that expects a C or C++ array, you must place the array data in
the expected format by calling GetCArrayFromISArray.

InstallShield 2020 User Guide ISP-2600-UG00 431

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• In InstallShield 2020, a string variable whose address is stored in a pointer variable cannot be changed by passing the
pointer to a DLL function. To allow a DLL function to change the value of a string variable, pass the variable itself as an
argument to the function, after declaring the data type of that argument specifying the BYREF operator.

• You no longer need to call the UseDLL function before calling a DLL that is located on Windows’ DLL search path. The
DLL search path is the following:

1. The folder from which the application loaded.

2. The current folder.

3. The 32-bit Windows system folder.

4. The 16-bit Windows system folder.

5. The Windows folder.

6. The folders that are listed in the PATH environment variable.

Use this feature with caution; the values of the current folder and PATH environment variable on an end user’s
machine are not predictable.

Miscellaneous
• The undocumented array syntax ArrayName[nArrayIndex] is no longer supported. In InstallShield 2020, the syntax for
all arrays is ArrayName(nArrayIndex).

• If you explicitly declare a return type for a script-defined function, you must specify the same return type in the
function definition, after the keyword "function", or the script will not compile. (If you do not explicitly declare a
return type, the return type is assumed to be NUMBER.) In previous versions of InstallShield Professional, return types
were assumed to be NUMBER regardless of explicit specifications of other return types, so this issue did not arise.

• To place uninstall information under HKEY_CURRENT_USER, set the value of the ALLUSERS system variable to FALSE.

• To pass a literal character as an argument to a built-in or user-defined function, you must pass its numeric ASCII value.

• When processing the system variable CMDLINE, be aware that the following command line switches are no longer
used by Setup.exe and so are included in CMDLINE: -SMS, -z, -c, -e, -q, -t, and -x. The -SMS switch is obsolete because
now Setup.exe always stays in memory until the installation is complete. The -z switch is obsolete because now
Setup.exe initializes correctly even on systems with more than 256 megabytes of memory.

• Remove Professional 5.x’s ODBC Template code, which will not compile in InstallShield 2020. This is because the
following function call is nested within the code:

ComponentGetData ( szMedia, szCompName,

COMPONENT_FIELD_DESTINATION, nvData, svDest );

In InstallShield 2020 this function call does not compile because the Destination property is a file group property, not
a component property.

Other Changes
• Pressing F3 no longer works to exit an installation.

• Setup.exe no longer supports the -f switch for using a renamed Setup.inx.

• InstallShield 2020 installations do not support including special billboards for low-resolution systems.

432 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

• If neither a source file nor the already-existing target file has a version number, and the source file’s file group’s
Overwrite property is "Newer Version", "Same or Newer Version", or "Older Version", then the file on the target system
is not overwritten. In Professional 5.x installations, the target file would be overwritten.

• InstallShield 2020 does not support displaying Windows 95-style dialogs.

• The Lang key in a silent installation’s response (.iss) file’s [Application] section no longer has any effect.

• In Professional 5.x installations, any registry key logged by the installer would be removed during uninstallation in any
case. In InstallShield 2020, keys created by RegDBCreateKeyEx and non-shared keys in registry sets are removed only
if the installer created the key, that is, the key did not exist when the installation was run.

Script Changes: Lexicon Conversion

InstallShield 2020

Terminology Change
In InstallShield Professional, the functional building blocks of your installation from the end user’s perspective were called
components. With InstallShield 2020, these building blocks are called features.

Because of this change in terminology, a number of InstallScript function names have also changed. When you upgrade a
project that you created using InstallShield Professional, some items in your script might undergo a lexicon change or be
aliased.

• Function Names

• ComponentFileInfo (FeatureFileInfo) Flags

• ComponentSetData (FeatureSetData) and ComponentGetData (FeatureGetData) Flags

Function Names
Any InstallScript function name that referred to component now refers to feature. For example, ComponentDialog is now
FeatureDialog. The parameters for these functions have not changed. Click a feature function to view the corresponding
help topic.

Table 2-15 • Function Name Changes

Component Function Feature Function

ComponentAddItem FeatureAddItem

ComponentCompareSizeRequired FeatureCompareSizeRequired

ComponentDialog FeatureDialog

ComponentError FeatureError

ComponentErrorInfo FeatureErrorInfo

ComponentFileEnum FeatureFileEnum

ComponentFileInfo FeatureFileInfo

InstallShield 2020 User Guide ISP-2600-UG00 433

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Table 2-15 • Function Name Changes (cont.)

Component Function Feature Function

ComponentFilterLanguage FeatureFilterLanguage

ComponentFilterOS FeatureFilterOS

ComponentGetData FeatureGetData

ComponentGetItemSize FeatureGetItemSize

ComponentGetTotalCost FeatureGetTotalCost

ComponentInitialize FeatureInitialize

ComponentIsItemSelected FeatureIsItemSelected

ComponentListItems FeatureListItems

ComponentLoadTarget FeatureLoadTarget

ComponentMoveData FeatureMoveData

ComponentPatch FeaturePatch

ComponentReinstall FeatureReinstall

ComponentRemoveAll FeatureRemoveAll

ComponentRemoveAllInLogOnly FeatureRemoveAllInLogOnly

ComponentRemoveAllInMedia FeatureRemoveAllInMedia

ComponentRemoveAllInMediaAndLog FeatureRemoveAllInMediaAndLog

ComponentSaveTarget FeatureSaveTarget

ComponentSelectItem FeatureSelectItem

ComponentSelectNew FeatureSelectNew

ComponentSetData FeatureSetData

ComponentSetTarget FeatureSetTarget

ComponentSetupTypeEnum FeatureSetupTypeEnum

ComponentSetupTypeGetData FeatureSetupTypeGetData

ComponentSetupTypeSet FeatureSetupTypeSet

434 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Table 2-15 • Function Name Changes (cont.)

Component Function Feature Function

ComponentTotalSize FeatureTotalSize

ComponentTransferData FeatureTransferData

ComponentUpdate FeatureUpdate

ComponentValidate FeatureValidate

SdComponentDialog SdFeatureDialog

SdComponentDialogAdv SdFeatureDialogAdv

SdComponentMult SdFeatureMult

SdComponentTree SdFeatureTree

ComponentFileInfo (FeatureFileInfo) Flags

Flags that you used with the ComponentFileInfo (now FeatureFileInfo) function in InstallShield Professional are converted
to reflect their use with features in InstallShield 2020.

Table 2-16 • ComponentFileInfo Flags

Deprecated Flag New Flag

COMPONENT_INFO_ATTRIBUTE FEATURE_INFO_ATTRIBUTE

COMPONENT_INFO_LANGUAGE FEATURE_INFO_LANGUAGE

COMPONENT_INFO_OS FEATURE_INFO_OS

COMPONENT_INFO_ORIGSIZE FEATURE_INFO_ORIGSIZE

COMPONENT_INFO_COMPSIZE

COMPONENT_INFO_DATE
Note • The flags that are not available return -137,
COMPONENT_INFO_DATE_EX which indicates that the option is not functional.
You can use the FeatureError function to provide
COMPONENT_INFO_TIME
more information about the return value.

COMPONENT_INFO_VERSIONLS FEATURE_INFO_VERSIONLS

COMPONENT_INFO_VERSIONMS FEATURE_INFO_VERSIONMS

COMPONENT_INFO_VERSIONSTR FEATURE_INFO_VERSIONSTR

InstallShield 2020 User Guide ISP-2600-UG00 435

Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

ComponentSetData (FeatureSetData) and ComponentGetData (FeatureGetData) Flags

Flags that you used with the ComponentSetData and ComponentGetData (now FeatureSetData and FeatureGetData)
functions in InstallShield Professional are converted to reflect their use with features in InstallShield 2020.

Table 2-17 • Deprecated ComponentSetData and ComponentGetData Flags

Deprecated Flag New Flag

COMPONENT_FIELD_CDROM_FOLDER FEATURE_FIELD_CDROM_FOLDER

COMPONENT_FIELD_DESCRIPTION FEATURE_FIELD_DESCRIPTION

COMPONENT_FIELD_DISPLAYNAME FEATURE_FIELD_DISPLAYNAME

COMPONENT_FIELD_FILENEED FEATURE__FIELD_FILENEED

COMPONENT_FIELD_FTPLOCATION FEATURE_FIELD_FTPLOCATION

COMPONENT_FIELD_HTTPLOCATION FEATURE_FIELD_HTTPLOCATION

COMPONENT_FIELD_IMAGE FEATURE_FIELD_IMAGE

COMPONENT_FIELD_MISC FEATURE_FIELD_MISC

COMPONENT_FIELD_PASSWORD FEATURE_FIELD_PASSWORD

COMPONENT_FIELD_SELECTED FEATURE_FIELD_SELECTED

COMPONENT_FIELD_SIZE FEATURE_FIELD_SIZE

COMPONENT_FIELD_STATUS FEATURE_FIELD_STATUS

COMPONENT_FIELD_VISIBLE FEATURE_FIELD_VISIBLE

COMPONENT_VALUE_CRITICAL FEATURE_VALUE__CRITICAL

COMPONENT_VALUE_HIGHLYRECOMMENDE FEATURE_VALUE__HIGHLYRECOMMENDED
D

COMPONENT_VALUE__STANDARD FEATURE_VALUE_STANDARD

See Also
ISAlias Table

436 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Earlier InstallShield Versions

Adding Project Assistant Dialog Support to Projects Upgraded from

InstallShield Professional
InstallShield 2020

When you upgrade an installation project from InstallShield Professional to InstallShield and the project contains a
Setup.rul file that was created in InstallShield Professional, some questions may not be available on the Installation
Interview page of the Project Assistant. This is because the Setup.rul file is missing the portions of the OnFirstUIBefore
event code that InstallShield uses to key on script tags.

If you create a new InstallScript project and look at the OnFirstUIBefore event, you will see the following code that the
Project Assistant requires in order to support dialog functions:

//{{IS_SCRIPT_TAG(FunctionName)
InstallScript code...
//}}IS_SCRIPT_TAG(FunctionName)

Task To add Project Assistant dialog support to your upgraded project:

1. In the InstallScript view, open your Setup.rul file.

2. Comment out the OnFirstUIBefore event code.

3. In the event category list at the top of the InstallScript pane, select the OnFirstUIBefore event. InstallShield re-adds
this event to your script.

4. Copy the pertinent dialog code to the commented-out code for the OnFirstUIBefore event.

5. Delete the OnFirstUIBefore event code that you added in step 3.

6. Remove the comments from the remaining OnFirstUIBefore event code.

Upgrading Projects Created with InstallShield—Windows

Installer Edition
InstallShield 2020

If you have an InstallShield project (.ism file) that was created using InstallShield—Windows Installer Edition, that project is
automatically upgraded to a Basic MSI project when you open it in InstallShield. See Converting a Basic MSI Project to an
InstallScript MSI Project to learn how to convert your upgraded project to an InstallScript MSI project.

Task When you open the project, a dialog box appears to ask if you would like to upgrade your project.

• Click Yes to upgrade your project. Your project opens in the IDE.
• Click No to leave the project unopened.

A backup copy of your original project is created and stored in the location specified in the dialog.

Upgrading a Setup from the Command Line

You can also upgrade your setup project when you build it from the command line. Use the -u parameter to upgrade your
setup project from the command line without building it.

InstallShield 2020 User Guide ISP-2600-UG00 437

Chapter 2 Getting Started
Upgrading from Other InstallShield Editions

Troubleshooting Upgrade Errors

Any errors that result from the upgrade are displayed in the output panel at the bottom of the IDE. For information on these
errors, see Upgrade Errors and Warnings (Upgrading from InstallShield—Windows Installer Edition).

See Also
Converting a Basic MSI Project to an InstallScript MSI Project
Post-Upgrade Changes in the Property Manager

Post-Upgrade Changes in the Property Manager

InstallShield 2020

Properties in the Property Manager with an empty value (no value) are invalid for MSI. Because of this,
***DO_NOT_BUILD*** appears in place of the empty value for these properties. In this way, properties with empty values
are preserved as placeholders after the upgrade, but are not built into the .msi package.

See Also
Converting a Basic MSI Project to an InstallScript MSI Project
Upgrading Projects Created with InstallShield—Windows Installer Edition

Upgrading from Other InstallShield Editions

InstallShield 2020

InstallShield is available in three different editions: Premier, Professional, and Express.

Features that Are in Only the Premier Edition

Following is a list of some of the features that are available in the Premier edition but not the Professional, or Express
editions:

• Ability to create and build Suite/Advanced UI installations—Create a bootstrap application with a contemporary,
customizable user interface for multiple .msi packages, .msp packages, InstallScript packages, .exe packages,
sideloading Windows App packages (.appx), and Windows Installer transactions, as well as multiple InstallShield
prerequisites. A Suite/Advanced UI installation packages together multiple separate installations as a single
installation while providing a unified user interface; it uses a setup launcher (Setup.exe) to conditionally launch
packages on target systems as needed.

• Support for InstallScript actions and other types of actions in Suite/Advanced UI installations—Suite/Advanced
UI installations have built-in support for launching different types of actions to perform various run-time tasks that are
outside the scope of the packages that you are including in the installation. The actions can run executable files, call
DLL functions, run PowerShell scripts, set a Suite/Advanced UI property, run InstallScript code, or call a public method
in a managed assembly at run time.

• Virtualization support—The Microsoft App-V Assistant is included in the Premier Edition of InstallShield. Use this
assistant to create customized virtual applications in the Microsoft App-V format. Virtualization enables you to isolate
an application in its own environment so that it does not conflict with existing applications or modify the underlying
operating system.

• Application Virtualization Suitability Suites—Several validation suites are available in InstallShield for helping you
to determine how ready your products are for virtualization. The InstallShield virtualization internal consistency

438 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Other InstallShield Editions

evaluators (ISVICEs) that are included in these suites let you check suitability for Microsoft App-V 4.x, Microsoft App-V
5.x, Microsoft Server App-V, VMware ThinApp, and Citrix XenApp. The validation suites can enable you to make more
informed decisions about how you should build your product if you are considering offering your customers a
virtualized version.

• Support for DIM files—The ability to create DIM projects is available in the Premier edition of InstallShield. This
support is also available in the InstallShield Developer Installation Manifest Editor, a collaboration add-on. The ability
to add DIM files to Basic MSI projects is available in the Premier edition of InstallShield.

A DIM project is a feature-sized collection of related items such as product files, shortcuts, registry entries, text file
changes, IIS Web sites, and other elements that together make up a discrete portion of a product installation. Working
with DIMs enables multiple team members to contribute to the development of the installation simultaneously. Each
software developer or other team member can work on a separate DIM that the release engineer can reference in one
or more Basic MSI projects.

• Multilingual installations—Create a single installation that displays end-user text in multiple languages and can
handle conditional installation of language-specific files. Change dialogs and messages to any one of 34 additional
languages using pre-translated strings.

Project • Note that support for two of those languages—Arabic (Saudi Arabia) and Hebrew—is available in only Basic
MSI and Merge Module projects.

• Arabic (Saudi Arabia) and Hebrew language support—InstallShield Premier Edition includes support for Arabic
(Saudi Arabia) and Hebrew languages, which are written and read from right to left. All of the default end-user dialog
strings are available in these languages.

Since these languages are read from right to left, the Premier edition also includes support for mirroring Arabic and
Hebrew dialogs; that is, InstallShield uses a right-to-left layout for Arabic and Hebrew dialogs. Thus, for example,
buttons that are on the right side of dialogs in English and other left-to-right languages are moved to the left side of
right-to-left-language dialogs.

• Ability to specify commands that run before, during, and after builds—InstallShield Premier Edition includes
release settings that you can use to specify commands that you want to be run at various stages of the build process.
You can schedule commands that run at the following build events: (a) before InstallShield starts building the release,
(b) after InstallShield has built the .msi package and the .cab files (if your product’s data files are to be stored in .cab
files), but before the .msi package has been digitally signed and streamed into the Setup.exe file, and (c) after
InstallShield has built and signed the release.

• Ability to distribute installations to virtual machines that InstallShield provisions at build time or on demand—
You can configure your projects so that after each successful build of your installation, InstallShield automatically
reverts a virtual machine (VM) to a designated snapshot, powers on the VM, and copies your installation to the VM to
make it available for testing. You can also alternately perform these testing preparation steps on demand at any time.
The testing preparation capability makes it possible to reduce testing time and eliminate manual steps. The VM can be
on a Microsoft Hyper-V Server, a VMware ESX or ESXi Server, or a VMware Workstation.

• Extra licenses for InstallShield MSI tools—InstallShield includes several tools: InstallShield MSI Diff, InstallShield
MSI Query, InstallShield MSI Sleuth, and InstallShield MSI Grep. You can use these tools to troubleshoot issues with
Windows Installer packages. InstallShield Premier Edition includes a separate installation and extra licenses that let
you install just the InstallShield MSI tools, without InstallShield, on separate machines. For specific terms, see the
End-User License Agreement for the InstallShield MSI tools.

InstallShield 2020 User Guide ISP-2600-UG00 439

Chapter 2 Getting Started
Upgrading from Other InstallShield Editions

• Ability to import IIS data from existing IIS Web sites into a project—InstallShield includes an IIS scanner
(IISscan.exe), a command-line tool for scanning an existing IIS Web site and recording IIS data about the Web site.
The IIS scanner creates an XML file that contains all of the settings for the Web site, its virtual directories, its
applications, and its application pools. You can use the XML file to import the IIS data into the Internet Information
Services view in InstallShield Premier Edition. Once you have imported the IIS data into a project, you can use the
Internet Information Services view to make changes to the IIS settings as needed.

• Support for deploying Web Deploy packages—Suite/Advanced UI installations, available in the Premier edition of
InstallShield, have built-in support for deploying Web Deploy packages to IIS Web servers and the cloud.

• InstallShield Collaboration—InstallShield Premier Edition includes licenses for InstallShield Collaboration for Visual
Studio.

• Network repository—A network repository is a collection of installation elements that multiple installation authors
can access and reuse in their projects as needed. A network repository fosters collaboration among installation
authors; it is stored on a network.

• InstallShield Best Practice Suite—InstallShield includes a set of validators called the InstallShield Best Practice
Suite. The InstallShield Best Practice (ISBP) validators in this suite alert you if your installation violates best-practice
guidelines.

• Additional dialog themes—Several dialog themes are available only in the Premier edition of InstallShield.

Features that Are in Only the Premier and Professional Editions

Following is a list of some of the features that are available in the Premier and Professional editions but not the Express
edition:

• Ability to create and build Advanced UI installations—Create a bootstrap application with a contemporary,
customizable user interface for a single .msi package, .msp package, or InstallScript package, as well as multiple
InstallShield prerequisites. An Advanced UI installation uses a setup launcher (Setup.exe) to conditionally launch
packages on target systems as needed.

(Note that the Suite/Advanced UI functionality in the Premier edition of InstallShield includes extended support for
this functionality: The Suite/Advanced UI functionality enables you to package multiple .msi packages, .msp
packages, InstallScript packages, .exe packages, sideloading Windows App packages (.appx), and Windows Installer
transactions, as well as multiple InstallShield prerequisites into a single installation with a contemporary, unified,
customizable user interface.)

• Standalone Build—This tool, which is available with the Premier and Professional editions of InstallShield, enables
you to install only the part of InstallShield that builds the installations, plus any redistributables that you want to
include, on a build machine. Extra licenses of the Standalone Build are available for purchase.

• Dialog Editor—The Dialog Editor enables you to modify the layout of existing end-user dialogs or create new custom
dialogs. Import and export dialogs to share them across projects. Construct different dialogs for each language
supported in the project.

• InstallShield MSI tools—The Premier and Professional editions of InstallShield includes several tools: InstallShield
MSI Diff, InstallShield MSI Query, InstallShield MSI Sleuth, and InstallShield MSI Grep. You can use these tools to
troubleshoot issues with Windows Installer packages.

• Automation interface—Use script to add new files, add or delete features, change the product name and upgrade
code, change release settings, change summary information stream items, change release flags, change any property,
initiate the build process, and more.

440 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Other InstallShield Editions

• Release customization—Define which project segments to compress, which features to place on which disk, and
which languages to include. Choose to filter application data based on language to support localization efforts.

• Source code control integration—Simplify the process of checking projects in and out of your source code control
system and save space when differencing projects. The SCC integration in the Premier and Professional editions of
InstallShield supports integration with various source code control systems.

• Flexible localization support—The Premier and Professional editions of InstallShield include a String Editor view,
which gives you complete and centralized control over the localizable text strings that are displayed at run time
during the installation process. You can use this view to edit the strings for everything from button text to feature
descriptions. This view also includes support for exporting string entries (which you can have translated) and for
importing translated string entries back into your project.

• Project validation—Use standard .cub files to validate installations and merge modules. Use the upgrade and
patching validation to find out about potential upgrade problems and resolve them before you release your upgrades
and patches.

• Patch creation—In addition to enabling you to create QuickPatch projects, the Premier and Professional editions let
you create standard patches that contain updates to a previous version of your product.

• Manage multiple product versions—Build versions such as Evaluation, Debug, Standard, and Advanced—from a
single project. Allow specific features, InstallShield prerequisites, and other elements to be chosen for inclusion in (or
exclusion from) a release through user-defined flags.

• Support for InstallScript—The Premier and Professional editions of InstallShield include support for InstallScript, a
simple but powerful programming language. You can add InstallScript custom actions to Windows Installer–based
installations or create InstallScript projects, which use the InstallScript engine instead of the Windows Installer engine
to control the entire installation.

• Flexible custom action support—The Premier and Professional editions of InstallShield include support for several
custom action types that are not available in the Express edition. These extra custom action types enable you to do
the following: set a property, set a directory, call a public method in a managed assembly, or display error message
under certain conditions and abort the installation.

• Flexible shortcut support—The Premier and Professional editions of InstallShield include support for configuring
various advanced settings for shortcuts that are not configurable in the Express edition. For example, the Premier and
Professional editions let you prevent a shortcut in your project from being pinned to the taskbar or to the Start menu.
They also let you prevent a shortcut on the Start menu from being highlighted as newly installed after end users install
your product. These shortcut options are often used for tools or secondary products that are part of an installation.

• Merge module authoring and editing—Package pieces of a project for reuse across application installations. Reuse
those you create or any of the ones included in the product. Edit and open modules for greater customization.

• Project templates—Create project templates that contain all of the default settings and design elements that you
want to use as a starting point when you create an installation project or merge module project.

• Multiple IIS Web sites—The Express and Limited editions of InstallShield let you install only one Web site per
installation. The Premier and Professional editions let you install more than one Web site per installation.

• Support for IIS application pools and Web service extensions—Install and manage IIS application pools and Web
service extensions.

• Advanced support for Windows services—Although the Express edition of InstallShield includes some support for
working with services, the Premier and Professional editions of InstallShield include additional flexibility for services.
For example, the Premier and Professional editions enable you to start, stop, or delete a service during installation or

InstallShield 2020 User Guide ISP-2600-UG00 441

Chapter 2 Getting Started
Upgrading from Other InstallShield Editions

uninstallation; the service can be part of your installation, or it can be already present on target systems. These
editions also let you configure extended service customization options that were introduced in Windows Installer 5.

• SQL support—Connect to SQL servers, import database schema and data, associate SQL scripts with features, and
more with SQL support.

• Ability to modify text files or XML files—Use the Text File Changes view or the XML File Changes view to configure
files that you want to modify on the target system at run time.

• Pure 64-bit support—Windows Server Core supports disabling 32-bit Windows-on-Windows (WOW64) support. As this
configuration becomes more popular, you may want to ensure that your 64-bit applications can install without any
reliance on 32-bit functionality. To make this possible, the Premier and Professional editions of InstallShield include
support for building pure 64-bit .msi packages; these can be run on 64-bit Windows-based systems that do not have
WOW64 functionality.

• InstallShield Prerequisite Editor—Use this tool to create new InstallShield prerequisites and modify existing ones.

• Custom icons for Setup.exe and Update.exe—Specify a custom icon (.exe, .dll, or .ico file) that you want to use for
Setup.exe and Update.exe files that you create at build time. The icon is displayed on the Properties dialog box for
Setup.exe; this Properties dialog box opens when end users right-click the Setup.exe file and then click Properties.
End users can also see the icon when they view your Setup.exe file in Windows Explorer.

• Expiration dates for Setup.exe—Set an expiration date, as well as an expiration message, for Setup.exe. If end users
try to run Setup.exe on or after the date that you have specified in your project, the expiration message is displayed,
and the installation exits.

• Support for installation of multiple packages using transaction processing—Windows Installer 4.5 and later
include support for installing multiple packages using transaction processing. The Premier and Professional editions
of InstallShield let you add chained .msi packages to an installation project. Your package, plus the added .msi
packages, are chained together and processed as a single transaction. If one or more of the packages in the
transaction cannot be installed successfully or if the end user cancels the installation, the Windows Installer initiates
rollback for all packages to restore the system to its earlier state.

• Ability to export and reuse various project elements—Increase efficiency by moving pieces of an existing project
(dialogs, custom actions, or features) to a merge module or another installation project.

• Multiple-instance support—Create an installation that lets end users install multiple instances of a product on the
same machine and in the same user context.

• Device driver support—Device driver support in the Premier and Professional editions simplifies the process of
installing device drivers from installation using the Driver Installation Frameworks for Applications (DIFxApp) from
Microsoft.

• Additional Dialog Themes—Several dialog themes are available only in the Premier and Professional editions of
InstallShield. The Limited and Express editions contain only two themes.

• Conversion of Visual Studio merge module projects—The Premier and Professional editions of InstallShield let you
convert a Visual Studio merge module project to an InstallShield merge module project; this is necessary if you want
to build a merge module for consumption in other projects.

• COM+ application proxy support—Manage COM+ application proxies during your installation. A COM+ application
proxy consists of a subset of the attributes of the server application, and it enables remote access from a client
machine to the machine where the application resides.

For additional details about the features that are included with each edition, contact InstallShield Sales, or visit http://
www.installshield.com.

442 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Upgrading from Other InstallShield Editions

To learn about upgrading from one edition to another, see the appropriate topic:

• Upgrading from the Express Edition to the Professional or Premier Editions

• Upgrading from the Professional Edition to the Premier Edition

Upgrading from the Express Edition to the Professional or

Premier Editions
InstallShield 2020

If you have an Express project type that was created using the Express edition of InstallShield, that project is upgraded to a
Basic MSI project when you open it in the Premier or Professional edition of InstallShield. This upgrade is done because
Basic MSI is the comparable project type for the Express project type. QuickPatch projects created with the Express edition
remain as QuickPatch projects in the Premier and Professional editions of InstallShield.

When you open any project created with the Express edition in the Premier or Professional edition, InstallShield converts
the file from an .ise file to an .ism file. A backup of your .ise file is saved before the conversion takes place.

Billboard properties from Express edition projects will not be migrated since they are not supported in Basic MSI projects.
You will receive warning 701 when the billboards property is specified in Express edition projects.

Task To upgrade an Express edition project:

Open the project in the Premier or Professional edition of InstallShield. A dialog box opens to ask if you would like to
upgrade your project.

• Click Yes to upgrade your project. Your project opens in InstallShield.

• Click No to leave the project unopened.

A backup copy of your original project is created and stored in the location specified in the dialog box.

Upgrading from the Professional Edition to the Premier

Edition
InstallShield 2020

When you open a Professional edition project in the Premier edition, your project does not need to be converted. It opens
seamlessly in the Premier edition, enabling you to take advantage of Premier edition–only features. To learn about the
specific features, see Upgrading from Other InstallShield Editions.

For additional information about the features included with each edition, visit http://www.installshield.com.

InstallShield 2020 User Guide ISP-2600-UG00 443

Chapter 2 Getting Started
Converting or Importing Visual Studio Projects into InstallShield Projects

Converting or Importing Visual Studio Projects into

InstallShield Projects
InstallShield 2020

Visual Studio includes limited support for creating setup and merge module projects. InstallShield lets you convert or
import these types of Visual Studio projects into InstallShield projects so that you can use the advanced features and
functionality in InstallShield to create installations and merge modules.

With InstallShield, you can do the following:

• Import a Visual Studio setup project (.vdproj) into an InstallShield Basic MSI or Merge Module project (.ism), or import
a Visual Studio merge module project (.vdproj) into an InstallShield Basic MSI or Merge Module project (.ism). These
tasks enable you to create InstallShield installation and merge module projects that contain the same data and
settings that were in your Visual Studio project. During the import process, you can choose to import or ignore certain
settings in the Visual Studio project.

• Convert a Visual Studio setup project to an InstallShield Basic MSI project, or convert a Visual Studio merge module
project to an InstallShield merge module project. Converting a Visual Studio merge module project to an InstallShield
Merge Module project is necessary if you want to build a merge module for consumption in other projects.

Note • If your Visual Studio project contains one or more project outputs, you can use InstallShield to import that Visual
Studio project into an InstallShield project; however, InstallShield cannot convert that Visual Studio project into an
InstallShield project.

The following versions of Visual Studio are supported:

• Visual Studio 2010

• Visual Studio 2008

• Visual Studio 2005

• Visual Studio .NET 2003

• Visual Studio .NET

Benefits of Using an InstallShield Project Instead of a Visual Studio Project

If you convert or import your Visual Studio project into an InstallShield project, you can use the features in InstallShield to
fully customize your project.

Following is a list of a few of the tasks that you can perform in InstallShield projects but not in Visual Studio projects:

• Modify the layout of dialogs through a visual Dialog Editor.

• Manage components and features.

• Store custom actions in the Binary table of the .msi or .msm database. (With Visual Studio, all custom actions must be
installed with the product.)

• Manage SQL-related tasks, such as connecting to a SQL server and running SQL scripts.

• Manage IIS Web sites, applications, virtual directories, application pools, and Web service extensions.

444 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Converting or Importing Visual Studio Projects into InstallShield Projects

• Add billboards that are displayed during file transfer.

• Modify XML files or other text files on the target system at run time.

• Create shortcuts to pre-existing files on a target system.

• Manage COM+ applications.

Import Process
InstallShield lets you import a Visual Studio setup or merge module project into an InstallShield Basic MSI or Merge Module
project.

Note • If the Visual Studio setup or merge module project that you want to import into an InstallShield project contains one or
more project outputs, the InstallShield project must be in the same Visual Studio solution that contains the Visual Studio setup
or merge module project and all of its project dependencies.

In order to import a Visual Studio project that contains project outputs, you must be using InstallShield from within Visual
Studio. If your InstallShield project is open in InstallShield, but not from within Visual Studio, and you try to import a Visual
Studio project that contains project outputs into the InstallShield project, an error occurs.

Task To import a Visual Studio project (.vdproj) into an InstallShield project (.ism):

1. In InstallShield, create or open the Basic MSI or Merge Module project.

2. On the Project menu, click the Visual Studio Deployment Project Wizard button.

3. Complete the panels of the Visual Studio Deployment Project Wizard.

InstallShield imports the Visual Studio project into your open InstallShield project based on the settings that you
configured in the wizard. As InstallShield imports the project, it displays the status of the project import in the Output
window. The Output window shows each step of the conversion process, and it lists any conversion errors and warnings.

Conversion Process
If you use InstallShield to convert a Visual Studio setup project, InstallShield creates an InstallShield Basic MSI project
(.ism).

If you use InstallShield to convert a Visual Studio merge module project, InstallShield creates an InstallShield Merge
Module project (.ism).

Task To convert a Visual Studio project (.vdproj) to an InstallShield project (.ism):

1. Open InstallShield.

2. On the File menu, click Open. The Open dialog box opens.

3. In the Files of type box, select Visual Studio Setup Projects (*.vdproj).

4. Browse to the location of the Visual Studio project that you want to open, and select the project file.

5. Click the Open button.

InstallShield 2020 User Guide ISP-2600-UG00 445

Chapter 2 Getting Started
Converting or Importing Visual Studio Projects into InstallShield Projects

InstallShield creates an InstallShield project based on the settings in the Visual Studio project. InstallShield stores the .ism
file in the same folder as the .vdproj file. As InstallShield creates the .ism file, it displays the status of the project conversion
in the Output window. The Output window shows each step of the conversion process, and it lists any conversion errors
and warnings.

Once the conversion process finishes successfully, the new InstallShield project is displayed in InstallShield.

Post-Import and Post-Conversion Tasks

Prerequisite Tasks
Visual Studio lets you add one or more predefined prerequisites to one or more configurations in a Visual Studio setup
project. The import and conversion processes in InstallShield attempt to convert all of the prerequisites in all of the
configurations to equivalent InstallShield prerequisites. If InstallShield does not include a corresponding InstallShield
prerequisite, warning -9071 occurs, alerting you that the prerequisite could not be converted. To resolve this warning,
consider creating an InstallShield prerequisite that installs the required redistributable, and add that InstallShield
prerequisite to your project. For more information, see Defining InstallShield Prerequisites and Working with InstallShield
Prerequisites that Are Included in Installation Projects.

User-Interface Tasks
The import and conversion processes do not incorporate the dialogs from a Visual Studio project into the InstallShield
project. Once you have imported or converted your project, you can use the Dialogs view in InstallShield to configure
settings for the dialogs in your project.

Language Tasks
If you imported a Visual Studio project into an InstallShield project and the following conditions exist, InstallShield
replaces the existing string entry values in your project with default string entry values for the language of your Visual
Studio project:

• You indicate in the Visual Studio Deployment Project Wizard that you would like to import the language of the Visual
Studio project.

• The language of your Visual Studio project does not match the default language in your InstallShield project. (In Visual
Studio, the Localization property indicates the project’s language. In InstallShield, the Default Language setting in the
String Editor view indicates the project’s default language.)

• InstallShield has support for the language that is used in your Visual Studio project. (If you are using the Professional
edition of InstallShield, you may not have support for the language that is used in your Visual Studio project.)

For example, if you indicate in the Visual Studio Deployment Project Wizard that you would like to import the language of
the Visual Studio project, if the language of your InstallShield project is Spanish, if the language of your Visual Studio
project is German, and if you are using the Premier edition of InstallShield, InstallShield replaces the Spanish run-time
strings in your project with the default German translations. Thus, if you edit a string entry value by revising a setting such
as the Publisher setting in the General Information view, and then you indicate in the wizard that you want to import the
language of a Visual Studio project, InstallShield overwrites the value of the Publisher setting—as well as values for other
settings—with the default German string entry values.

Therefore, if you change the project language while importing your Visual Studio project, review the settings in the General
Information view and the String Editor view, and modify the string entry values if appropriate.

446 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Obtaining Updates for InstallShield

.NET Installer Class Tasks

If your Visual Studio project includes a .NET installer class custom action, InstallShield configures the .NET installer class
information for the .NET assembly’s component during the conversion process, instead of creating a .NET installer class
custom action. InstallShield does not include support for the Condition property of a .NET installer class custom action in
Visual Studio. Therefore, if your Visual Studio project contains a .NET installer class custom action that has a condition, you
may want to use the Components view in InstallShield to create a condition for the component that contains the .NET
assembly after you have converted your project.

Additional Tasks
You can also use the other views in InstallShield to make additional changes to your project.

Note • Visual Studio lets you specify a directory path that contains multiple formatted properties, such as
[ProgramFilesFolder][Manufacturer]\[ProductName], for the application folder. Visual Studio projects use a directory custom
action to resolve the path at run time. However, InstallShield does not support this type of directory path. Therefore,
InstallShield resolves the path during the conversion process and uses the INSTALLDIR property for the path.

See Also
Working with Dialogs in Basic MSI Projects
Visual Studio Deployment Project Import Wizard

Obtaining Updates for InstallShield

InstallShield 2020

If you have an Internet connection, you can view the updates and obtain the latest InstallShield prerequisites, merge
modules, and objects; service packs; patches; and other updates for the version of InstallShield that you are using.

Task To check for updates:

InstallShield shows an update dialog when an update is available. To obtain the updates, perform the following steps:

• View the updates for your system.

• View description and release notes about the updates.

• Download and install the updates.

See Also
Including Redistributables in Your Installation
Standalone Build

InstallShield 2020 User Guide ISP-2600-UG00 447

Chapter 2 Getting Started
Run-Time Language Support in InstallShield

Run-Time Language Support in InstallShield

InstallShield 2020

Important • Language support varies, depending on the edition of InstallShield that you are using, the project type, and the
language of the InstallShield interface (English or Japanese).

Note that support for Arabic (Saudi Arabia) and Hebrew is available only in Basic MSI, Merge Module, and Suite/Advanced UI
projects in the Premier edition.

The InstallShield Premier edition includes default run-time strings in 35 supported languages. When you add a supported
language to a project, that language is made available in various language-related settings throughout InstallShield. In
addition, InstallShield adds translated string entries for that language to your project. The string entries are for the default
dialogs, messages, and other end-user interface elements. For a list of the supported languages, see Language Identifiers.

The InstallShield Premier edition also lets you add unsupported languages, beyond the built-in 35 languages, to Basic MSI,
InstallScript, InstallScript MSI, and Suite/Advanced UI projects through the New Language Wizard. An unsupported
language is one in which none of the default run-time strings are translated. When you add an unsupported language to a
project, that language is made available in various language-related settings throughout InstallShield. In addition,
InstallShield uses the strings from your project’s default language as placeholders for the strings in that newly added
unsupported language; you can use the String Editor view to provide translated strings for the unsupported languages.

The English version of the InstallShield Professional edition lets you select one of 33 languages (any of the supported
languages, except for Arabic or Hebrew) to use as the run-time language for all of the projects that you create. The English
version of the InstallShield Professional edition includes default run-time strings for the one language that you have
selected.

The Japanese version of the InstallShield Professional edition lets you select English plus one additional supported
language; that is, if you are using the Japanese version of the InstallShield Professional edition, you can create projects
with English run-time strings as well as projects with run-time strings from one other supported language. The Japanese
version of the InstallShield Professional edition includes default run-time strings in English, plus the one additional
supported language that you have selected.

If you want to modify the default run-time strings or you are adding custom dialogs, messages, and other end-user
interface elements to your project, you can enter the custom run-time strings directly in your InstallShield project. As an
alternative, you can export a language’s string entries to a file, translate the string values in the file, and then import the
translated file into your project. This support is available in all editions of InstallShield.

To learn more about language support in InstallShield, see the following sections of the documentation:

• Localizing the End-User Interface

• Creating Multilingual Installations

• Code Page Requirements for Language Support

• Settings for Languages

448 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 2 Getting Started
Run-Time Language Support in InstallShield

Code Page Requirements for Language Support

InstallShield 2020

If you plan on creating releases that include run-time strings in a language that includes double-byte characters (for
example, Japanese, Greek, or Korean), determine whether you need to install any code pages on your build machine.

Unicode encoding is used to display run-time strings throughout InstallShield. With Unicode encoding, double-byte
characters are displayed correctly within InstallShield, even if InstallShield is on a system that does not have a project’s
target languages installed. In addition, you can build releases on a system that does not have the release’s target
languages.

However, if you use ANSI encoding for run-time strings (for example, if you export the string entries from a project as an
ANSI text file and then import the translated ANSI text file into your project), you need to install the code pages for those
languages on your build machine. The code pages allow your system to accurately represent the characters of those
languages. If your build machine does not have the code pages installed, InstallShield reports a build error when you try to
build a release, and the installation does not display double-byte characters properly at run time.

Tip • It is recommended that you use Unicode encoding instead of ANSI encoding when you are exporting string entries to a
file for translation.

See Also
Exporting and Importing String Entries
Installing Supplemental Language Support on a Build Machine

Installing Supplemental Language Support on a Build Machine

InstallShield 2020

The following instructions explain how to install code pages on a build machine that has Windows XP. This may be
necessary if you want to build releases that contain Chinese, Japanese, and Korean languages. On later operating systems,
the code pages are typically installed by default.

Task To install code pages on a build machine that has Windows XP:

1. In the Control Panel, launch Regional and Language Options.

2. Click the Languages tab.

3. Click the Details button.

4. Click the Add button.

5. Select the language for which you want to add a code page.

6. Click OK.

The following instructions explain how to install files for right-to-left languages such as Arabic and Hebrew on a build
machine that has Windows XP. On later operating systems, these files are typically installed by default. If these files are not
installed, the String Editor view may display the strings left to right instead of right to left.

InstallShield 2020 User Guide ISP-2600-UG00 449

Chapter 2 Getting Started
Supported Application Programming Languages

Task To install right-to-left language support on a build machine that has Windows XP:

1. In the Control Panel, launch Regional and Language Options.

2. Click the Languages tab.

3. In the Supplemental language support area, select the Install files for complex script and right-to-left languages
check box.

4. Click the Add button.

5. Select the language for which you want to add a code page.

6. Click OK.

7.

See Also
Code Page Requirements for Language Support

Supported Application Programming Languages

InstallShield 2020

InstallShield allows you to create installations for applications created in any programming language—including
applications created with Java, Pascal, C++, Visual Basic, Delphi, C# .NET, Visual Basic .NET, ASP .NET, and Cobol.

Even if you created your application using a language other than those listed above, you can use InstallShield to create an
installation for your application. In addition—if you are not deploying an application, but want to package files or a
database—you can use InstallShield to assist with those tasks.

See Also
Project Types

450 ISP-2600-UG00 InstallShield 2020 User Guide

 3
Tutorials

InstallShield 2020

This section contains tutorials that walk you through the process of creating an installation using InstallShield.

Table 3-1 • Available Tutorials

Tutorial Description

InstallScript Leads you step-by-step through the process of creating an InstallScript installation project. The
Project Tutorial tutorial also provides information about the various tasks associated with installation projects and
introduces you to the views in the InstallShield interface in which you can accomplish these tasks.

Basic MSI Teaches you how to a Basic MSI installation project. The tutorial also provides information about the
Project Tutorial various tasks associated with installation projects and introduces you to the views in the
InstallShield interface in which you can accomplish these tasks.

Globalization Shows you how to add languages and language-specific components to your project. Additionally, it
Tutorial shows you how to conditionally install components based on the target system’s language.

Note • The Premier edition of InstallShield must be installed on your development system in order to
successfully complete this tutorial.

InstallShield 2020 User Guide ISP-2600-UG00 451

Chapter 3 Tutorials

452 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

InstallScript Project Tutorial

InstallShield 2020 » InstallScript Project Tutorial

This tutorial guides you through the process of creating, building, running, and enhancing an InstallScript installation
using InstallShield.

The tutorial is divided into several steps. After the first step—Step 1: Creating, Building, and Testing Projects—the other
steps can be performed independently, and in any order, so you can focus on the information relevant to your work.

In this tutorial, you will learn how to handle many of the tasks that an installation needs to address, including:

• Installing files

• Setting up shortcuts and registry data

• Conditionally installing data

• Changing the installation’s user interface

• Building release images

• Testing the installation

Throughout the tutorial are links to related topics in the Help Library.

Begin the tutorial

Step 1: Creating, Building, and Testing Projects

InstallShield 2020 » InstallScript Project Tutorial

This step demonstrates how to create an installation project, build a release image, and test the installation. After
completing this step, you will know how to:

• Use the Project Assistant to create a new project.

• Specify global properties of your installation project.

• Define setup types, features, components, and file links.

• Build a release image for duplication and distribution.

• Run your installation from the InstallShield user interface.

An installation is made up of three levels:

Table 3-1 • Levels Within an Installation

Level Description

Components A component is the smallest separately installable piece of your product from the
developer’s viewpoint. A component specifies files, shortcuts, registry data, and other data
to be installed on the target system. The end user never directly interacts with
components.

A component can be placed in more than one feature, and the component’s data will be
installed if the user selects at least one feature associated with the component.

InstallShield 2020 User Guide ISP-2600-UG00 453

Chapter 3
InstallScript Project Tutorial

Table 3-1 • Levels Within an Installation (cont.)

Level Description

Features A feature is the smallest separately installable piece of your product from the user’s
viewpoint. If the user selects the Custom setup type, a dialog is displayed in which the user
can choose which features to install.

Each feature contains components.

Setup Types Setup types are predefined collections of features. By default, an installation offers
Complete and Custom setup types, and the end user selects which setup type to install in
the SetupType dialog.

The installation that you will create in this tutorial installs and configures an application called Tutorial App. The source
files for Tutorial App are located in one of the Samples subfolders within the InstallShield Program Files folder. The default
installation location is:

C:\Program Files\InstallShield\2020\Samples\WindowsInstaller\Tutorial Project

Continue

Creating a Project with the Project Assistant

InstallShield 2020 » InstallScript Project Tutorial

After launching InstallShield, create a new InstallScript project by doing the following:

1. Open the New Project dialog box by doing one of the following:

• Click the Create a new project link in the Start Page’s Project Tasks section (on the left of the page).

• On the File menu, click New.

• Click the toolbar’s New Project button

2. In the New Project dialog box, click the InstallScript tab.

3. In the InstallScript tab’s list view, select the InstallScript Project icon.

4. In the Project Name edit box, type the project name Tutorial.

5. Click OK.

There are many other ways to create a project, such as updating a project created using InstallShield Professional. For
more information, see Creating New Projects.

InstallShield creates a project file called ProjectName.ism, in this case Tutorial.ism. The project file stores all the settings
you make in the InstallShield user interface. To move a project to another machine, copy the .ism file (and the installation
source files) to the other system.

Tip • You can change the directory where new project files are created by choosing Options from the Tools menu, selecting
the File Locations tab, and entering the new location in the “Project Location” field.

454 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

Your new project is opened to its Project Assistant tab. To begin using the Project Assistant, click the Next button in the
lower right corner.

Tip • You can do the Project Assistant’s steps in any order, and switch at any time (by clicking the appropriate tab) between
the Project Assistant and the Installation Designer, in which you can add more complex and powerful elements to your
installation project.

Continue

Specifying Application Information

InstallShield 2020 » InstallScript Project Tutorial

The Application Information page lets you specify general information about the application that you are installing.

Task For this tutorial, do the following:

1. In the Specify your company name edit box, type the name Tutorial Co.

2. In the Specify your application name edit box, type the name Tutorial App.

3. Leave the other fields unchanged.

The value you enter in the application name field is used in dialogs displayed to the end user, as the display name for your
application in Add or Remove Programs in the Control Panel. The application name and company name you enter
determine the default location of application shortcuts on the Windows Start menu, and the default value for the
TARGETDIR system variable, which specifies the default destination for components’ files.

Continue

Customizing the Installation Architecture

InstallShield 2020 » InstallScript Project Tutorial

The Installation Architecture page lets you specify the features you want to be displayed by your installation. A feature is
the smallest separately installable piece of your product from the end user’s standpoint. Individual features are visible to
end users when they select a Custom setup type.

Note • Features can contain subfeatures, subsubfeatures, and so forth, to as many levels as your installation requires.

Task For this tutorial, do the following:

1. For the Do you want to customize your Installation Architecture? question, select Yes.

2. Select the existing DefaultFeature feature and rename it ProgramFiles.

3. Create a new feature called HelpFiles. To do so, click Installation Architecture and then click the New button.

Continue

InstallShield 2020 User Guide ISP-2600-UG00 455

Chapter 3
InstallScript Project Tutorial

Adding Files to Your Project

InstallShield 2020 » InstallScript Project Tutorial

The Application Files page lets you specify the files you want to link with each of your features.

First, select from the list of features the feature in which you want to insert files. To add file links, click the Add Files button,
and then browse for the file or files you want to include in the selected feature.

Task For this tutorial, add the Tutorial.exe file to the ProgramFiles feature by doing the following:

1. In the list of features, click ProgramFiles.

2. In the tree control (with top node Destination Computer), select Application Target Folder.

3. Click Add Files.

4. Browse for Tutorial.exe, which is located in your source directory.

5. When the "The file you have added ... may have dependencies" message appears, click No; Tutorial.exe has no
dependencies.

Continue

Creating Shortcuts
InstallShield 2020 » InstallScript Project Tutorial

The Application Shortcuts page lets you specify shortcuts for your application’s files on the target system’s desktop or Start
menu. By default, this page displays a shortcut for each executable that you have included in your installation project; you
can delete these, and add shortcuts to other files that you have included in your installation project.

For this tutorial, leave this page’s default specifications unchanged: a shortcut to Tutorial.exe on the Start menu.

Continue

Configuring Registry Data

InstallShield 2020 » InstallScript Project Tutorial

The Application Registry page lets you specify any registry entries that your application requires.

Note • An InstallScript project includes script code that by default creates the application uninstallation key
(Software\Microsoft\Windows\CurrentVersion\Uninstall\<GUID> under the HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER
root key as appropriate) and its values and data; you do not need to specify these registry entries.

For this tutorial, do not specify any registry entries in this page. Registry entries are covered in

Step 2, Shortcuts and Registry Data, of the tutorial.

Continue

456 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

Selecting Dialogs with the Installation Interview

InstallShield 2020 » InstallScript Project Tutorial

The Installation Interview page lets you specify the dialogs that you want the end user to see when your installation runs.
Based on your answers to the questions on this page, the Project Assistant adds the corresponding dialog function to your
installation script. Script changes related to dialogs are covered in Step 6 of the tutorial.

Task For this tutorial, do the following:

1. Select the No option button under the text "Do you want to display a License Agreement Dialog?"

2. Leave the other option buttons set to Yes.

Continue

Choosing a Language for Your Installation

InstallShield 2020 » InstallScript Project Tutorial

The Installation Localization page lets you specify the languages that your installation supports. It also lets you specify
string values and associated identifiers, which you can use in your end user interface to make your installation more easily
localizable in other languages.

Edition • Multilingual language support is available in the Premier edition of InstallShield.

Task For this tutorial, change the display name of the HelpFiles feature by doing the following:

1. In the list box, select Feature String Data. The table on the right displays all of the feature string entries.

2. In the Value column, click HelpFiles (the value associated with the identifier IDS_FEATURE_DISPLAY_NAME2), and
change it to Help Files; that is, add a space.

Continue

Building Your Installation

InstallShield 2020 » InstallScript Project Tutorial

The Build Installation page lets you specify what type of distribution you want to build (and, optionally, the location to
copy the distribution files to).

Task For this tutorial, do the following:

1. Select the CD-ROM option.

2. Click Build Installations.

InstallShield 2020 User Guide ISP-2600-UG00 457

Chapter 3
InstallScript Project Tutorial

The output window opens with the Build tab uppermost and displays information about the progress of the build. The
build is finished when the Build tab displays the line "Build finished at date and time".

Continue

Running Your Installation

InstallShield 2020 » InstallScript Project Tutorial

To run your installation from within InstallShield, click the Run toolbar button or press CTRL+F5.

The installation displays the dialogs that you specified in the Installation Interview Page of the Project Assistant. The values
you entered in the Project Assistant are displayed to the end user in the appropriate dialogs. For example, at run time, the
default value of TARGETDIR that you specified in the Project Assistant appears in the Choose Destination Location dialog. If
the end user browses for a different destination directory, TARGETDIR stores the new value.

After the installation is complete, you can browse for the directory and find the files installed by your setup program. If the
installation was successful, you will see the tutorial files installed.

Maintenance Mode
When a user runs an installation a second (or later) time for a product installed on their system, the installation runs in
maintenance mode. Maintenance mode allows the user to modify feature selections from the first-time installation, repair
the features already installed, or remove the entire program.

Uninstalling the Program

To uninstall the program, click the Run button (or press CTRL+F5), and select Remove from the Setup Maintenance dialog.
This is the same behavior a user sees when selecting your application in Add or Remove Programs.

Now that you have created a basic installation project, click the Installation Designer tab (near the top of the window) to
expand and fine-tune your installation as illustrated in the next step of the tutorial.

See Also
Troubleshooting Your Installation
Configuring the Enable Maintenance Setting

Working with the InstallShield Interface

InstallShield 2020 » InstallScript Project Tutorial

Now that you have created a basic installation project, click the Installation Designer tab (near the top of the window) to
expand and fine-tune your project in the InstallShield user interface. The InstallShield user interface is arranged in
functional categories that help you add or edit information in your project. This and later steps of the tutorial explore
several of the different InstallShield views.

After completing this step, you will know how to:

• Set display properties for your program features.

• Define your program’s setup types.

• Create components and add file links.

Continue

458 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

See Also
Automation Interface

Setting Feature Properties

InstallShield 2020 » InstallScript Project Tutorial

First, you will set additional properties for the features you created in the Project Assistant, such as the feature display
name and description. To edit the feature properties, go to the Features view in the IDE.

Task To set feature properties:

1. On the Go menu, point to Organization and click Features.

2. In the Features explorer, click the DefaultFeature feature and set its Description property to This feature contains
the Tutorial App program files.

3. Select the New Feature feature and set its Description property to This feature contains the Tutorial App help
files. As you enter each description, InstallShield creates a string entry—displayed as {ID_STRINGn}—to represent
each value.

4. Rename the features in the Features view to have the same names as their respective display names. To rename a
feature, click the feature twice to highlight its name, then type the new name.

At run time, if the end user chooses the Custom setup type, the installation displays a dialog that prompts the user to select
which features to install. This dialog displays features using the display name and description you specified here.

Continue

See Also
Features View

Setting Setup Type Properties

InstallShield 2020 » InstallScript Project Tutorial

Setup types are collections of features to be installed. A typical installation offers Complete and Custom setup types—
where the Complete setup type installs all features, and a Custom setup type displays a dialog that lets the end user choose
which features to install.

You modify setup type properties in the Setup Types view of the IDE (under the View List’s Organization node).

Task For each setup type, select the features to be installed by selecting the boxes in front of the features’ names:

1. For the Complete setup type, select both features.

2. For the Custom setup type, select both features.

Continue

See Also
Setup Types View

InstallShield 2020 User Guide ISP-2600-UG00 459

Chapter 3
InstallScript Project Tutorial

Creating Components and File Links

InstallShield 2020 » InstallScript Project Tutorial

You can add links to additional files in the Files and Folders view. In this step, you will add a file to your HelpFiles feature. As
you add files in the Files and Folders view, the IDE creates components for you according to Setup Best Practices rules.

Task To add the source file Tutorial.html to a new component in the Help Files feature:

1. Go to the Files and Folders view (under the View List’s Application Data node).

2. Select Help Files from the feature list at the top of the view.

3. In the “Destination computer’s folders” area, right-click the Destination Computer icon and verify that Show
Components is selected.

4. Right-click the Application Target Folder icon and select New Component.

5. Rename the new component HelpComponent.

6. In the “Source computer’s folders” area, browse for the source folder containing TutorialHelp.html.

7. Drag the TutorialHelp.html icon from the “Source computer’s files” area and drop it on the HelpComponent icon.

This type of file linking, where the list of files linked to a component does not change, is called static file linking. To link to a
directory (and possibly its subdirectories) whose contents might change between builds, see Dynamic File Linking.

Tip • You can use the InstallShield dependency scanners to determine additional files required by your application that are
currently not included in your project. For example, Tutorial App uses MFC, so it will be necessary to add the MFC Runtime
object to your project in the Redistributables view if you intend to target systems that do not have the MFC run-time libraries
installed.

The next step of the tutorial explains how to build a release image for your installation project.

See Also
Files and Folders View
Redistributables
Static Scanning Wizard
Dynamic Scanning Wizard

Building a Release
InstallShield 2020 » InstallScript Project Tutorial

Before testing an installation, it is necessary to build a release. A release image contains all of the files to be distributed to
the end user on a CD-ROM or floppy disk or from a network location.

The simplest way to build a new release is to use the Release Wizard. The Release Wizard is where you specify release
properties, such as the type of media (CD-ROM, for example) to use and whether to compress files on the media. You can
launch the Release Wizard by clicking the Release Wizard toolbar button, or by choosing Release Wizard from the Build
menu.

460 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

Click Next in the Welcome panel to specify your release settings. You can click Help in any panel for more information about
the current step.

Continue

Naming the Release

InstallShield 2020 » InstallScript Project Tutorial

In the Specify a Release panel, specify a release name. The release name is used as the name of a folder in which your built
release will be placed. For this example, create a new release called cdrom.

Continue

Selecting the Media Type and General Options

InstallShield 2020 » InstallScript Project Tutorial

Media Type Panel

In the Media Type panel, you specify the type of media for which you are building a release. The media type you specify
indicates the size of the disk image folders the Release Wizard creates: when you build a release for CD-ROM, the Release
Wizard divides your disk images into folders, each of which is smaller than 650 MB.

For this tutorial, select CD-ROM.

Click Next to specify general options for your release.

General Options Panel

The General Options panel lets you do the following:

• Create a self-extracting executable file for distributing your installation

• Pass command line options to Setup.exe

• Pass preprocessor variable definitions to the compiler

• Select whether to place the compiled script file (.inx file) in a cabinet file

For this tutorial, leave the panel’s default settings unchanged.

Continue

Specifying a Password and Supported Platforms

InstallShield 2020 » InstallScript Project Tutorial

Password Panel
In the Password panel, you can specify a password for your installation, and, if you do, whether to execute the password-
checking code in the OnCheckMediaPassword event handler function’s default code.

For this tutorial, do not specify a password.

Click Next to specify the operating systems you want to support in the current release.

InstallShield 2020 User Guide ISP-2600-UG00 461

Chapter 3
InstallScript Project Tutorial

Platforms Panel
In the Platforms panel, you can specify the operating systems you want to support in the current release.

For this tutorial, do not change the default selection: Use platforms specified by the Platforms project property.

Continue

Specifying Setup Languages and Including Features

InstallShield 2020 » InstallScript Project Tutorial

Setup Languages Panel

In the Setup Languages panel, you can specify the languages you want your installation to be able to run in, and whether to
display a dialog that allows the end user to select the language in which they want the setup displayed.

The wizard will build into your installation only those language-specific elements, including string entries and dialogs, that
you select in this panel. All language-independent resources, such as product properties and built-in actions, are included
as a matter of course.

For this tutorial, leave the default selections unchanged.

Click Next to specify which features you want to include in the current release.

Features Panel
In the Features panel, you can specify which features are included in the built release.

For this tutorial, do not change the default selection: Use the ‘Include in Build’ feature property to determine inclusion.

Continue

Defining Media Layout and Dialog Appearance

InstallShield 2020 » InstallScript Project Tutorial

Media Layout Panel

In the Media Layout panel, specify, for individual features or for all features, whether the features’ files are stored in cabinet
files or placed uncompressed in the disk image.

For this tutorial, do not change the default selection: "Cabinet File(s)".

User Interface Panel

In the User Interface panel, specify the look and feel of your installation’s end user dialogs.

For this tutorial, leave the default selections unchanged.

Continue

462 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

Specifying Internet Options and Digitally Signing Your Application

InstallShield 2020 » InstallScript Project Tutorial

Internet Options Panel

In the Internet Options panel, specify various Internet-related options. Any release can be run over the Internet, regardless
of its media type.

For this tutorial, check the Create a default Web page for the setup box and leave the other default selections unchanged.

Digital Signature Panel

In the Digital Signature panel, you can digitally sign your application. Digitally signing your application helps to assure your
end users that the code within your application has not been modified or corrupted since publication.

For this tutorial, leave the default selections unchanged.

Continue

Specifying Update and Postbuild Information

InstallShield 2020 » InstallScript Project Tutorial

Update Panel
The Update panel lets you specify the release format and the existing releases for which the current release can be run as
an update.

For this tutorial, leave the default selections unchanged.

Postbuild Options Panel

The Postbuild Options panel lets you copy disk image folders to a folder or FTP site, or execute a batch file, after the release
build is complete.

For this tutorial, leave the default selections unchanged.

Continue

Reviewing Your Settings

InstallShield 2020 » InstallScript Project Tutorial

The Summary panel displays the Release Wizard settings for the current release. If the settings are correct, select the Build
the Release check box and click Finish to build your release. If not, click Back to modify the settings.

Status messages for the build in progress are displayed in the output window.

When the build is complete, the files to copy onto the CD are placed in the following directory:

<ProjectFolder>\Tutorial\cdrom\DiskImages\DISK1.

After making changes to your project in later steps of the tutorial, you can rebuild the latest release by clicking the Build
toolbar button, choosing Build from the Build menu, or pressing F7.

InstallShield 2020 User Guide ISP-2600-UG00 463

Chapter 3
InstallScript Project Tutorial

You can now run the installation as you did previously in this tutorial. To run the installation as an Internet installation,
click the toolbar’s Open Release Folder button and launch Setup.htm.

The next step of the tutorial explains how to create shortcuts and registry data for an installation.

See Also
Release Wizard
Troubleshooting Your Installation
Building a Release from the Command Line

Troubleshooting Your Installation

InstallShield 2020 » InstallScript Project Tutorial

After running your installation, if files are not installed, check the following parts of your project:

• Verify that TARGETDIR is set to the proper value. This is set in the General Information view.

For this tutorial, the recommended value is as follows:

[ProgramFilesFolder]TutorialCo\TutorialApp

• Verify that your setup types have features associated with them.

• Verify that your features have components and files associated with them.

• After making any changes to your installation, it is necessary to rebuild your project by clicking the Build button or
pressing F7.

See Also
Build Errors and Warnings
Setup.exe Return Values and Run-Time Errors (Basic MSI and InstallScript MSI Projects)
Validating Projects

Step 2: Shortcuts and Registry Data

InstallShield 2020 » InstallScript Project Tutorial

This step explains how to use the IDE to:

• Create program shortcuts

• Create registry information

Continue

Creating Shortcuts
InstallShield 2020 » InstallScript Project Tutorial

You create and modify shortcuts in the Shortcuts view. The properties of a shortcut include its display name, its target
executable and arguments, and the icon it displays. Using the Project Assistant, you have already created a shortcut to
Tutorial App in the end user’s Programs folder, under the Start menu.

464 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

Task In this step you create a shortcut on the end user’s desktop.

1. Go to the Shortcuts view.

2. Right-click the Desktop icon and select New Shortcut. The Browse for Shortcut Target dialog box opens.

3. In the dialog box, select Application Target Folder from the Look in drop-down menu and select Tutorial.exe from
the files list.

4. Click Open to close the Browse for Shortcut Target dialog box.

5. Rename the shortcut icon to an internal name such as tutorial.

Next, set the following properties for the shortcut:

Table 3-2 • Shortcut Properties

Property Value Comment

Display Name Tutorial App InstallShield adds the display name to the project’s
strings (and displays the string identifier in curly braces
in the Display Name field) so that the name can be
easily localized to other languages.

Target <TARGETDIR>\Tutorial.exe

Icon File <TARGETDIR>\Tutorial.exe

Icon Index 0

Working Directory <TARGETDIR>

Tip • To create a shortcut to a file already located on the user’s machine, enter the path to the file—using system variables to
represent the path to the file, when possible. For example, to launch a copy of Windows Notepad located in the user’s Windows
or WinNT folder, enter the shortcut target as <WINDIR>\Notepad.exe.

Continue

See Also
Shortcuts View

Creating Registry Data

InstallShield 2020 » InstallScript Project Tutorial

Another common requirement for installations is to write information to the target system’s registry. To add registry data
to a component, you can use the Registry view.

For example, to create a registry value called TutorialData under HKEY_LOCAL_MACHINE\Software\Tutorial

Co\Tutorial\1.00.0000:

InstallShield 2020 User Guide ISP-2600-UG00 465

Chapter 3
InstallScript Project Tutorial

Task To create registry data:

1. Go to the Registry view.

2. In the Destination computer’s Registry view area, right-click Destination Computer and select New Registry Set.

3. Rename the registry set tutorial.

4. Under the tutorial registry set, right-click HKEY_LOCAL_MACHINE and from the New submenu select Key.

5. Rename the key Software.

6. Repeat the process for subkeys named Tutorial Co, Tutorial, and 1.00.0000.

7. In the Destination computer’s Registry data area, right-click and select New String Value.

8. Rename the value TutorialData.

9. Double-click the TutorialData value and enter <TARGETDIR> in the Value data field.

10. Click the tutorial registry set, and in the Registry Set Install Conditions pane check DefaultComponent.

At run time, if the end user selects a setup type or collection of features that includes the Tutorial.exe component, the
registry data is created on the target system.

Verifying that the Shortcut Was Created

Task To verify that your installation created the shortcut:

1. Rebuild your project by clicking the Build toolbar button or pressing F7.

2. Run the project by clicking the Run button or pressing CTRL+F5 (first removing any existing version of the program
from your system). A shortcut to Tutorial App should be present in the Programs folder of your Start menu.

Verifying that the Registry Data Was Created

Task To verify that the installation created the registry data:

1. Launch Tutorial App from its shortcut.

2. From the Tutorial menu, choose Verify Registry Data. If the registry data was created, a message box displaying the
text <TARGETDIR> is displayed.

The next step of the tutorial explains how to register a COM server (self-registering file).

Step 3: Registering COM Servers

InstallShield 2020 » InstallScript Project Tutorial

For many files, the installation’s only requirement is to copy the files from the source media to the target system. For
others, the installer also needs to register the files with the target system. One category of file that needs extra handling is a
self-registering file.

466 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

In this step you will create a component that installs and registers Tutorial.ocx and an HTML file that uses it.

A COM server is usually a DLL or .ocx file that requires extra information to be written to the target system’s registry before
applications and Web pages that use the self-registering file can find it.

Task To install a self-registering file:

1. Go to the Files and Folders view.

2. At the top of the Files and Folders view, in the View Filter list, select the ProgramFiles feature.

3. In the Source computer’s folder pane, browse for Tutorial.ocx in your source directory.

4. Drag Tutorial.ocx from the Source computer’s folders pane and drop it into the Destination computer’s folders
pane’s Application Target Folder. The component SelfRegFiles is created under Application Target Folder; this
component contains Tutorial.ocx and has its Self-Register property set to Yes, as you can verify by right-clicking the
component and selecting Properties.

Next, add the HTML file to a new component also associated with the ProgramFiles feature.

Task To add the HTML file to a new component associated with the ProgramFiles feature:

1. In the Destination computer’s folders pane of the Files and Folders view, right-click Application Target Folder and
select New Component.

2. Rename the component OcxHTML.

3. Drag the file TutorialCtrl.html from the Source computer’s files view into the OcxHTML component.

Task After rebuilding your release (by pressing F7) and running the installation (by pressing CTRL+F5), you can verify that the
file was registered properly:

1. Launch Tutorial App using its shortcut in the Programs menu, or by double-clicking its icon.

2. Choose COM Server Test from the Tutorial menu.

3. If the COM server was registered correctly, the HTML page displays a “success” message.

The next step of the tutorial demonstrates how to install files conditionally.

Step 4: Conditions and Properties

InstallShield 2020 » InstallScript Project Tutorial

In this step, you will learn how to conditionally install data on a target system.

A common requirement for installations is to install certain files on a system only if particular conditions are met. For
example, files may be specific to an operating system or language, or should be installed only if the user has appropriate
privileges.

InstallShield 2020 User Guide ISP-2600-UG00 467

Chapter 3
InstallScript Project Tutorial

To install a component (and its files and other data) only on particular operating systems, you can use the component’s
Operating Systems property. You can modify a component’s properties by opening the Setup Design view, expanding the
feature icon that contains the feature, and selecting the desired component.

Task To create a component that will be installed only on systems that have Windows 8:

1. Go to the Setup Design view.

2. Right-click the HelpFiles feature and select New Component.

3. Rename the component to windows_8_files.

4. Click the Files icon for the component and add the file ReadmeNT.txt from your source folder by right-clicking in the
Files pane and browsing to the file.

5. Click the windows_8_files component to display the component’s property grid.

6. Select the component’s Operating Systems setting and click the browse button. The Platforms dialog opens.

7. Select the Windows 8 check box.

8. Click OK.

After you rebuild (by pressing F7) and run the installation (by pressing CTRL+F5), and any files or other data contained in
the component will be installed only if the target system is running Windows 8.

The next step of the tutorial describes how to modify your project’s script.

See Also
FeatureSelectItem Function

Step 5: Working with Scripts

InstallShield 2020 » InstallScript Project Tutorial

InstallShield uses the InstallScript language to drive an installation. You can modify the project’s script in the InstallScript
view.

Tip • Press CTRL+M to maximize the Script Editor; press CTRL+M again to restore it.

InstallScript project scripts use an event-driven model, where a series of predefined functions are called in a specific order.
For information about the built-in categories of event handlers and the order in which event handler functions are called,
see Event Handlers.

The functions already defined in your script appear in the Functions tree. To view or edit an existing function, click its name
in the Functions tree.

Note • Event handler functions are called even if they do not explicitly appear in your script. If an event handler function does
not appear in your script, its default code is used.

468 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

To add and edit an event handler function, select the desired event category (such as Before Move Data) from the script
editor’s left drop-down list, and then select the name of the desired event (such as Begin) from the right drop-down list.
Event handler functions that are already explicitly defined in your script appear in boldface text.

For example, the OnBegin event handler is the first function called in an installation script, for both a first-time installation
and maintenance mode.

Task To add your own code to the OnBegin event handler, begin by creating the function:

1. Select Before Move Data from the event category list on the left.

2. Select Begin from the event handler list on the right.

The following code is added to your script:

//////////////////////////////////////////////////////////////////////////////
//
// FUNCTION: OnBegin
//
// EVENT: Begin event is always sent as the first event during
// installation.
//
//////////////////////////////////////////////////////////////////////////////
function OnBegin( )
begin
// TO DO: you may change default non-UI settings, for example
//
// You may also perform your custom initialization steps, check requirements, etc.
end;

You can place any code you want to execute at the beginning of your installation in the OnBegin function.

Using the Function Wizard

This example demonstrates how to use the Function Wizard to add a call to the MessageBox function. This displays a
message when the user begins the installation.

Task To add the MessageBox function to your OnBegin function:

1. Delete the comments (lines beginning with //) between the lines reading begin and end;, and place the text insertion
point between the lines.

2. Press CTRL+I to launch the Function Wizard.

3. In the Function Category list, select Built-in dialog.

4. In the Function Name list, select MessageBox.

5. Click Next.

6. In the szMsg field—which contains the message you want to display—type "Welcome to the Tutorial installation!"
(including the quotation marks).

7. In the nType drop-down list—which specifies the type of message box to display—select INFORMATION.

InstallShield 2020 User Guide ISP-2600-UG00 469

Chapter 3
InstallScript Project Tutorial

8. Click Finish to paste your function call into the script.

Your OnBegin function should now appear as follows:

function OnBegin( )
begin
MessageBox ( "Welcome to the Tutorial installation!" , INFORMATION );
end;

Compiling the Script

After modifying the script, you must compile the script for the changes to take effect. Compile the script by clicking the
Compile toolbar button, choosing Compile from the Build menu, or pressing CTRL+F7. Status messages are displayed
during compilation in the output window of the IDE.

Tip • If compiling the script results in any errors or warnings, you can double-click the error message to highlight the script
line where the error occurred.

When you run the installation (by clicking the Run toolbar button, or by pressing CTRL+F5), the message box appears
before the Welcome dialog is displayed.

Displaying the Message only for First-Time Installation

The OnBegin function is called for both a first-time installation and a maintenance-mode installation, which means the
message box will be displayed when the user reinstalls or removes the program. To display the message box only for a first-
time installation, you can place your MessageBox call inside an if statement that determines if the user is running the
installation for the first time.

InstallScript defines a system variable called MAINTENANCE, which is true if the installation is running in maintenance mode
and false otherwise. To display your message box only for a first-time installation, change the OnBegin function to read as
follows:

function OnBegin( )
begin
if (!MAINTENANCE) then
MessageBox("Welcome to the Tutorial installation!", INFORMATION);
endif;
end;

After you compile and run the installation, the message box appears only for a first-time installation, and not for
maintenance mode.

InstallScript
The InstallScript language contains hundreds of functions for performing installation-related tasks, such as working with
the registry and INI files, testing characteristics of the target operating system, and displaying dialogs. For details and
examples, see the InstallScript Language Reference.

The next step of the tutorial explains how to modify the dialogs that are displayed by your installation.

470 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

Step 6: Changing the User Interface

InstallShield 2020 » InstallScript Project Tutorial

This step describes three ways you can modify the user interface of your installation:

1. Taking different actions based on user input.

2. Modifying user-interface-related script functions to display different dialogs.

3. Modifying the layout and properties of a dialog using the Dialog Editor.

Continue

See Also
Displaying Billboards

Handling User Input

InstallShield 2020 » InstallScript Project Tutorial

In your InstallScript code, the event handler functions that contain the dialog functions displayed at run time are:

• OnFirstUIBefore, which contains the dialogs to be displayed before data transfer for a first-time installation.

• OnFirstUIAfter, which contains the dialogs to be displayed after data transfer for a first-time installation.

• OnMaintUIBefore, which contains the dialogs to be displayed before data transfer for a maintenance-mode
installation.

• OnMaintUIAfter, which contains the dialogs to be displayed after data transfer for a maintenance-mode installation.

Note • The OnMaintUIBefore and OnMaintUIAfter event handler functions are not called if the project’s Maintenance
Experience property is set to "No uninstall or maintenance".

A default InstallScript project created with the Project Assistant defines the OnFirstUIBefore event handler function,
which defines the user interface for a first-time installation. OnFirstUIBefore calls dialog functions to display the dialogs
that you specified in the Project Assistant’s Installation Interview page. For example, the following code displays a dialog
that prompts the end user to enter a user name and company name:

szMsg = "";
szTitle = "";
nResult = SdRegisterUser( szTitle, szMsg, szName, szCompany );

The end user’s user name and company name are returned in the last two variables, which you can then use in any way you
want, for example, to create a registry key or check against information you have stored in a file.

Continue

Changing the Dialogs Displayed

InstallShield 2020 » InstallScript Project Tutorial

The InstallScript language includes many predefined dialogs that you can display in your installation’s user interface.

InstallShield 2020 User Guide ISP-2600-UG00 471

Chapter 3
InstallScript Project Tutorial

Task To replace the default user information dialog with one that also prompts the user for a serial number, you can replace
the SdRegisterUser function with a call to SdRegisterUserEx:

1. In the InstallScript view, select OnFirstUIBefore from the Functions node.

2. Declare the string script variable szSerial by adding the following to the declarations before begin in the
OnFirstUIBefore() function:

string szSerial;

3. Delete the lines containing the call to SdCustomerInformation:

Dlg_SdRegisterUser:
szMsg = "";
szTitle = "";
nResult = SdRegisterUser( szTitle, szMsg, szName, szCompany );
if (nResult = BACK) goto Dlg_SdLicense2;

4. Replace the deleted lines with the following:

Dlg_SdRegisterUserEx:
szMsg = "";
szTitle = "";
szSerial = "";
nResult = SdRegisterUserEx(szTitle, szMsg, szName, szCompany, szSerial );
if (nResult = BACK) goto Dlg_SdLicense2;

5. Change goto statements that previously pointed to Dlg_SdRegisterUser to point to Dlg_SdRegisterUserEx.

6. Press CTRL+F7 to compile the script.

Using this approach, you can insert additional dialog in your installation’s user interface, or replace existing ones.

Continue

See Also
Dialog Functions
Dialog Customization Functions

Using the Dialog Editor

InstallShield 2020 » InstallScript Project Tutorial

The Dialog Editor allows you to modify the appearance of dialog displayed by your installation.

As shown in the previous step, the serial number entered by the end user is displayed in the SdRegisterUserEx dialog as
plain text.

Task To modify the dialog so the password is hidden as the end user types it:

1. In the Dialogs view (which is under the List View’s User Interface node), right-click the SdRegisterUserEx icon and
select Edit.

2. Select the English (United States) icon.

472 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
InstallScript Project Tutorial

3. In the Dialog Editor, select the edit field under the Serial Number label.

4. Change the Password property of the Edit control from False to True.

Tip • To maximize the Dialog Editor view, press CTRL+M.

After rebuilding the project (by pressing F7) and running it (by pressing CTRL+F5), the serial number entered by the user will
be hidden.

Tip • To restore a dialog to its default appearance, right-click the dialog’s icon and select Revert Dialog to Default.

End of Tutorial

InstallShield 2020 User Guide ISP-2600-UG00 473

Chapter 3
InstallScript Project Tutorial

474 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

Basic MSI Project Tutorial

InstallShield 2020

This tutorial guides you through the process of creating, building, running, and enhancing a Basic MSI installation project
using InstallShield.

The tutorial is divided into several steps. After the first step—Step 1: Creating, Building, and Testing Your Project—the other
steps can be performed independently, and in any order, so you can focus on the information relevant to your work.

In this tutorial, you will learn how to handle many of the tasks that an installation needs to address, including:

• Installing files

• Setting up shortcuts and registry data

• Conditionally installing data

• Registering COM servers

• Changing the installation’s user interface

• Building releases

• Testing the installation

Throughout the tutorial are links to related topics in the InstallShield Help Library.

Begin the tutorial

Step 1: Creating, Building, and Testing Your Project

InstallShield 2020 » Basic MSI Tutorial » Step 1

This step demonstrates how to create an installation project, build a release image, and test the installation. After
completing this step, you will know how to:

• Use the Project Assistant to create a new project.

• Configure many of the settings in your installation project.

• Define features, components, and file links.

• Build a release for duplication and distribution.

• Run your installation.

InstallShield 2020 User Guide ISP-2600-UG00 475

Chapter 3
Basic MSI Project Tutorial

Basic MSI Installation Building Blocks

A Basic MSI installation is made up of two levels:

Table 3-1 • Levels Within a Basic MSI Installation

Level Description

Components A component is the smallest separately installable piece of your product from the developer’s
viewpoint. A component contains files, shortcuts, registry data, and other data to be installed
on the target system. The end user never directly interacts with components.

A component can be placed in more than one feature, and the component’s data will be
installed if the user selects at least one feature associated with the component.

Features A feature is the smallest separately installable piece of your product, from the end user’s
viewpoint. If the end user selects the Custom setup type during the installation, a dialog with
which the user can choose which features to install is displayed.

Each feature contains components.

Tutorial Files
The installation that you will create in this tutorial installs and configures an application called Tutorial App. The source
files for Tutorial App are located in one of the Samples subfolders within the InstallShield Program Files folder. The default
installation location is:

C:\Program Files\InstallShield\2020\Samples\WindowsInstaller\Tutorial Project

Continue

Creating a New Basic MSI Project

InstallShield 2020 » Basic MSI Tutorial

The first step in the tutorial is to create a new Basic MSI project.

Task To create a new Basic MSI project:

1. On the File menu, click New, or click the New Project button in the toolbar. The New Project dialog box opens.

2. Click the Windows Installer tab and select the Basic MSI project type.

3. In the Project Name field, enter Tutorial.

4. In the Location setting, leave the default value.

5. Select the Create the project in ‘Project Name’ subfolder check box.

6. Click OK.

InstallShield creates and opens your project.

476 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

InstallShield creates a project file called ProjectName.ism, or in this case, Tutorial.ism. The project file stores all of the
settings that you configure in InstallShield. To move a project to another machine, copy the .ism file (and the installation
source files) to the other system.

Tip • To change the default directory where new project files are created, open the Options dialog box (available when you
click Options on the Tools menu). On the File Locations tab, in the Location setting, enter a new path.

Continue

Specifying Application Information

InstallShield 2020 » Basic MSI Tutorial

After you create a new project, the Project Assistant launches to help you specify project and application information. The
first page in the Project Assistant provides a graphical overview of the installation creation process. To begin using the
Project Assistant, click the Application Information icon at the bottom of the view.

The Application Information page is where you specify general information about the application that your project will
install.

Task To specify application information for the tutorial:

1. In the Specify your company name setting, enter TutorialCo. This automatically updates the information in the
Specify your company Web address setting.

2. In the Specify your application name setting, enter TutorialApp. The value that you enter is used on dialogs that are
displayed to end users. It is also used as the display name for your application in Add or Remove Programs.

3. In the Specify your application version and Specify your company Web address settings, leave the default values.

4. Click the Browse button under the Application Icon setting, and browse to the Tutorial.exe location. The default
location is C:\Program Files\InstallShield\2020\Samples\WindowsInstaller\Tutorial Project. Open the .exe
file and select the Icon Index:0.

The Application Information panel will look like the following when you are finished.

Figure 3-1: Application Information Panel

InstallShield 2020 User Guide ISP-2600-UG00 477

Chapter 3
Basic MSI Project Tutorial

The application name and company name you enter determine the default location of application shortcuts on the
Windows Start menu, and the default value for the INSTALLDIR property, which specifies the default destination for your
program’s files.

Note • The default value of INSTALLDIR is [ProgramFilesFolder]Your Company Name\Your Product Name. The special form
[ProgramFilesFolder] expands to the location of the user’s Program Files folder at run time. For a list of the other directory
properties that are defined by Windows Installer, see the System Folders Set by the Installer section in Windows Installer
Property Reference.

Continue

Setting Installation Requirements

InstallShield 2020 » Basic MSI Tutorial

The Installation Requirements page allows you to easily set installation requirements for the target system. For example, if
your application requires a specific operating system in order to run properly, you can indicate that in the first section of
this panel.

Operating
If your application required a certain version of Windows or later to run on the target system, you would select Yes and then
select the operating systems with which your application can run properly.

For the tutorial, leave No selected

Software Requirements
If your application’s installation requires that a particular piece of software be installed on the target system, select Yes
and select the required software. To customize the run-time message that will be displayed if the required software is not
present on the target system, click on the run-time message and edit.

Note • The run-time message is not displayed in this section until a software requirement is selected.

For the tutorial, leave No selected.

Continue

Customizing Installation Architecture

InstallShield 2020 » Basic MSI Tutorial

The Installation Architecture page lets you specify the features that you want your installation to display to end users. A
feature is the smallest separately installable piece of your product from the end user’s standpoint. Individual features are
visible to end users when they select a Custom setup type during installation.

Note • Features can contain subfeatures, subsubfeatures, and so forth, to as many levels as your installation requires.

478 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

Your installation architecture currently contains a default feature, Tutorial_Files. The default feature is always installed
when an end user runs your installation. In this step, you will add another feature to the installation architecture.

Task For the tutorial, add a new Help_Files feature:

1. Select Yes for the Do you want to customize your Installation Architecture? option.

2. Right-click the Installation Architecture node and select New.

3. Name the new feature Help_Files.

When you finish this step, your installation architecture will look like this:

Figure 3-2: Installation Architecture

Continue

Adding Files to Your Project

InstallShield 2020 » Basic MSI Tutorial

The next step is to add your application’s files to the installation project. The Application Files page lets you specify the files
you want to associate with each of your features.

In this step, you will add the Tutorial executable file to the Tutorial_Files feature.

Task To add the Tutorial executable to the Tutorial_Files feature:

1. Select the Tutorial_Files feature from the drop-down list of features at the top of the page.

2. In the tree control (with top node Destination Computer), select the INSTALLDIR node.

3. Click Add Files. An Open dialog box opens.

4. Browse to Tutorial.exe, which is located in the Tutorial Files source directory.

5. Click Open to add the file to the Tutorial_Files feature.

6. When the file you have added ... may have dependencies message appears, click No. Tutorial.exe has no
dependencies. The file is added to the feature and appears in the file list panel on the right.

Note • The key icon next to the file indicates that this file is the key file of the feature’s component. Windows Installer requires
that most components have a single key file. The Windows Installer service uses a component’s key file for several purposes,
including checking for the file’s existence to determine if a component needs to be repaired and using the key file as the

InstallShield 2020 User Guide ISP-2600-UG00 479

Chapter 3
Basic MSI Project Tutorial

default target for a shortcut. When you add an executable file to a feature in a Basic MSI project, the Project Assistant
automatically sets it as the key file of the component it creates behind the scenes for the file. For more information, see Setting
Component Key Files.

Continue

Creating Shortcuts
InstallShield 2020 » Basic MSI Tutorial

The Application Shortcuts page lets you specify shortcuts for your application’s files on the target system’s desktop or Start
menu. By default, this page displays a shortcut for each executable that you have included in your installation project. You
can delete these, and add shortcuts to other files that you have included in your installation project.

Task To activate the shortcut to Tutorial.exe:

Click the Launch Tutorial.exe icon. Leave the default setting, Create shortcut in Start menu, selected. InstallShield will
create a shortcut to Tutorial.exe on the end user’s Start menu when the installation is run.

Continue

Configuring Registry Data

InstallShield 2020 » Basic MSI Tutorial

The Application Registry page lets you specify any registry entries that your application requires.

For the tutorial, do not specify any registry entries in this page. Registry entries are covered in Step 2: Shortcuts and
Registry Data.

Continue

Selecting Dialogs with the Installation Interview

InstallShield 2020 » Basic MSI Tutorial

The Installation Interview page lets you specify the dialogs that you want end users to see when your installation runs.
Based on your answers to the questions on this page, the Project Assistant adds the corresponding dialog to your
installation project.

Task To specify dialogs for the tutorial, do the following:

1. Do you want to display a License Agreement Dialog?—Select No. If you selected Yes for this option, you would be
able to browse to your license agreement file.

2. Do you want to prompt users to enter their company name and user name?—Select Yes. The installation displays
a dialog requesting this information.

3. Do you want your users to be prompted to modify the installation location of your application?—Select Yes. For
more information, see Allowing End Users to Modify the Installation Location.

480 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

4. Do you want users to be able to selectively install only certain parts of your application?—Select Yes. For more
information, see Creating Selectively Installable Installations.

5. Do you want to give users the option to launch your application when the installation completes?—Select Yes
and browse to the Tutorial.exe file (located in [ProgramFilesFolder]TutorialCo\Tutorial). When this option is set to
Yes, the final dialog in the installation presents a check box that allows the end user to immediately launch your
application upon clicking the Finish button.

Continue

Choosing a Language for Your Installation

InstallShield 2020 » Basic MSI Tutorial

The Installation Localization page lets you specify the languages your installation supports, and specify string values and
associated identifiers, which you can use in your end user interface to make your installation more easily localizable in
other languages.

Edition • For language options in addition to the language that you chose when you installed InstallShield, you must have
the Premier edition of InstallShield.

Task For this tutorial, leave English (United States) selected and change the display names of the installation’s features by
doing the following:

1. In the list box, select Feature String Data. The table on the right displays all of the feature string entries.

2. In the Value column, click Tutorial_Files (the value associated with the identifier IDS_FEATURE_DISPLAY_NAME2)
and change it to Tutorial Files.

3. Click Help_Files (the value associated with the identifier IDS_FEATURE_DISPLAY_NAME3) and change it to Help
Files.

Note • For more information, see Creating Multilingual Installations.

Continue

Building Your Installation

InstallShield 2020 » Basic MSI Tutorial

After defining your installation project’s architecture, adding your application files, creating shortcuts, and selecting
dialogs, you are ready to build the installation.

The Build Installation page lets you specify what type of distribution you want to build and, optionally, the location to
which you want to copy the distribution files.

InstallShield 2020 User Guide ISP-2600-UG00 481

Chapter 3
Basic MSI Project Tutorial

Task To build the installation you have just created:

1. Select the CD-ROM option.

2. Click Build Installations.

The Output window opens and displays information about the progress of the build.

Note • The build generates warning -7235. This is expected. You can continue to the next step without resolving this warning,
or to resolve this warning, configure the settings in the Software Identification Tag area of the General Information view as
needed. If Yes is selected for the Use Software Identification Tag setting but you have not entered values in one or more of the
required identification settings (the Unique ID, Tag Creator, and Tag Creator ID settings in the General Information view), build
warning -7235 occurs, once for each of the settings that are blank. For more information, refer to Including a Software
Identification Tag for Your Product.

In the next step, you will run your installation.

Continue

Running Your Installation

InstallShield 2020 » Basic MSI Tutorial

After completing the Project Assistant steps in this tutorial, you have created a fully functional installation that installs the
Tutorial executable.

Task To run your installation:

Click the Run button on the toolbar or press CTRL+F5.

The installation displays the dialogs that you specified in the Installation Interview page of the Project Assistant. The values
you entered in the Project Assistant are displayed to the end user in the appropriate dialogs. For example, at run time, the
default value of INSTALLDIR that you specified in the Project Assistant appears in the Choose Destination Location dialog
box. If the end user browses for a different destination directory, INSTALLDIR stores the new value.

After the installation is complete, you can browse for the directory and find the files installed by your installation. If the
installation was successful, you will see the tutorial files installed.

Maintenance Mode
When a user runs an installation a second (or later) time for an application installed on their system, the installation runs in
maintenance mode. Maintenance mode allows the user to modify feature selections from the first-time installation, repair
the features already installed, or remove the entire application.

482 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

Uninstalling the Application

Task To uninstall the Tutorial application:

Click Uninstall.

Now that you have created a basic installation project, click the Installation Designer tab (near the top of the InstallShield
window) to expand and fine-tune your installation as illustrated in the next step of the tutorial.

See Also
Troubleshooting Your Installation

Working in the IDE

InstallShield 2020 » Basic MSI Tutorial

After creating a project, you set properties of the project in the InstallShield installation development environment, or IDE.
The IDE is arranged in functional categories that help you add or edit information in your project. This and later steps of the
tutorial explore several of the IDE views.

Note • The views displayed in the IDE differ, depending on the project type you create.

After completing this step, you will know how to:

• Set properties for your program features.

• Create components and add file links.

Continue

See Also
Automation Interface

Setting Feature Properties

InstallShield 2020 » Basic MSI Tutorial

First, you will set additional properties for the features you created in the Project Assistant, such as the feature display
name and description. To edit the feature properties, go to the Features view in the IDE.

Task To set feature properties for this tutorial, do the following:

1. Open the Features view. The Features view is located in the Organization section of the View List.

2. In the Features view, select the Tutorial_Files feature to display its property grid on the right.

3. Type the following text in the Description field: This feature contains the Tutorial application files.

4. Select the New_Feature feature to display its property grid.

5. Type the following text in the Description field: This feature contains the Tutorial help files

InstallShield 2020 User Guide ISP-2600-UG00 483

Chapter 3
Basic MSI Project Tutorial

As you enter the display names and descriptions, InstallShield creates a string entry—displayed as {ID_STRINGn}—to
represent each value.

At run time, if the end user chooses the Custom setup type, the installation displays a dialog that prompts the user to select
which features to install. This dialog displays features using the display name and description you specified here.

Continue

See Also
Features View

Creating Components and File Links

InstallShield 2020 » Basic MSI Tutorial

You can add links to additional files in the Files and Folders view. In this step, you will add a file to your Help_Files feature.
As you add files in the Files and Folders view, the IDE creates components for you according to Setup Best Practices rules.

Task To add Tutorial.html to a new component in the Help_Files feature:

1. Open the Files and Folders view.

2. In the Destination computer’s folders pane, right-click the Destination Computer icon and verify that Show
Components is selected.

3. Select Help_Files from the feature list at the top of the view.

4. Expand the tree in the Destination computer’s folders pane to see the [INSTALLDIR] folder.

5. Right-click the [INSTALLDIR] folder and select New Component. Name the component Help_Component.

6. In the Source computer’s folders pane, browse for the Tutorial files source folder containing TutorialHelp.html.

7. Drag the TutorialHelp.html icon from the Source computer’s files pane to the Help_Component component in the
Destination computer’s folders. InstallShield adds the file to Help_Component component in the Help_Files feature.

8. Click the Help_Component icon to display the component’s files in the Destination computer’s files pane.

9. Because each component should have a key file, right-click the TutorialHelp.html file and select Set Key File.

This type of file linking, where the list of files linked to a component does not change, is called static file linking. To link to a
directory (and possibly its subdirectories) whose contents might change between builds, see Dynamic File Linking.

The next step of the tutorial explains how to build a release image for your installation project.

See Also
Files and Folders View
Redistributables View
Static Scanning Wizard
Dynamic Scanning Wizard

484 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

Building a Release
InstallShield 2020 » Basic MSI Tutorial

Before testing an installation, it is necessary to build a release to update your project settings. A release contains all of the
files to be distributed to end users on a CD-ROM or from a network location.

The simplest way to build a release is to configure settings in the Release Wizard. The Release Wizard is where you specify
release properties, such as the type of media (CD-ROM, for example) to use and whether to compress files on the media.

Task To begin using the Release Wizard:

1. Click the Release Wizard button on the toolbar or choose Release Wizard from the Build menu.

2. In the Welcome panel, click Next to begin defining your release settings.

Continue

Naming the Product Configuration and Release

InstallShield 2020 » Basic MSI Tutorial

Product Configuration Panel

In the Product Configuration panel, you specify the name for the current product configuration. The product configuration
name is the name of a folder (inside your project folder) in which your built release will be placed.

Task For the tutorial:

1. Create a new product configuration called Tutorial.

2. Click Next to specify a release name.

Specify a Release Panel

In the Specify a Release panel, specify a release name. The release name is used as the name of a folder (inside the
product configuration folder) in which your built release will be placed.

Task For the tutorial:

1. Create a new product release called CDROM.

2. Click Next.

Continue

InstallShield 2020 User Guide ISP-2600-UG00 485

Chapter 3
Basic MSI Project Tutorial

Specifying Filtering Settings and Languages

InstallShield 2020 » Basic MSI Tutorial

Filtering Settings Panel

In the Filtering Settings panel, you can specify features or components to leave out of the current release.

Task For the tutorial:

Use the default settings (no filtering), and click Next to continue.

Setup Languages
In the Setup Languages panel, you specify which languages (from among the project languages) the user interface of your
installation should display, and whether to display a dialog from which the user can select the installation language.

Task For the tutorial:

Use the default settings (include English in the user interface), and click Next to continue.

Continue

Selecting the Media Type and Disk Spanning Options

InstallShield 2020 » Basic MSI Tutorial

Media Type Panel

In the Media Type panel, you specify the type of media for which you are building a release. The media type you specify
indicates the size of the disk image folders the Release Wizard creates. When you build a release for CD-ROM, the Release
Wizard divides your disk images into folders, each of which is smaller than 650 MB.

Task For the tutorial:

Select CD-ROM from the Media Type menu.

Disk Spanning Options Panel

The Disk Spanning Options panel lets you specify how your program files should be arranged, if multiple disk images are
required. The Custom spanning type lets you specify the disk image on which to place the files in particular features.

Task For the tutorial:

Select Automatic, which lets the Release Wizard determine the disk image on which to place each feature’s files.

486 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

For more information, see Spanning Installations over Multiple Disks or CDs.

Continue

Specifying Compression Settings and Setup Launcher Options

InstallShield 2020 » Basic MSI Tutorial

Release Configuration Panel

In the Release Configuration panel, you can specify whether to compress all, none, or some of the files in your installation
project.

Task For the tutorial:

Select Compress all files.

Setup Launcher Panel

The Setup Launcher panel lets you specify whether to create a Setup.exe setup launcher, and whether to include the
Windows Installer 3.1 engine with your installation. The Windows Installer engine installation is necessary for target
systems that have older versions of Windows Installer.

Task For the tutorial:

Leave the default settings selected.

For this step, leave all the defaults selected.

Continue

Adding Digital Signature and Password Protection

InstallShield 2020 » Basic MSI Tutorial

Digital Signature Panel

The Digital Signature panel allows you to digitally sign your application. Digitally signing your application helps to assure
your end users that the code within your application has not been modified or corrupted since publication.

Task For the tutorial:

Leave the default settings (no digital signature).

Password & Copyright Panel

The Password & Copyright panel allows you to activate password protection for your installation project and to indicate
specific information for your application’s copyright.

InstallShield 2020 User Guide ISP-2600-UG00 487

Chapter 3
Basic MSI Project Tutorial

Task For the tutorial:

Leave the default settings (no password protection or copyright information).

Continue

Including .NET Framework Support and Choosing Advanced Settings

InstallShield 2020 » Basic MSI Tutorial

.NET Framework Panel

In the .NET Framework panel, specify whether to include .NET Framework support in your release.

Task For the tutorial:

Leave the default settings (do not include .NET Framework).

Advanced Settings Panel

The Advanced Settings panel lets you specify additional settings related to the current release, such as the level of
compression to use and whether to create a PDF file for SMS distribution.

Task For the tutorial, select the following check boxes:

• Use long file names

• Optimize size

• Generate Autorun.inf—This generates a file that enables AutoPlay for your CD-ROM image.

For information about the other settings, click the Help button on the Advanced Settings panel.

Continue

Reviewing Your Settings

InstallShield 2020 » Basic MSI Tutorial

Summary
The Summary panel displays all of the Release Wizard settings for the current release.

Task If the settings are correct:

1. Select the Build the Release check box.

2. Click Finish to build your release.

488 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

Status messages for the build in progress are displayed in the output window. When the build is complete, the files to copy
onto the CD are placed in the directory:

<ProjectFolder>\Tutorial\cdrom\DiskImages\DISK1.

You can have InstallShield copy your built disk images to another directory using the Events tab in the Releases view.

Rebuilding Your Project

After making changes to your project in later steps of the tutorial, you can rebuild the latest release by clicking the Build
toolbar button , choosing Build from the Build menu, or pressing F7.

The next step of the tutorial explains how to create shortcuts and registry data for an installation.

See Also
Release Wizard
Building a Release from the Command Line

Troubleshooting Your Installation

InstallShield 2020 » Basic MSI Tutorial

After running your installation, if files are not installed, check the following parts of your project:

• Verify that INSTALLDIR is set to the proper value. This is set in the General Information view.

For this tutorial, the recommended value is [ProgramFilesFolder]TutorialCo\TutorialApp.

• Verify that your features have components and files associated with them.

• After making any changes to your installation, it is necessary to rebuild your project by clicking the Build button or
pressing F7.

See Also
Build Errors and Warnings
Setup.exe Return Values and Run-Time Errors (Basic MSI and InstallScript MSI Projects)
Validating Projects

Step 2: Shortcuts and Registry Data

InstallShield 2020 » Basic MSI Tutorial

This step explains how to use the IDE to:

• Create program shortcuts

• Create registry information

Continue

The processes for creating other types of system data are similar to the items described in this step. For more information,
view the topics listed below.

InstallShield 2020 User Guide ISP-2600-UG00 489

Chapter 3
Basic MSI Project Tutorial

See Also
ODBC Resources View
INI File Changes View
Environment Variables View
Registering a File Extension

Creating Shortcuts
InstallShield 2020 » Basic MSI Tutorial

You create and modify shortcuts in the Shortcuts view. The properties of a shortcut include its display name, its target
executable and arguments, and the icon it displays.

Creating the Shortcut

Task In this step you will create a shortcut to Tutorial App in the user’s Programs folder, under the Start menu.

1. Open the Shortcuts view. The Shortcuts view is located in the System Configuration section of the View List.

2. Right-click the Programs Menu folder icon, and select New Advertised Shortcut. The Browse for a Component
dialog appears.

3. In the dialog, select Tutorial_Files from the Feature drop-down menu and select Tutorial.exe from the files list and
click Open to close the dialog.

4. Rename the shortcut icon to an internal name such as Tutorial.

5. Set the following shortcut properties:

Table 3-2 • Shortcut Properties

Property Value Comment

Display Name Tutorial Application To accommodate target systems that do not support long file
names, the IDE will create an expression that includes a short
file name, as in “TUTORI~1|Tutorial App”. If you want, you can
modify the short file name part of the expression, as in
“TUTORIAL|Tutorial App”.

Description Launch the Tutorial Displayed as a tooltip.

application

Advertised Yes At run time, if the user advertises the product or the feature
containing the shortcut, the shortcut is created but the
component’s files are not installed until the user launches the
shortcut.

Target Advertised shortcut to Automatically set to the component’s key file for an advertised
[INSTALLDIR]Tutorial.ex shortcut.
e

490 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

Table 3-2 • Shortcut Properties (cont.)

Property Value Comment

Icon File <TutorialSource>\Tutori Browse for Tutorial.exe in the source location, and select its only
al.exe icon.

Icon Index 0 The icon index identifies a particular icon if there is more than
one icon resource in the executable file.

Working Directory [INSTALLDIR] The working directory should be set to the default directory for
your Save As and Open dialogs.

Tip • To create a shortcut to a file already located on the end user’s machine, set the Advertised property to No, and enter the
path to the file—using Windows Installer directory properties to represent the path to the file, when possible. For example, to
launch a copy of Windows Notepad located in the user’s Windows or WinNT folder, enter the shortcut target as
[WindowsFolder]Notepad.exe.

Continue

See Also
Shortcuts View

Creating Registry Data

InstallShield 2020 » Basic MSI Tutorial

Another common requirement for installations is to write information to the target system’s registry. To add registry data
to a component, you can use the Registry view.

Task To create a registry value called TutorialData under HKEY_LOCAL_MACHINE\SOFTWARE\Tutorial Co\Tutorial\1.00.0000:

1. Open the Registry view.

The Registry view is located in the System Configuration section of the View List.

2. Select Tutorial.exe from the View Filter at the top of the view.

3. In the Destination computer’s Registry view pane, right-click HKEY_LOCAL_MACHINE, select New, and point to Key.

4. Rename the key SOFTWARE.

5. Repeat the process for subkeys named Tutorial Co, Tutorial, and 1.00.0000.

6. In the Destination computer’s Registry data pane, right-click and select New String Value.

7. Rename the value TutorialData.

8. Double-click the TutorialData value and enter [INSTALLDIR] in the Value data field.

The Registry view should now appear as follows:

InstallShield 2020 User Guide ISP-2600-UG00 491

Chapter 3
Basic MSI Project Tutorial

Figure 3-3: Registry View

Tip • To write the value of a Windows Installer property to the registry, you can use the form [PropertyName]. In this example,
creating a registry value whose data is [INSTALLDIR] writes the value of INSTALLDIR to the registry.

At run time, if the end user selects a setup type or collection of features that includes the Tutorial.exe component, the
registry data is created on the target system.

Verifying that the Shortcut Was Created

Task To verify that your installation created the shortcut:

1. Rebuild your project by clicking the Build toolbar button or pressing F7.

2. Run the project by clicking the Run button or pressing CTRL+F5 (first removing any existing version of the program
from your system). A shortcut to the Tutorial application should be present in the Programs folder of your Start
menu.

Verifying that the Registry Data Was Created

Task To verify that the installation created the registry data:

1. Launch Tutorial App from its shortcut.

2. From the Tutorial menu, choose Verify Registry Data. If the registry data was created, a message box displaying the
value of INSTALLDIR is displayed.

The next step of the tutorial explains how to register a COM server (self-registering file).

Step 3: Registering COM Servers

InstallShield 2020 » Basic MSI Tutorial

For many files, the installation’s only requirement is to copy the files from the source media to the target system. For
others, the installer also needs to register the files with the target system. One category of file that needs extra handling is a
COM server, commonly known as a self-registering file or ActiveX control. A COM server is usually a DLL or OCX that requires
extra information to be written to the target system’s registry before applications and Web pages that use the self-
registering file can find it.

492 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

Creating a COM Server Component

To install and register these and other types of files, you can use the Component Wizard. The Component Wizard creates
components that copy the files, and perform any additional registration steps. In this step you will create a component that
installs and registers Tutorial.ocx and an HTML file that uses it.

Task To create a COM server component:

1. Open the Files and Folders view. The Files and Folders view is located in the Application Data section of the View
List.

2. At the top of the Files and Folders view, in the View Filter list, select the Tutorial_Files feature.

3. In the Destination computer’s folders pane, right-click the [INSTALLDIR] folder and select Launch Component
Wizard.

4. In the Welcome panel of the Component Wizard, select the Let me select a type and define the component myself
option and click Next.

5. In the Component Type panel, select the COM Server icon, type Tutorial.ocx in the Component Name field, and click
Next.

6. In the COM Server—Destination panel, verify that the destination is set to [INSTALLDIR].

7. In the COM Server File panel, click the browse button next to the COM Server File field and browse for Tutorial.ocx in
your tutorial files source directory. Click Next.

8. After the Component Wizard has extracted the COM information, review the COM information and click Finish to
create the component.

The next step is adding the HTML file to the component you just created.

Task To add the HTML file to the component:

1. In the Destination computer’s folders pane of the Files and Folders view, select the new Tutorial.ocx component.

2. Drag the file TutorialCtrl.html from the Source computer’s files pane to the Destination computer’s files pane.

3. Verify that Tutorial.ocx is marked as the key file of its component.

Note • See Registering COM Servers for other options for registering self-registering files, including extracting COM
information each time that you rebuild the release—for COM servers with interfaces that change between builds—or calling
the file’s self-registration functions.

InstallShield 2020 User Guide ISP-2600-UG00 493

Chapter 3
Basic MSI Project Tutorial

Verifying that the COM Server Was Registered

Task After rebuilding your release (by pressing F7) and running the installation (by pressing CTRL+F5), you can verify that the
COM server was registered properly:

1. Launch Tutorial App using its shortcut in the Programs menu, or by double-clicking its icon.

2. Choose COM Server Test from the Tutorial menu.

3. If the COM server was registered correctly, the HTML page displays a “success” message.

The Component Wizard can also create components that install and configure fonts and Windows NT services.

The next step of the tutorial demonstrates how to install files conditionally.

See Also
Component Wizard

Step 4: Conditions and Properties

InstallShield 2020 » Basic MSI Tutorial

In this step, you will learn how to conditionally install data on a target system.

Operating System Conditions

A common requirement for installations is to install certain files on a system only if particular conditions are met. For
example, files may be specific to an operating system or language, or should be installed only if the user has appropriate
privileges.

To install a component (and its files and other data) only on particular operating systems, you can use the component’s
Operating Systems property. You can modify a component’s properties by opening the Setup Design view, expanding the
feature icon that contains the feature, and selecting the desired component.

Task To create a component that will be installed only on systems running Windows 7 or later:

1. Open the Setup Design view. The Setup Design view is located in the Organization section of the View List.

2. Right-click the Help_Files feature and select New Component.

3. Rename the component Windows_7_Files.

4. Expand the Windows_7_Files component, click the Files icon for the component, and add the file ReadmeNT.txt from
your tutorial files source folder by right-clicking in the Files pane and browsing to the file.

5. Right-click the .txt file and select Set Key File.

6. Click the Windows_7_Files component to display the component’s property grid.

7. Select the component’s Condition property and click the browse button to launch the Condition Builder dialog.

8. Create the following condition: VersionNT>=601. For information on creating conditions, see Building Conditional
Statements.

494 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

9. Click OK to close the Condition Builder dialog and add the condition.

After you rebuild (by pressing F7) and run the installation (by pressing CTRL+F5), and any files or other data contained in
the component will be installed only if the target system is running Windows 7 or later.

Windows Installer Conditions

The Windows Installer service stores some global information about your installation and about the user’s operating
system in properties. Some properties are built into the Property table of your MSI database, and some are created and set
by the Windows Installer engine when the user launches an installation.

Properties commonly used in conditions include:

• AdminUser, which is set if the user running your installation has administrative privileges.

• VersionNT, numeric values describing the operating system version the user is running.

• PhysicalMemory, which contains the amount of RAM—in megabytes—on the user’s system.

A Windows Installer condition is a statement of logic that compares a property value against a constant value, or tests if a
property exists. For example, Windows Installer defines properties called ScreenX and ScreenY, which contain the user’s
monitor resolution in pixels. A Windows Installer condition that checks that the user has at least 800 by 600 resolution
would read “(ScreenX>=800) And (ScreenY>=600)”.

Conditions can also test if a property is defined. For example, the AdminUser property is set only if the user has
administrative privileges, and a condition that tests if a user has administrative privileges is simply “AdminUser”.

Task To create a component that will be installed only if the user has administrative privileges:

1. Right-click the Help_Files feature and select New Component.

2. Rename the component Admin_Component.

3. Expand the Admin_Component component and click the Files icon.

4. Add the file AdminOnly.txt from your tutorial files source folder, and set it as the key file of the component.

5. Click the browse button in the component’s Condition property to display the Condition Builder dialog.

6. In the Condition Builder dialog, type AdminUser in the Condition(s) field.

7. Click OK.

At run time, the component’s data are installed only if the user has administrative privileges.

The next step of the tutorial describes how to modify your installation’s user interface.

See Also
Building Conditional Statements
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties

Step 5: Changing the End-User Interface

InstallShield 2020 » Basic MSI Tutorial

This step describes three ways you can modify the end-user interface of your installation:

InstallShield 2020 User Guide ISP-2600-UG00 495

Chapter 3
Basic MSI Project Tutorial

• Specifying the dialogs to be displayed during the installation.

• Modifying the layout and properties of a dialog using the Dialog Editor.

Continue

Adding a New Dialog

InstallShield 2020 » Basic MSI Tutorial

The Basic MSI project includes many dialogs that you can display in your installation’s user interface. The topic, Running
Your Installation, in this tutorial, showed the dialogs your installation displays based on your selections in the Project
Assistant’s Installation Architecture page.

Task To create a new dialog:

1. Open the Dialogs view. The Dialogs view is located in the User Interface section of the View List.

2. Right-click the All Dialogs explorer and then click New Dialog. The Dialog Wizard opens. Click Next to dismiss the
Welcome panel.

3. In the Dialog Template panel, click Interior Wizard Panel, and select the Let me insert this dialog in a User
Interface sequence check box.

4. In the User Interface panel, select Installation in the User Interface Sequence list. In the list of dialogs, select
InstallWelcome. Based on these selections, InstallShield will insert your new dialog in sequence immediately
following the InstallWelcome dialog.

5. In the Dialog Position and Condition panel, leave the default settings, and click Finish. Your new dialog appears in
the Dialogs list.

6. Right-click the dialog and select Rename. Rename the dialog WelcomeBitmap.

Using the same technique, you can insert additional dialogs in your installation’s user interface.

Continue

See Also
Creating New Dialogs in Basic MSI Projects

Modifying Dialog Layout in the Dialog Editor

InstallShield 2020 » Basic MSI Tutorial

The Dialog Editor allows you to modify the appearance of dialogs displayed by your installation.

Task In this step, you will modify the WelcomeBitmap dialog that you just created:

1. First, create a bitmap (using a program like Microsoft Paint) that measures 300 by 150.

2. Open the Dialogs view.

3. Expand the WelcomeBitmap dialog’s node. Click English (United States) to open the Dialog Editor.

496 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Basic MSI Project Tutorial

4. Click the Dialog Bold Title text box at the top of the dialog. In the Text field, type Welcome Bitmap. This changes the
dialog’s main title.

5. Click the Dialog Normal Description text box at the top of the dialog. In the Text field, type Displays my welcome
bitmap. This changes the dialog’s description.

6. Click the Bitmap button on the Dialog Control toolbar and use the cursor to drag a box on the dialog. Set the Height
to 150 and the Width to 300.

7. In the File field browse to the bitmap file that you created in step 1.

After rebuilding the project (by pressing F7) and running it (by pressing CTRL+F5), the Welcome Bitmap dialog will appear
after the Install Welcome dialog.

Tip • To maximize the Dialog Editor view, press CTRL+M.

End of Tutorial

See Also
Editing Dialog Layout in Basic MSI Projects

InstallShield 2020 User Guide ISP-2600-UG00 497

Chapter 3
Basic MSI Project Tutorial

498 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Globalization Tutorial

Globalization Tutorial
InstallShield 2020

The Globalization tutorial introduces you to the tools and options that InstallShield provides for creating a global
installation package. A global installation is one that has the potential to run in many different languages. Depending on
how you choose to build your installation, you can either include all the languages in one package and let the end user
select the language, or you can build individual installation packages for each language that you target. This tutorial walks
you through the process of creating an all-encompassing installation.

Edition • The Premier edition of InstallShield must be installed on your development system in order to successfully complete
this tutorial.

If you have not already done so, you may want to run through the Basic MSI tutorial to familiarize yourself with how to
create an installation package. When finished with the Basic MSI Tutorial, you will have a Basic MSI installation project that
is ideal for adding additional languages. The complete project file for the Basic MSI tutorial was installed with this product
in one of the Samples subfolders within the InstallShield Program Files folder. The default location is:

C:\Program Files\InstallShield\2020\Samples\WindowsInstaller\Tutorial Project\Tutorial

Project • Almost all of the information in the tutorial also applies to InstallScript installation projects. Differences are
explicitly noted in the tutorial text.

Begin the tutorial

Opening the Project File

InstallShield 2020 » Globalization Tutorial » Step 1

This tutorial uses Othello.ism, which is a sample project file that is installed with InstallShield.

Task To begin the tutorial:

Open Othello.ism, which is located in one of the Samples subfolders within the InstallShield Program Files folder. The
default location is:

C:\Program Files\InstallShield\2020\Samples\WindowsInstaller\Basic Installation Project

Project • Othello.ism is a Basic MSI installation project. Almost all of the information in this tutorial also applies to
InstallScript installation projects; differences are explicitly noted in the tutorial text.

Continue

InstallShield 2020 User Guide ISP-2600-UG00 499

Chapter 3
Globalization Tutorial

Selecting the Target Languages

InstallShield 2020 » Globalization Tutorial » Step 2

The first step in creating a global installation is to select the languages that you want to target. For this tutorial, you will
add two languages to your installation project: German and Polish.

Task To add languages to your project:

1. In the View List under Installation Information, click General Information.

2. In the Setup Languages setting, click the ellipsis button (...). The Setup Languages dialog box opens.

3. Select the English (United States), German, and Polish check boxes.

InstallShield adds string entries for English, German, and Polish to your project. Each string entry consists of a language-
independent identifier and a corresponding language-specific value. The string entries include the built-in user-interface
string resources that are already translated. To view all of the string entries, you can use the String Editor view. (In the View
List under User Interface, click String Editor.)

Every time that you add a new string entry to your default language, a parallel entry is made to the string entries for all of
the other languages that are in your project.

Continue

Editing Language-Specific String Entries

InstallShield 2020 » Globalization Tutorial » Step 3

The next step is to edit string entries in your installation project. You will edit string entries for three different settings: The
feature’s display name, the shortcut’s display name, and the shortcut’s description. (The shortcut’s description will be
created as part of the next step in this tutorial.)

Feature Display Name

Task To provide a display name for a feature:

1. In the View List under Organization, click Setup Design.

2. In the Setup Design explorer, click ProgramFiles.

3. In the Display Name setting in the right pane, enter Program Files if it is not already there.

If you click anywhere else within the Setup Design view, you will see that the text that you entered has been preceded by a
string identifier, which is enclosed within curly brackets ({}). You can view all of your project’s string entries by clicking the
ellipsis button (...) that is displayed when you click the Display Name setting.

500 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Globalization Tutorial

Shortcut Display Name

Task To add a display name for the shortcut:

1. In the Setup Design explorer, expand the ProgramFiles feature, and then expand the Program_Executables
component.

The component Program_Executables contains a shortcut to the file Othello.exe.

2. Click the Shortcuts icon under the Program_Executables component.

3. In the Shortcuts explorer, click the Othello shortcut. InstallShield displays the shortcut’s settings in the right pane.

Currently, the Display Name setting is set to Othello. The value is preceded by a string identifier, which is enclosed
within curly brackets ({}).

4. To change the display name, enter the new name in the Display Name setting.

Continue

Creating String Entries

InstallShield 2020 » Globalization Tutorial » Step 4

Because many of your text strings might be used in multiple places in your project, it is inefficient to store each instance of
these strings in the project. Instead, you can create the string once, and use it anywhere a string is needed. To help
streamline the process of localizing a project, all of the text strings that may be displayed at run time during the installation
process are available in one consolidated view: the String Editor view. You can use this view to create new string entries.

For the shortcut’s Description setting, you are going to enter your new string entry through the String Editor view. Then,
you will associate that string with the shortcut’s description.

Task To create a new string entry and use it for the shortcut’s Description setting:

1. In the View List under User Interface, click String Editor.

2. Do one of the following:

• Click the New button.

• Press the INSERT key.

The String Entry dialog box opens.

3. In the String Identifier box, enter the following:

MYSTRING

4. In the Value box, enter the following text:

This is the description of the Othello shortcut.

5. In the Comments box, you can optionally specify an internal note about the string entry. The comments are not
displayed at run time.

6. Click OK. InstallShield adds new rows in the String Editor view, one for each language (English, German, and Polish).

InstallShield 2020 User Guide ISP-2600-UG00 501

Chapter 3
Globalization Tutorial

7. In the View List under System Configuration, click Shortcuts.

8. In the Shortcuts explorer, click the Othello shortcut. InstallShield displays the shortcut’s settings in the right pane.

9. In the Description setting, click the ellipsis setting (...). The Select String dialog box opens.

10. Select the MYSTRING row, and then click OK.

Your new string is now entered as the value for the Description setting.

Continue

Including Language-Specific Files and Components

InstallShield 2020 » Globalization Tutorial » Step 5

The next step in creating a global installation involves including language-specific files and components within your
installation project. For example, although many of your program files may be language-independent, your help files and
run-time strings are both language-specific. For the purpose of this exercise, you will add three new components to your
project. Each component contains a Readme file that is localized in all of your supported languages.

Task To add a component to your project:

1. In the View List under Organization, click Setup Design.

2. In the Setup Design explorer, right-click the feature called ProgramFiles, and then click New Component.

3. Type English_Readme for the component’s name.

4. Repeat this process two more times. Name these components Polish_Readme and German_Readme.

Translated versions of a simple Readme file are included with InstallShield. These files are located in one of the Samples
subfolders within the InstallShield Program Files folder:

InstallShield Program Files Folder\Samples\WindowsInstaller\Basic Installation Project\Data Files\Readme

Task To add a file to the English_Readme component:

1. Expand the new English_Readme component, and then click the Files icon under the English_Readme component.

2. Right-click in the Files list and click Add.

3. Browse to the English.txt file, and then click Open.

Repeat these steps for the German and Polish components, adding Deutsch.txt to and Polski.txt, respectively.

Continue

502 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Globalization Tutorial

Specifying Component Installation Conditions

InstallShield 2020 » Globalization Tutorial » Step 6

Now that you have created your language-specific components, you need to include logic that will let the installer know
which of these components should be installed. By specifying a component condition, you can determine the default
language of the target system and then install the appropriate file. Each of the three language-specific components that
you created will need a condition. If that condition evaluates to True, the component is installed.

Task To create the component condition:

1. Click the German_Readme component.

2. In the right pane, click the Condition setting, and then click the ellipsis button (...) for this setting. The Condition
Builder dialog box opens.

3. In the Properties list, select SystemLanguageID, and then click the Add button.

4. In the Operators list, select the equals sign (=), and then click the Add button.

The Condition(s) box contains SystemLanguageID =, which reflects the selections you previously made.

5. Next you need to provide a value that will be checked when the installation is run. Because you are currently editing
the German component, enter 1031 after the equal sign. 1031 is the language ID for German. Since the component is
installed only if this equation evaluates to true (that is, the target system’s language is German), this component is not
installed on any machine that is not running in German.

Follow the same steps from above to add a condition to the Polish_Readme component. Instead of using 1031 as the
language value, use 1045, which is the language ID for Polish.

You need to choose one language as your default language. For this example, English is the default. Therefore, the
condition that you use for the English_Readme component differs from the other two. The condition for the
English_Readme component should appear as follows:

SystemLanguageID<>1045 AND SystemLanguageID<>1031

With this logic, if the language of the target machine is not German or Polish, the English_Readme component is installed.

Project • To learn how to specify which language-dependent components are installed at run time for InstallScript and
InstallScript object projects, see Installing Components Based on Language.

Continue

Translating the Strings

InstallShield 2020 » Globalization Tutorial » Step 7

Before you can build your installation project, you need to translate the English strings that you entered for the feature’s
display name, the shortcut’s display name, and the shortcut’s description. For this tutorial, they have been translated for
you. All you have to do is enter the correct text for the German and Polish string entries. You can use the String Editor view
to do this.

InstallShield 2020 User Guide ISP-2600-UG00 503

Chapter 3
Globalization Tutorial

German String Values

Open the String Editor view. Find each of the following string identifiers for the German language. You can enter the string
identifier in the Search Grid box to easily find each string. As an alternative, you can click the Identifier column heading to
sort all of the string entries by identifier. Update the German values for the three string entries as follows:

Table 3-1 • German String Entries

Identifier Value

FEAT_DISPLAYNAME Programmdateien

SHORTCUT_DISPLAYNAME Othello-Verknuepfung

MYSTRING Dies ist die Beschreibung der Verknuepfung fuer Othello.

Polish String Values

Update the Polish values for the three string entries:

Table 3-2 • Polish String Entries

Identifier Value

FEAT_DISPLAYNAME Pliki Programu

SHORTCUT_DISPLAYNAME Skrt do Othello

MYSTRING Opis skrtu Othello.

In most translation situations, you export your string entries for translation. To learn more, see Translating String Entries.
However, for the purposes of this tutorial, it is easier to edit the string entries within the String Editor view.

Continue

Building the Installation

InstallShield 2020 » Globalization Tutorial » Step 8

Your installation project has been fully globalized and is ready to test. Before you can test the installation, however, you
need to build it.

Task To build your installation:

1. Click the Release Wizard button on the toolbar.

2. In the first two panels, specify a product configuration and release name.

3. Accept the default settings for every other panel in the wizard except the Setup Languages panel.

504 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 3
Globalization Tutorial

4. The Setup Languages panel enables you to choose which languages to include in your installation. Only the
languages that you specified in the General Information view appear in the list of available languages—English, Polish,
and German. Select the check box next to each language.

5. Also, ensure that you select the Display the Setup Languages Dialog check box. This dialog allows end users to select
the language in which they want the installation to run.

6. Accept the default settings provided in the remaining wizard panels.

7. When you reach the Summary panel, ensure that the Build the Release check box is selected, and then click the
Finish button.

8. InstallShield builds the release.

Continue

Running the Installation

InstallShield 2020 » Globalization Tutorial » Step 9

Task To run your installation:

1. Click the Run Setup button on the toolbar. The Choose Setup Language dialog appears.

2. To run your installation, select German (Standard) and click OK. From this point forward, every dialog is displayed in
German.

Note • After an installation is run in a particular language, Windows Installer caches this information and always runs the
installation in that language.

As the installation wizard progresses, you may notice that some buttons are not properly sized. You can easily fix this
problem by opening the Dialog Editor and resizing the controls so the text fits in the control.

In the Custom Setup panel (in German it is called Angepasstes Setup), the feature name is now Programmdateien. Your
localized string entries are a part of the installation.

Continue

Testing the Installation

InstallShield 2020 » Globalization Tutorial » Step 10

The last step is testing the globalized installation that you created.

InstallShield 2020 User Guide ISP-2600-UG00 505

Chapter 3
Globalization Tutorial

Task To test the installation:

1. Open the Start menu and select Programs. The Othello shortcut is displayed as Othello Verknpfung. You can see the
shortcut’s description, which also appears in German.

2. Navigate to the installation directory for Othello. It should be in <Program Files Folder>\Shakespeare Inc\Othello. The
readme file that you installed is called Deutsch.txt.

End of tutorial

506 ISP-2600-UG00 InstallShield 2020 User Guide

 4
Creating Installations

InstallShield 2020

If you have ever installed an application onto your computer, you have seen an installation in action—from the end user’s
perspective. An installation’s primary task is to transfer files from the source medium to the local drive. An installation
often also displays a user interface to obtain end user selections, configures the target system (for example, makes any
required registry entries and creates shortcuts), and enables modification or uninstallation of the installed application.
Creating an installation involves performing some or all of the following tasks.

Specify Installation Information

Basic information that you enter in the General Information view is used in various parts of the installation; for example,
the product name is used to create the application information registry key.

Organize and Transfer Files

File transfer involves copying files from the source medium, such as a CD or DVD, to a local drive on the end user’s machine.
Depending on the configuration the end user chooses—by selecting a setup type (in an InstallScript or InstallScript MSI
installation) or features—all or only some of the files may be transferred to the local disk.

Organize the files to be installed into setup types and features to help your end users select the most appropriate files.
Within each feature, organize the files into components according to their type and purpose, for example, files that are
installed to the same target folder.

Configure the Target System

In addition to installing files, many installations need to configure the target system by creating shortcuts and program
folders, modifying the registry, modifying initialization file (.ini file) data, configuring Open Database Connectivity (ODBC)
resources, modifying environment variables, modifying XML files, modifying text files, schedule tasks, and install and
control Windows services.

Customize Installation Behavior

InstallShield offers wide-ranging customization options. InstallScript installations are driven by InstallShield’s simple but
powerful InstallScript programming language, which—in addition to its built-in functions—enables you to call DLL and
Windows API functions and launch child installations and other applications from your installation. Windows Installer-

InstallShield 2020 User Guide ISP-2600-UG00 507

Chapter 4 Creating Installations
Before You Begin

based installations can use custom actions to run InstallScript, VBScript, or JavaScript code; call DLL functions; run
executable files; call a managed method in a managed assembly; set a property or a directory; trigger an error and end the
installation; run PowerShell scripts; terminate a process; or run other installation packages.

Define the End-User Interface

An installation’s end-user interface provides information and installation configuration options to the end user. Through
the user interface, an end user can choose to install only part of a product, choose to leave some files on the source
medium, view a license agreement, or provide the installer information that may be necessary to properly configure the
installation.

The user interface can be customized to meet the needs of your installation. For example, you can prompt a user for a serial
number before starting the installation to protect your software against illegal use. During file transfer, an installation can
display billboards that provide product information such as new features or usability tips. A status bar may also be
displayed to show the progress of the file transfer process.

Configure Servers
A server-side installation may need to create and manage new Internet Information Services (IIS) Web sites, manage COM+
applications and components, or manage and organize SQL scripts by server connections and settings.

Prepare the Installation for Maintenance and Uninstallation

To uninstall, modify, or repair an application, the operating system must have some indication that the application is
present. To accommodate this, an installation registers an application with the operating system so that it can be easily
maintained or uninstalled.

Much of the information registered in this process is available to the end user through Add or Remove Programs in the
Control Panel. For example, technical support contact information, product update information, product version, and
product publisher information are registered in this process.

Build, Test, and Deploy the Installation

Once you have created your installation project, you will want to build, test, and deploy the installation: create the files
that you will release to your users, test the installation for errors, and optionally copy the files to a local or network location
or an FTP site.

See Also
Before You Begin

Before You Begin

InstallShield 2020

The “Before You Begin” section of the InstallShield Help Library contains information that is helpful to installation authors
as they create new installation projects with InstallShield. The topics provide background information on Windows
Installer, the Windows logo program, INSTALLDIR, TARGETDIR, and other areas of installation development.

See Also
Getting Started

508 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4 Creating Installations
Before You Begin

Requirements for the Windows Logo Program

InstallShield 2020

Microsoft established a list of requirements that a product and its installation must fulfill in order to participate in the
Windows 8 Desktop App Certification Program. The requirements outline criteria that help make a product more
compatible, reliable, and secure when running on Windows systems. Products that meet the Windows 8 Desktop App
Certification Program requirements can carry the Compatible with Windows 8 logo.

Qualifying for the Windows Logo Program

To learn how to qualify for the Windows logo program, visit MSDN. This Web site has information about the Windows logo
program.

Certified for Windows Validation Suites in InstallShield

Validating your installation package or merge module may help you identify whether your product meets installation
requirements for Windows logo program. If a package or merge module fails one or more validation rules, InstallShield
reports the specific rules that were violated and offers additional information to help you troubleshoot the problem.

Therefore, if you are interested in being able to use the Windows logo, consider using both of the following suites to
validate your installation package:

• InstallShield Validation Suite for Windows 8—This suite consists of a number of InstallShield internal consistency
evaluators (ISICEs) that help you identify issues that may make your installation behave unexpectedly on Windows
systems. This suite checks for issues that may not be revealed in the Full MSI Validation Suite.

• Full MSI Validation Suite—This suite consists of ICEs that Microsoft created.

If you create a merge module in InstallShield, use the following suites to validate your merge module:

• InstallShield Merge Module Validation Suite for Windows 8—This suite consists of a number of InstallShield ISICEs
that help you identify issues that may make your merge module behave unexpectedly on Windows systems. This suite
checks for issues that may not be revealed in the Merge Module Validation Suite.

• Merge Module Validation Suite—This suite consists of ICEs that Microsoft created.

Additional validation suites are also available.

To learn more, see Validating Projects.

Windows Logo • The Windows Logo Guideline alert appears throughout the InstallShield Help Library whenever the
information relates to complying with the Windows logo program guidelines.

See Also
Guidelines for Creating Custom Actions that Meet Requirements of the Windows Logo Program
Digital Signing and Security
Windows Installer and Logo Requirements (Windows Installer Help Library)
Windows Installer and Logo Requirements (Windows Installer Help Library)

InstallShield 2020 User Guide ISP-2600-UG00 509

Chapter 4 Creating Installations
Before You Begin

Introduction to Windows Installer

InstallShield 2020

A Windows Installer–based installation is distributed as an .msi package, which consists of a Windows Installer database
(.msi database) and related data files (.cab files, uncompressed data files, etc.). The .msi databases, implemented as COM
structured storage, contain dozens of tables that describe the changes that are to be performed on the target system. For
example, some of the .msi tables are:

• File, which describes the files to be installed

• Registry, which describes the registry data to be written

• Shortcut, which describes shortcut settings

Other .msi database tables describe the appearance and behavior of the installation’s user interface, install and configure
Windows services and ODBC information, determine characteristics of the target system, and store icons and other binary
data for use during installation.

From a developer’s perspective, perhaps the greatest change in Windows Installer installation programs is that there is no
explicit script to write. Instead, Windows Installer–based installations perform standard and custom actions, where an
action displays a dialog, queries the target system, or makes changes to the target system. These actions are arranged into
sequences, which are ordered collections of actions.

Windows Installer includes a collection of application program interface functions, or APIs, dedicated to managing product
installations. Applications must call the Windows Installer APIs in order to take advantage of features available with
Windows Installer.

An integral part of Windows operating systems, Windows Installer provides a standard format for component management
as well as an interface for managing applications and system tools. Various versions of Windows Installer are available as
redistributables for Windows operating systems.

Although it is possible to create a Windows Installer package by editing .msi database tables directly, the large number of
tables and relationships among them makes doing so a formidable task. InstallShield organizes the process of developing
an installation for Windows Installer into various views, providing graphical editors and wizards that shield the developer
from much of the implementation detail that is associated with .msi databases.

For more information on Windows Installer technology, see the Windows Installer Help Library.

See Also
Adding Windows Installer Redistributables to Projects

Minimizing the Number of User Account Control Prompts

During Installation
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

510 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4 Creating Installations
Before You Begin

Some of the specific details apply to only some of these project types. These differences are noted where appropriate.

One of the goals of Windows Vista and later, as well as User Account Control (UAC), is to allow users to run as standard users
all of the time. Elevation should rarely be required; if it does occur, it should occur for as short of a duration as possible.

Several different areas of InstallShield affect whether an installation triggers UAC consent or credential prompts for
elevated privileges. Understanding these different settings will help you create the appropriate UAC experience for your
installation when end users run it on Windows Vista and later systems. It will also offer guidance if you are trying to
minimize the number of UAC prompts that are displayed during your installation.

Depending on how it is configured, an installation that includes InstallShield prerequisites may prompt for elevated
privileges on Windows Vista and later systems at several different points during the installation:

1. When the end user launches the Setup.exe file

2. When the Setup.exe file launches a setup prerequisite that requires elevated privileges

3. When the ISInstallPrerequisites custom action relaunches the Setup.exe file in feature prerequisite installation mode
because one or more of the features being installed has an associated feature prerequisite

Note that the ISInstallPrerequisites custom action does not verify whether any feature prerequisites require elevated
privileges before the prompt for elevated privileges is displayed. In addition, the ISInstallPrerequisites custom action
does not check the conditions on any of the feature prerequisites to determine whether the feature prerequisites need
to be installed. The prompt for elevated privileges is always displayed.

Project • Basic MSI projects include support for feature prerequisites.

4. When the Windows Installer begins the Execute sequence of the .msi package

Project • This last installation point applies to Basic MSI and InstallScript MSI projects, but not InstallScript projects.

UAC-Related Settings in InstallShield

Following is a list of the InstallShield settings that help determine whether UAC prompts are displayed during an
installation on Windows Vista and later systems:

• Required Execution Level—Use this setting in the Releases view to specify the minimum execution level required by
your installation’s Setup.exe file. InstallShield uses the value that you select (Administrator, Highest available, or
Invoker) in the application manifest that it embeds in the Setup.exe launcher. For more information, see Specifying
the Required Execution Level for Your Setup Launcher on Windows Vista and Later Platforms.

• The prerequisite requires administrative privileges—If you are creating or modifying an InstallShield prerequisite
for your installation, use this check box to indicate whether administrative privileges are required in order to install
this prerequisite. This check box is on the Behavior tab in the InstallShield Prerequisite Editor. For more information,
see Specifying that an InstallShield Prerequisite Requires Administrative Privileges.

• Require Administrative Privileges—Use this setting in the General Information view to specify whether the Execute
sequence of your installation’s .msi package requires administrative privileges. If you set this to No, InstallShield sets
bit 3 in the Word Count Summary property to indicate that elevated privileges are not required to install your product.
For more information, see Entering Summary Information Stream Data.

InstallShield 2020 User Guide ISP-2600-UG00 511

Chapter 4 Creating Installations
Before You Begin

Project • The Require Administrative Privileges setting does not apply to InstallScript projects.

• Advertise If Prerequisites Are Elevated—Use this setting in the Releases view to specify whether the .msi package
should be advertised—and if so, whether it should be run silently or with the full user interface (UI)—after the
InstallShield prerequisites in the installation have been successfully installed with elevated privileges on Windows
Vista and later machines. The advertisement may allow end users to avoid the UAC prompt that would otherwise be
displayed for an .msi package that requires elevated privileges. For more information, see Specifying Whether a
Product Should Be Advertised If Its InstallShield Prerequisites Are Run with Elevated Privileges.

Project • The Advertise If Prerequisites Are Elevated setting does not apply to InstallScript projects.

In addition, the type of InstallShield prerequisite—either setup prerequisite or feature prerequisite—may affect whether
UAC prompts are displayed during an installation on Windows Vista and later systems. To learn more about these two
types of InstallShield prerequisites, see Setup Prerequisites vs. Feature Prerequisites.

Note the following UAC-related behavior on Windows Vista and later:

• If Required Execution Level is set to Invoker, any InstallShield prerequisites in your installation do not require
administrative privileges, and Require Administrative Privileges is set to No, end users should see no UAC prompts
during installation.

• If Required Execution Level is set to Invoker, your installation includes setup prerequisites that require administrative
privileges, and Require Administrative Privileges is set to No, end users should see one UAC prompt—plus up to one
additional UAC prompt for each reboot—during installation.

• If the full user interface of the setup launcher is displayed and the installation includes setup prerequisites that need
to be installed, the setup launcher typically displays the setup prerequisite dialog before the main installation starts. If
one or more of the setup prerequisites that need to be installed require administrative privileges, the Install button on
the message box has the shield icon to alert the end user that elevated privileges are required.

• If the installation is continuing after a reboot and privileges must be elevated, the OK button of the continuation
message box has the shield icon. If privileges do not need to be elevated, the shield button is not displayed.

• If your installation includes more than one setup prerequisite that must be installed on a target machine and one or
more of those setup prerequisites requires administrative privileges, the UAC prompt is displayed before the first
setup prerequisite is installed. This may allow elevated privileges to be used for all prerequisites without requiring
separate UAC prompts for each prerequisite installation. Note, however, that if a setup prerequisite installation
causes a reboot, administrative privileges are lost, and a UAC prompt may be displayed if any of the remaining
prerequisites require administrative privileges.

A slightly different behavior applies to feature prerequisites. If your installation is going to install any features that are
associated with prerequisites, the UAC prompt is displayed when the ISInstallPrerequisites custom action relaunches
Setup.exe in feature prerequisite installation mode. This occurs regardless of whether any of the feature prerequisites
require elevated privileges. It also occurs before any of the feature prerequisites’ conditions are evaluated to
determine whether the feature prerequisites need to be installed. Note that if a feature prerequisite installation
causes a reboot, administrative privileges are lost. After the reboot, the ReadyToInstall dialog is displayed again, and
the end user needs to click the Install button to proceed with the rest of the installation. In this case, the UAC prompt
is displayed again when the ISInstallPrerequisites custom action relaunches Setup.exe in feature prerequisite
installation mode.

512 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4 Creating Installations
Before You Begin

• Note that if Require Administrative Privileges is set to No but your .msi package tries to perform a task for which it
does not have adequate privileges, Windows Installer may display a run-time error.

• If privileges are elevated at the end of an installation and the SetupCompleteSuccess dialog launches the product,
elevated privileges are carried over to your product. In most cases, running an application with elevated privileges is
discouraged.

Sample Scenarios
The following sections contain examples that illustrate different combinations of values for the aforementioned settings in
InstallShield. The diagrams show when Windows Vista and later request elevated privileges for standard users or
administrative users who have limited privileges. The examples are based on the default UAC settings on Windows Vista
and later systems.

Example 1: UAC Prompt Is Displayed for a Prerequisite that Requires Administrative Privileges; .msi File
Is Advertised
The example 1 diagram shows an installation that requires elevation for a setup prerequisite, a feature prerequisite, and
for the Execute sequence of the .msi package. Windows Vista and later display one UAC prompt for the setup prerequisite,
and another one for the feature prerequisite.

If the feature prerequisite was not included or if it was a setup prerequisite instead of a feature prerequisite, the second
UAC prompt (which is labeled as UAC prompt #2 in the diagram) would not be displayed. In these cases, UAC prompt #2
would not be needed because the .msi package is successfully advertised after the setup prerequisite is installed with
elevated privileges.

InstallShield 2020 User Guide ISP-2600-UG00 513

Chapter 4 Creating Installations
Before You Begin

Figure 4-1: Example 1—Diagram of an Installation that Has Invoker as the Required Execution Level and that Advertises
the .msi Package

Example 2: UAC Prompt Is Displayed for Setup.exe and After a Reboot for a Prerequisite that Requires
Administrative Privileges
The example 2 diagram shows an installation that requires elevation for Setup.exe, two setup prerequisites, a feature
prerequisite, and the Execute sequence of the .msi package. Because the Setup.exe file has a manifest that specifies
Administrator as the required execution level, elevated privileges are used for each part of the installation. The second UAC
prompt is displayed because elevated privileges are lost during a reboot.

514 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4 Creating Installations
Before You Begin

Figure 4-2: Example 2—Diagram of an Installation that Has Administrator as the Required Execution Level

InstallShield 2020 User Guide ISP-2600-UG00 515

Chapter 4 Creating Installations
Before You Begin

See Also
Run-Time Behavior for an Installation that Includes InstallShield Prerequisites
Setup Prerequisites vs. Feature Prerequisites
Using Windows Installer with UAC (Windows Installer Help Library)
Using Windows Installer with UAC (Windows Installer Help Library)
Guidelines for Packages (Windows Installer Help Library)
Guidelines for Packages (Windows Installer Help Library)
Authoring Packages without the UAC Dialog Box (Windows Installer Help Library)
Authoring Packages without the UAC Dialog Box (Windows Installer Help Library)
Installing a Package with Elevated Privileges for a Non-Admin (Windows Installer Help Library)
Installing a Package with Elevated Privileges for a Non-Admin (Windows Installer Help Library)

Setting an Application’s Disk Usage

InstallShield 2020

Windows Installer uses a process called file costing to determine the total disk space a current installation requires. This
encompasses costs for files that will be installed or removed, registry entries, shortcuts, and other components of an
installation.

File Costing
File costing takes into account the fact that some files are overwritten by newer versions, which decreases the file cost.
These values are dependent on the volume to which each file is to be installed or removed, and they are recalculated when
a component’s directory association is changed.

File costs are determined for each component, depending on whether it is installed locally, installed to run from the source
media, such as a CD, or removed.

With InstallShield, you can set your application’s disk usage. This allows you to control file costing by choosing to run your
application from the source media, from the local machine, or to install it when required. Note that running your
application from the source enhances application resiliency and conserves space on an end user’s system.

Application Resiliency
If Windows Installer cannot provide a component, the Windows Installer technology enables applications to try to repair
the component or to reinstall the component if the corresponding file is corrupted or the current file is older than the
available version.

Source Resiliency
In addition to supporting application resiliency, the Windows Installer supports source resiliency through the Source List,
which can include network locations, URLs, or compact discs from which applications are installed on-demand.
Administrators can use the Group Policy Editor to disable this functionality.

INSTALLDIR vs. TARGETDIR

InstallShield 2020

INSTALLDIR represents the main product installation directory for a Basic MSI and InstallScript MSI installations, such as
the end user launching Setup.exe or your .msi database.

516 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4 Creating Installations
Before You Begin

TARGETDIR represents the installation directory for an InstallScript installation, or for an administrative Windows Installer–
based installation (when the user runs Setup.exe or MsiExec.exe with the /a command-line switch).

In an InstallScript MSI project, the InstallScript variable MSI_TARGETDIR stores the target of an administrative installation.

See Also
Setting the Default Product Destination Folder (INSTALLDIR)
Setup.exe and Update.exe Command-Line Parameters
TARGETDIR (InstallScript Variable)

Preventing the Current Installation from Overwriting a

Future Major Version of the Same Product
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

To prevent end users from being able to install the current version of your product over a future major version of the same
product, the Upgrades view should contain a major upgrade item, the major upgrade item should be properly configured
to prevent the current version of your product from being installed over a future version, and your project should include a
properly configured and scheduled type 19 custom action.

When you create a new Basic MSI or InstallScript MSI project, InstallShield automatically adds support for preventing the
current installation from overwriting a future major version:

• The Upgrades view contains a major upgrade item called ISPreventDowngrade.

The Products sharing my Upgrade Code option is selected on the Common tab of the major upgrade item. The value
of the Upgrade Code setting on the Advanced tab is {000000000000-0000-0000-0000-00000000}. When you build a
release, InstallShield uses the appropriate upgrade code value instead of the placeholder value in the .msi package
that it generates at build time. For more information on the upgrade code, see Setting the Upgrade Code.

InstallShield sets the Detect Property setting of this major upgrade item to ISFOUNDNEWERPRODUCTVERSION and
configures the other settings as appropriate.

• The Custom Actions and Sequences view contains a custom action called ISPreventDowngrade, a type 19 custom
action that Windows Installer launches when an end user tries to install the current version of your product over a
future major version.

InstallShield schedules the ISPreventDowngrade custom action for the user interface and execute sequences of the
installation sequence so that Windows Installer runs it if appropriate, regardless of what user interface level is used. In
addition, InstallShield uses ISFOUNDNEWERPRODUCTVERSION as the condition for this custom action.

The following instructions explain how to manually add this support for projects that you created in InstallShield 12 or
earlier and then upgraded to InstallShield 2020.

InstallShield 2020 User Guide ISP-2600-UG00 517

Chapter 4 Creating Installations
Before You Begin

Task To manually add support for preventing end users from being able to install the current version of your product over a
future major version:

1. Use the Upgrades view to add a major upgrade item to your project.

2. On the Common tab, select the Products using my Upgrade Code option.

3. Configure the settings on the Advanced tab for the major upgrade item as follows:

a. In the Minimum Version setting, specify the product version that you are using for your current project.

As an alternative, you can enter the following string in this setting:

***ALL_VERSION***

That value is a placeholder value. If you use that extract string in the Minimum Version setting, InstallShield uses
the product version of the currently open project instead of the placeholder value in the .msi package that it
generates at build time.

b. Leave the Maximum Version setting blank. If a value is listed for this setting, delete it.

c. If your project includes multiple languages, specify the language identifiers in the Language setting.

d. In the Detect Only setting, select Yes; for all of the other Yes-No settings, select No.

e. In the Detect Property setting, type a descriptive name such as the following one:

FOUNDNEWERVERSION

4. Add and schedule a type 19 custom action for your project to handle scenarios where an end user tries to install the
current version of your product over a future major version:

a. In the Custom Actions and Sequences view, right-click the Custom Actions explorer and click New Error.

b. Select the new custom action.

c. In the Error Message setting, type the error message text that should be displayed when an end user tries to
install the current version of your product over a future major version.

d. In the Install UI Sequence and Install Exec Sequence settings, select After FindRelatedProducts.

e. In the Install UI Condition and Install Exec Condition settings, type the value that you specified in step 3e.

See Also
ISICE19
Preventing an Old Package from Installing Over a Newer Version (Windows Installer Help Library)
Preventing an Old Package from Installing Over a Newer Version (Windows Installer Help Library)

Preparing Installations for Non-Administrator Patches

InstallShield 2020

Windows Installer 3.0 and later enables you to create patches that can be installed by non-administrators. Non-
administrator patches can be used if strict criteria are met. For example, the base installation that the patch will update
must include the certificate that will be used to sign the patch package. To learn about the other criteria that must be met,
see Non-Administrator Patches.

518 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4 Creating Installations
Before You Begin

Task To prepare a base installation that can later be updated by non-administrator patches:

1. In the View List under Media, click Releases.

2. In the Releases explorer, click the release whose digital signature information you want to configure.

3. Click the Signing tab.

4. Specify the digital signature information.

InstallShield automatically adds the necessary information to the MsiDigitalCertificate table and the
MsiPatchCertificate table. This enables you to create patches that can be installed by non-administrators.

Tip • The digital signature settings are also available in the Releases view.

The Windows Installer design enables you to sign a package with one certificate and also allow patches that are signed with
a different certificate. The following instructions explain how to add to the base installation the additional certificates for
the patches.

Task To add additional digital certificates:

1. Use a tool such as SignTool.exe to sign a dummy file. SignTool.exe is part of the Windows SDK.

2. In your original installation project, open the Direct Editor.

3. In the Tables explorer, click MsiDigitalCertificate.

4. Click the last row in the table to add a new entry.

5. In the DigitalCertificate field, type a unique name for your certificate.

6. Click the CertData field. The Edit Binary Stream dialog box opens.

7. In the File name box, enter the path and name of the file that you signed in step 1. You can click the browse button to
find the file.

8. Click OK.

9. In the Tables explorer, click MsiPatchCertificate.

10. Click the last row in the table to add a new entry.

11. In the PatchCertificate field, type a unique name for your patch certificate.

12. In the DigitalCertificate field, select the entry that you created for the MsiDigitalCertificate table in step 4.

InstallShield 2020 User Guide ISP-2600-UG00 519

Chapter 4 Creating Installations
Before You Begin

See Also
Signing a Patch Package
Signing a QuickPatch Package
Digital Signing and Security
User Account Control (UAC) Patching (Windows Installer Help Library)
User Account Control (UAC) Patching (Windows Installer Help Library)
MsiDigitalCertificate Table (Windows Installer Help Library)
MsiDigitalCertificate Table (Windows Installer Help Library)
MsiPatchCertificate Table (Windows Installer Help Library)
MsiPatchCertificate Table (Windows Installer Help Library)

Settings for Platforms and Platform Suites

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Note that some of the settings apply to both of these project types, but some apply only to one of these project types.

InstallShield includes several settings for platforms, platform suites, and languages.

Specifying Platforms at the Project Level

One project-level setting enables you to specify the platforms that your project supports:

• Platform Filtering—Use this setting to specify the platforms that you want to be available when you select operating
system requirements for components or releases in your project. In general, if a platform is not listed for this setting at
the project level, you cannot designate that a particular component or release in your project is targeted for that
platform.

The Platforms setting is available for InstallScript projects. To access this setting, open the General Information view.
You can also configure this setting through the Project Settings dialog box: on the Project menu, click Settings, and
click the Platforms tab.

Note • Specifying platforms at the project level does not create target system requirements for running the installation. If you
want to create target system requirements in an InstallScript project, use the SYSINFO structure to identify the operating
platform of the target system.

For information on how to specify target system requirements for InstallScript MSI projects, see Specifying Operating System
in the Project Assistant.

Specifying Operating Systems and Platform Suites at the Component Level

Two component-level settings enable you to specify platform information for a component:

• Operating Systems—If a component is specific to one or more operating systems, use this setting to indicate those
operating systems. If the target machine’s operating system does not match one of the operating systems that are
specified for this setting, the component is not installed.

520 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4 Creating Installations
Before You Begin

By default, components are operating system independent, meaning that none of the component’s data are specific
to certain operating systems.

The Operating Systems setting is available for InstallScript and InstallScript MSI projects. To access this setting, open
the Components view and select a component.

• Platform Suite(s)—If a component is specific to one or more platform suites, use this setting to indicate the suites. If
you specify more than suite, you can indicate whether all or any of the suites must be present on the target machine in
order for the component to be installed.

By default, components are platform suite independent, meaning that none of the component’s data are specific to a
particular platform suite.

This setting provides an additional layer of filtering beyond the Operating Systems setting. Set the Platform Suite(s)
setting only if necessary, and be sure to select only those platform suites that are required for the proper functioning
of your application. For example, if a component should be installed on both the Home and Professional editions of
Windows XP, you can leave Suite Independent as the value for this setting; selecting Windows XP for the Operating
Systems setting encompasses both editions.

The Platform Suite(s) setting is available for InstallScript projects. To access this setting, open the Components view
and select a component.

Specifying Platforms at the Release Level

One release-level setting enable you to specify platform information for a release:

• Platform(s)—If a release is specific to one or more platforms, use this setting to indicate the platforms. If the platform
specified for a component does not match one of the platforms that is selected for this setting, InstallShield does not
include the component in the release.

The default value for this setting is Use Project Setting. This value indicates that the release supports the platforms
that are specified at the project level.

The Platform(s) setting is available for InstallScript projects. To access this setting, open the Releases view and select
a release. You can also configure this setting through the Platforms panel in the Release Wizard.

Controlling Support for Platforms and Platform Suites at Run Time for InstallScript
Projects
During run time of InstallScript installations, you can control the platforms and platform suites that your installation
supports by calling the FeatureFilterOS function.

In the OnFilterComponents event handler, the framework typically calls this function with the platforms and platform
suites that match the target system so that only the appropriate components are installed. By calling FeatureFilterOS, you
can override this default behavior to install or prevent the installation of components based on any platform or platform
suite criteria that you specify.

For more information, see FeatureFilterOS.

See Also
Specifying Operating System in the Project Assistant
Platforms Tab
Platforms Dialog Box
Modify Property Dialog Box/Release Wizard—Platforms Panel

InstallShield 2020 User Guide ISP-2600-UG00 521

Chapter 4 Creating Installations
Before You Begin

522 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Specifying Installation Information

InstallShield 2020

As you begin creating your installation project, you will need to specify important installation information at the outset.
This includes specifying product and project settings and configuring Add or Remove Programs settings.

Configuring General Project Settings

InstallShield 2020

InstallShield stores your project settings in a single installation project file (.ism file). This file stores all of the information
about your project. In the General Information view, you can edit basic information about your installation project—
including the author’s name, the languages that the project supports, and any comments that you want to include.

The General Information view is also where you configure general product information such as the product name, the
product code (GUID), and the version number. A product is the top level of organization in an installation project. The
installation is further divided into features and components, which are subsets of your product. Although an installation
can contain multiple features and components, it can have only one product.

For detailed information about each of the project and projects settings that are available, see General Information View.

Saving an InstallShield Project File (.ism) in XML or Binary Format

InstallShield 2020

InstallShield lets you save your .ism project file in XML or binary format.

Task To specify the format of your project file:

1. In the View List under Installation Information, click General Information.

2. In Project File Format setting, select the appropriate option. Available options are:

• Binary—To save the project file as a database file, select this option. This format is best for the speed of opening
and saving the project file.

• XML—To save the project file as a hierarchical text-based format, select this option. This project file format is best
for use with source code control systems.

Note • Your InstallShield project file (.ism) retains the .ism file extension when you save it in XML or binary format.

Advanced UI and Suite/Advanced UI projects (.issuite) are always saved as XML files.

InstallShield 2020 User Guide ISP-2600-UG00 523

Chapter 4
Specifying Installation Information

Specifying a Product Name

InstallShield 2020

Enter the name of your product in the Product Name setting of the General Information view. The name that you enter
should be the name of the product for which you are creating an installation. This value is used throughout your project, in
various instances; for example:

• The name of the source file folder under the project location

• In Basic MSI and InstallScript MSI projects: the name of the Windows Installer package (.msi file) that InstallShield
builds by default

• In run-time dialogs

• Under the informational registry key in accordance with Windows logo requirements. The informational values are
found in the following location and are used in Add or Remove Programs to enable an end user to change or remove
your product.

HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\ProductCode

Since it will be incorporated into the paths for your source files, the product name cannot contain any of the following
characters: \ / : * ? " < > | . -

Tip • In an InstallScript or InstallScript MSI project, you can use the UNINSTALL_DISPLAYNAME variable to specify a different
product display name in Add or Remove Programs.

For Basic MSI and InstallScript MSI projects—If you do not want to use the product name for the .msi package file name, you
can use the MSI Package File Name setting on the General tab for a product configuration in the Releases view and specify a
different .msi file name. Note that if you want to be able to release minor upgrades or small updates to update your product,
the previous and latest versions of your installation must have the same .msi package name. Attempting to perform a minor
upgrade or a small update when the .msi file name has changed can lead to Windows Installer run-time error 1316.

Caution • If you want to include an ampersand (&) in your product name, you must use two ampersands (&&) to display the
name properly in end user dialogs. For example, to display New & Improved Product, you should enter the product name as
New && Improved Product.

See Also
Designing Merge Modules
General Information View
UNINSTALL_KEY

Specifying the Product Version

InstallShield 2020

When you are specifying the version number for your product, you must ensure that you enter a valid product version. The
version must contain only numbers. It is typically in the format aaa.bbb.ccccc or aaa.bbb.ccccc.ddddd, where aaa
represents the major version number, bbb represents the minor version number, ccccc represents the build number, and
ddddd represents the revision number. The maximum value for the aaa and bbb portions is 255. The maximum value for
ccccc and ddddd is 65,535.

524 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

At run time, the installation registers the version number of the product that is being installed. The entire version string is
displayed in Add or Remove Programs. The product version number is important because the installation engine uses it in
part to determine whether to apply an upgrade.

To configure the product version, use the General Information view. This product version can be overridden in other areas
of InstallShield—for example, for a product configuration in the Releases view of a Basic MSI project. You can also specify
the version number that you want an upgrade to target in other areas of InstallShield—for example, in the Upgrades view of
a Basic MSI or InstallScript MSI project.

Note that although you can include the fourth field (ddddd) when you specify your product’s version, the installation does
not use this part of the product version to distinguish between different product versions.

Project • For Advanced UI, Basic MSI, InstallScript, InstallScript MSI, and Suite/Advanced UI projects—If your release includes
a Setup.exe file, the product version that you specify is displayed on the Properties dialog box for Setup.exe. For more
information, see Customizing File Properties for the Setup Launcher.

For InstallScript and InstallScript Object projects—Instead of hard-coding a value, you can use a path variable that is defined
in the Path Variables view. At build time, InstallShield replaces the path variable with the appropriate value. (To use a path
variable: On the Project menu, click Settings. Then select the appropriate path variable on the Application tab.)

See Also
ProductVersion Property (Windows Installer Help Library)
ProductVersion Property (Windows Installer Help Library)
Designing Merge Modules
General Information View
Product Version Numbers in InstallScript and InstallScript Object Projects

Product Version Numbers in InstallScript and InstallScript Object Projects

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript Object

By default, InstallScript projects use version numbers in packed DWORD format—that is, as a four-byte value whose first
byte is the major version, second byte is the minor version, and last two bytes are the build number. Packed DWORDS are
entered and displayed in the format major.minor.build; for example, 1.2.3 or 255.255.65535. Packed DWORD version
numbers are assumed in the default script code for registering the version number of the product that is being installed,
and for comparing that version number to that of the already installed product during an update installation.

If any of these version numbers are not in packed DWORD format, you must modify the script code as discussed in the
following sections.

Version Number of the Already Installed Product

The default OnSetUpdateMode event handler function code compares the version number of the product that is being
installed, and the version numbers to which the update can be applied (as specified in the Release property sheet), to the
system variable IFX_INSTALLED_VERSION. The installation automatically attempts to initialize the value of this system

InstallShield 2020 User Guide ISP-2600-UG00 525

Chapter 4
Specifying Installation Information

variable to the string equivalent of the data in the Version value under the application uninstallation registry key. If that
value does not exist, or its data is not a packed DWORD, then the value of IFX_INSTALLED_VERSION is a null string (""), in
which case the default OnSetUpdateMode code displays an error message and aborts the installation. One solution is to
insert code that checks the version information on the system and sets IFX_INSTALLED_VERSION equal to an appropriate
packed DWORD value. For example, if previous installations stored a version string in the MyVersion value under
HKEY_LOCAL_MACHINE\SOFTWARE\MyCompany\MyProduct, you could insert code like the following:

if (IFX_INSTALLED_VERSION="") then
/* Get the registered version information. */
RegDBSetDefaultRoot( HKEY_LOCAL_MACHINE );
RegDBGetKeyValueEx( "Software\\MyCompany\\MyProduct",
"MyVersion", REGDB_STRING, szVersionString, nSize );

/* Assign a value to IFX_INSTALLED_VERSION. */

switch (szVersionString)
/* A registered version string of "A" corresponds to an existing version number of 1.0.0. */
case "A":
IFX_INSTALLED_VERSION = "1.0.0";
/* A registered version string of "B" corresponds to an existing version number of 1.1.0. */
case "B":
IFX_INSTALLED_VERSION = "1.1.0";
/* An absent version string corresponds to an existing version number of 0.0.0. */
default:
IFX_INSTALLED_VERSION = "0.0.0";
endswitch;
endif;

Version Number of the Product that Is Being Installed

The default OnMoveData event handler function code calls RegDBSetVersion to take the product version number that
you entered in the General Information view and enter it in the target system’s registry. RegDBSetVersion assumes that
the product version is in packed DWORD format. If you want to register a product version that is not in packed DWORD
format, you must replace OnMoveData’s call of RegDBSetVersion with code like the following:

/* The setup automatically initializes the value of the system variable

IFX_PRODUCT_VERSION to the product version that you entered in the
Product Version setting in the General Information view. */
RegDBSetItem(REGDB_UNINSTALL_VERSION, IFX_PRODUCT_VERSION );
RegDBSetItem(REGDB_UNINSTALL_DISPLAY_VERSION, IFX_PRODUCT_VERSION );

RegDBSetItem must be called after MaintenanceStart.

See Also
Creating an InstallScript Release to Update Previous Versions

Setting the Product Code in a Windows Installer–Based Project

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

526 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

• MSI Database
• Transform

The product code is a string that uniquely identifies your product. An installation uses a product code at run time to
determine whether the product has already been installed.

Enter a GUID that uniquely identifies your product, or click the Generate a new GUID button ({...}) in the Product Code
setting in the General Information view to let InstallShield generate a new GUID. The installation registers this GUID at run
time.

Caution • Because the product code uniquely identifies your product, changing the code after distributing a release of your
product is not recommended.

See Also
GUIDs
General Information View

Setting the Product Code in an InstallScript-Based Project

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript Object

The product code is a GUID string that uniquely identifies your product. An installation uses a product code at run time to
determine whether the product has already been installed.

Enter a GUID that uniquely identifies your product, or click the Generate a new GUID button ({...}) in the Product Code
setting in the General Information view to let InstallShield generate a new GUID. The installation registers this GUID at run
time.

Caution • The project GUID is used to associate uninstallation or maintenance with the original installation. A new GUID is
automatically generated for each new project that you create, including copies of existing projects. Once you have changed a
project's GUID, its previous GUID cannot be recovered. For these reasons, changing a project's GUID is typically not necessary
and should be approached with caution.

See Also
GUIDs
General Information View

InstallShield 2020 User Guide ISP-2600-UG00 527

Chapter 4
Specifying Installation Information

Setting the Upgrade Code

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• QuickPatch
• Transform

The upgrade code is a GUID that uniquely identifies the product family to which the product belongs. In most cases, the
upgrade code should be consistent across different versions and languages of a family of related products so that Windows
Installer can use it to search for related versions of the product that are already installed.

To configure the GUID for a new product, use the Upgrade Code setting in the General Information view. This upgrade code
value can be overridden in other areas of InstallShield—for example, for a product configuration in the Releases view, or for
each instance that is defined on the Multiple Instances tab for a product configuration in the Releases view.

When you are working on an upgrade for a new version of your product, use the upgrade code that was configured in the
General Information view (or overridden in one of the aforementioned other areas of InstallShield) as the GUID that you
specify in the Upgrades view of your upgrade project or in your QuickPatch project; when these upgrade codes match, the
upgrade or patch can target the base version, and Windows Installer can update it as needed.

See Also
Major Upgrade vs. Minor Upgrade vs. Small Update
GUIDs

Setting Product Conditions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The Installation Requirements page in the Project Assistant lets you specify some commonly used installation
requirements for the target system. For example, if your application requires a specific operating system in order to run
properly, you can indicate that on the Installation Requirements page.

InstallShield also enables you to define your own custom conditions that Windows Installer must evaluate before your
product can be installed. Conditions that you create in the General Information view and on the Installation Requirements
page in the Project Assistant apply to the entire product; if one or more of the conditions are false on the target system, the
installation exits and an error message is displayed.

528 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

For example, if your product requires 64 MB of RAM in order to run properly, you can use the Product Condition Builder
dialog box to create a condition. At run time, the Windows Installer checks the target system to determine how much RAM
is installed. If it is less than 64 MB, or if any of the other product conditions are false, the Windows Installer displays an error
message and exits the installation.

Tip • You cannot guarantee the order in which Windows Installer evaluates product launch conditions. If it is necessary to
control the order in which the conditions are evaluated, you can create an error custom action in the Custom Actions and
Sequences view for each condition, and schedule them in the appropriate order.

Task To create a custom launch condition for your product’s installation:

1. In the View List under Installation Information, click General Information.

2. Click the Install Condition setting and then click the ellipsis button (...). The Product Condition Builder dialog box
opens.

3. Click the New Condition button. InstallShield adds a new condition row to the Conditions box.

4. Do one of the following:

• In the Condition column, type the launch condition.

• Use the Properties list, the Operators list, and the Add buttons to build your conditional statement:

a. In the Properties list, select a property and then click the Add button. InstallShield adds the property to the
Condition column.

b. If your conditional statement should contain an operator, select an operator in the Operators list and then
click the Add button. InstallShield adds the operator to the conditional statement.

c. If your conditional statement should contain a value, double-click the condition field, press END so that the
insertion point is at the end of the condition statement, and enter the value.

5. In the Message column, enter the error message that you would like to be displayed if the condition evaluates to false.

When you type a value for this column, you are creating a string entry and setting its initial value for all of the
languages that are currently in the project. As an alternative to typing a new value, you can double-click this setting
and then click the ellipsis button (...) in this setting to select an existing string. For more information, see Using String
Entries in InstallShield.

Note • Windows Installer dialogs, which display the text that you specify in the Message column, do not recognize the
escape sequences \r (carriage return), \n (new line), or \t (tab).

6. Click OK.

Important • InstallShield performs basic condition validation; however, you should still double-check that your condition
statements evaluate to the expected outcome. For more information and example conditions, see Building Conditional
Statements.

InstallShield 2020 User Guide ISP-2600-UG00 529

Chapter 4
Specifying Installation Information

See Also
Conditional Statement Syntax (Windows Installer Help Library)
Conditional Statement Syntax (Windows Installer Help Library)
Installation Requirements Page
Product Condition Builder Dialog Box
Conditional Statement Syntax

Setting the Default Product Destination Folder (INSTALLDIR)

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Your project’s INSTALLDIR property serves as the default folder for all of your product’s files. Its value is assigned to the
Windows Installer folder property INSTALLDIR, which is the default feature and component destination folder.

Windows Logo • According to the Windows logo program requirements, the default destination of your product’s files must
be a subfolder of the Program Files folder or the end user’s Application Data folder, regardless of the language of the target
system. If you use ProgramFilesFolder as the parent folder for your product’s destination folder setting, your files are installed
to the correct location. The default value for the INSTALLDIR setting is:

[ProgramFilesFolder]Company Name\Product Name

Task To set a product’s INSTALLDIR property:

1. In the View List under Installation Information, click General Information.

2. To use a built-in Windows Installer directory as part of your path: In the INSTALLDIR setting, click the ellipsis button
(...) . The Set INSTALLDIR dialog box opens. In the Destination Directories box, select a destination folder.

As an alternative, you can manually enter the path in the INSTALLDIR setting.

Note • Selecting a new folder property in the Set INSTALLDIR dialog box overwrites the contents of the value in the
INSTALLDIR setting. You can specify a subfolder of any folder property by separating subfolders with a backslash—for
example, [ProgramFilesFolder]My Company\Program.

Other Destination Folder Considerations (Windows Installer–based projects only)

Setting the feature’s Remote Installation setting to Favor Source—or to Favor Parent when the subfeature’s parent feature
is set to Favor Source—means that the feature’s files will not be installed on the target system, regardless of the product’s
INSTALLDIR property.

530 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Each feature and component has a Destination setting. The feature’s Destination setting overrides the product’s
Destination Folder setting, and the component’s Destination setting overrides the feature’s. Therefore, if you want all of
your product’s files to be installed by default to the product’s destination folder, enter [INSTALLDIR] for all of your
features’ and components’ Destination settings.

When using an installer folder property such as INSTALLDIR, you are specifying a default value. An end user could change
this value by setting a property when launching Msiexec.exe at the command line or by selecting a new destination folder
for a feature in the CustomSetup dialog.

See Also
Component Destination vs. Feature Destination

Securing Files, Folders, Registry Keys, and Windows Services in a Locked-

Down Environment
InstallShield 2020

InstallShield offers several ways to secure files, folders, registry keys, and Windows services for end users who run your
product in a locked-down environment:

• Traditional Windows Installer handling—In Windows Installer–based projects, you can choose to use the built-in
Windows Installer support for setting permissions for files, folders, and registry keys at run time. With this option,
InstallShield stores permission information for your product in the LockPermissions table of the .msi database.

This type of permission handling cannot be combined with the new Windows Installer handling; if you try to build a
release that contains the MsiLockPermissionsEx table and the LockPermissions table, build error -7207 occurs.

• New Windows Installer handling—In Windows Installer–based projects, you can choose to use the latest Windows
Installer support for setting permissions for files, folders, registry keys, and Windows services at run time. With this
option, InstallShield stores permission information for your product in the MsiLockPermissionsEx table of the .msi
database.

This option requires Windows Installer 5 or later on the target system; earlier versions of Windows Installer ignore
settings for this type of handling.

This type of permission handling cannot be combined with the traditional Windows Installer handling; if you try to
build a release that contains the MsiLockPermissionsEx table and the LockPermissions table, build error -7207
occurs.

• Custom InstallShield handling—In Windows Installer–based projects, you can choose to use custom support for
setting permissions at run time. With this option, InstallShield stores permission information for your product in the
custom ISLockPermissions table of the .msi database. InstallShield also adds custom actions to your project.

• SetObjectPermissions, an InstallScript Function—You can use the SetObjectPermissions function in InstallScript

events and InstallScript custom actions to set permissions at run time.

All of these methods enable you to assign permissions for a file, folder, or registry key to specific groups and users. For
example, you may assign Read, Write, and Delete permissions for a particular file to the Administrators group, but only
Read permissions for all of the users in a different group. The new Windows Installer handling option also lets you assign
permissions for a Windows service.

InstallShield 2020 User Guide ISP-2600-UG00 531

Chapter 4
Specifying Installation Information

Determining Which Option to Use

The following table compares the different types of methods for setting permissions.

Table 4-1 • Comparison of Different Ways to Secure Objects in a Locked-Down Environment

Comparison Category Explanation of Available Support

Project type • Traditional Windows Installer handling, New Windows Installer handling, and
Custom InstallShield handling—Available in the following project types: Basic MSI,
DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform.

• SetObjectPermissions function—Available in InstallScript events in the following

project types: InstallScript, InstallScript MSI.

Also available through InstallScript custom actions in the following project types: Basic
MSI, DIM, InstallScript MSI, and Merge Module.

Well-known security • Traditional Windows Installer handling—Supports a limited number of SIDs

identifiers (SIDs) (Administrators, Everyone).

• New Windows Installer handling, Custom InstallShield handling,

SetObjectPermissions function—Supports many SIDs (Administrators, Authenticated
Users, Creator Owner, Everyone, Guests, Interactive, Local Service, Local System,
Network Service, Power Users, Remote Desktop Users, and Users).

Localized names for • Traditional Windows Installer handling—Does not support localized names for SIDs;
SIDs if you try to use a localized name, the installation fails.

• New Windows Installer handling, Custom InstallShield handling, and

SetObjectPermissions function—Supports localized names for all of the supported
well-known SIDs (Administrators, Authenticated Users, Creator Owner, Everyone,
Guests, Interactive, Local Service, Local System, Network Service, Power Users,
Remote Desktop Users, and Users).

Ability to deny specific • Traditional Windows Installer handling—Not supported. This handling lets you set
permissions specific permissions; you cannot deny permissions. Thus, you can give a user read-only
access to a file. However, you cannot prevent a user from having read-only access.

• New Windows Installer handling, Custom InstallShield handling, and

SetObjectPermissions function—Supported. These options let you indicate whether
you want to deny a user or group from having the permissions that you are specifying.

532 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Table 4-1 • Comparison of Different Ways to Secure Objects in a Locked-Down Environment (cont.)

Comparison Category Explanation of Available Support

Effect on permissions • Traditional Windows Installer handling—Existing permissions may be deleted. For
that already exist example, if permissions are already set for a folder on the target system for the
Everyone user, and your installation needs to set permissions for the Administrators
user, this option would allow you to set permissions for the Administrators user.
However, the existing permissions for Everyone would be deleted.

• New Windows Installer handling, Custom InstallShield handling, and

SetObjectPermissions function—These options let you add permissions to a file,
folder, or registry key that already exists on the target system, without deleting any
existing permissions for that object. For example, if permissions are already set for a
folder on the target system for the Everyone user, and your installation needs to set
permissions for the Administrators user, these options would allow you to set
permissions for the Administrators user without deleting the existing permissions for
the Everyone user.

Ability to propagate • Traditional Windows Installer handling—Not supported. If you want to configure
permissions to child permissions for a subfolder or a file in a folder (or a subkey under a registry key), the
objects (subfolders, parent that is created on the target system automatically inherits the permissions of its
files, and subkeys) child.

• New Windows Installer handling, Custom InstallShield handling, and

SetObjectPermissions function—Supported. These options let you configure
permissions for a folder (or a registry key), and indicate whether you want the
permissions to be applied to all of the folder’s subfolders and files (or the registry key’s
subkeys).

Ability to set • Traditional Windows Installer handling, New Windows Installer handling, and
permissions for objects Custom InstallShield handling—Not supported.
that are not being
• SetObjectPermissions function—Supported. You can secure permissions for a file,
installed as part of your
folder, or registry key that is installed as part of your installation, or it can be already
installation
present on the target system.

Ability to set • Traditional Windows Installer handling—Not supported.

permissions for a new
• New Windows Installer handling, Custom InstallShield handling, and
user that is being
SetObjectPermissions function—Supported. If a new user is created during the
created during the
installation, you can configure permissions for that user.
installation

Learning More about the Custom InstallShield Handling Option or the Traditional
Windows Installer Handling Option
In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects, you need to
specify whether you want to use the custom InstallShield handling or the Windows Installer handling. To learn how, see
Selecting the Locked-Down Permissions Type for a Project.

InstallShield 2020 User Guide ISP-2600-UG00 533

Chapter 4
Specifying Installation Information

To learn how to set permissions for a file or folder using either of these options, see Configuring Permissions for Files and
Folders. For information on setting permissions for a registry key using either of these options, see Configuring Permissions
for Registry Keys.

Learning More about the New Windows Installer Handling Option

To use the new Windows Installer handling option for a service, add a service to your project and then configure its
settings. For more information, see Installing, Controlling, and Configuring Windows Services.

To use the new Windows Installer handling option for files, folders, or registry keys, use the MsiLockPermissionsEx table
in the Direct Editor view.

Learning More about the InstallScript Function SetObjectPermissions

For information on the SetObjectPermissions function, see SetObjectPermissions.

See Also
LockPermissions (Windows Installer Help Library)
LockPermissions (Windows Installer Help Library)
MsiLockPermissionsEx (Windows Installer Help Library)
MsiLockPermissionsEx (Windows Installer Help Library)

Selecting the Locked-Down Permissions Type for a Project

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield includes a project-wide setting that lets you specify how your installation should configure permissions for
files, folders, and registry keys for end users in a locked-down environment.

Task Selecting the locked-down permission type for a project:

1. In the View List under Installation Information, click General Information.

2. In the Locked-Down Permissions setting, select the appropriate option:

• Custom InstallShield handling—InstallShield adds a custom table and custom actions to your project to set
permissions on the target system. This is the default value.

• Traditional Windows Installer handling—InstallShield uses the LockPermissions table in the .msi database to
store permissions information for your product.

534 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

For a detailed comparison of these two options, see Securing Files, Folders, Registry Keys, and Windows Services in a
Locked-Down Environment.

The next time that you configure permissions for a file, folder, or registry key in your project, InstallShield uses the locked-
down permission type that you selected:

• If you selected the traditional Windows Installer handling option, InstallShield uses the LockPermissions table in
your project.

• If you selected the custom InstallShield handling option, InstallShield uses the ISLockPermissions table in your
project; InstallShield also adds the ISLockPermissionsCost and ISLockPermissionsInstall custom actions to your
project.

If you change the value of the Locked-Down Permissions setting but your project already contains permission settings for
files, folders, or registry keys, InstallShield displays a message box that lets you specify whether you want to migrate the
permission data to the appropriate table. If you choose to migrate the data, InstallShield moves the data to the table that
corresponds with the option that you selected; if you are switching from the custom InstallShield handling option to the
traditional Windows Installer handling option, InstallShield also deletes the ISLockPermissionsCost and
ISLockPermissionsInstall custom actions from your project.

See Also
LockPermissions (Windows Installer Help Library)
LockPermissions (Windows Installer Help Library)

Specifying Whether Windows Installer Installations Should Be Logged

InstallShield 2020

InstallShield enables you to specify on a project-wide basis whether Windows Installer 4.0 or later should log your
installation. You can also customize the types of messages that are logged.

Task To specify project-wide logging information for Windows Installer 4.0 or later:

1. In the View List under Installation Information, click General Information.

2. Click the Create MSI Logs setting, and then click the ellipsis button (...). The Logging Options for Windows Installer
4.0 and Later dialog box opens.

3. Select the appropriate option. If you select the custom option, enter the MsiLogging value.

For a list of valid parameters for the MsiLogging value, see MsiLogging Property in the Windows Installer Help Library.

4. Click OK.

The results vary, depending on which option you select in the Logging Options for Windows Installer 4.0 and Later dialog
box:

• If you select No, installations are not logged. This is the default value.

• If you select Yes, InstallShield populates the MsiLogging property with the default value of voicewarmup. If the
installation is run on a target system that has Windows Installer 4.0, the following occurs:

• The installer creates a log file according to the default logging mode of voicewarmup.

• The installer populates the MsiLogFileLocation property with the log file’s path.

InstallShield 2020 User Guide ISP-2600-UG00 535

Chapter 4
Specifying Installation Information

• A Show the Windows Installer log check box is added to the SetupCompleteSuccess, SetupCompleteError, and
SetupInterrupted dialogs. If the end user selects that check box and then clicks Finish, the log file is opened in a
text file viewer or editor.

• If you select Custom, InstallShield populates the MsiLogging property with the value that you specify in the box. If the
installation is run on a target system that has Windows Installer 4.0, the following occurs:

• The installer creates a log file according to the custom value that you specified in the box.

• The installer populates the MsiLogFileLocation property with the log file’s path.

• A Show the Windows Installer log check box is added to the SetupCompleteSuccess, SetupCompleteError, and
SetupInterrupted dialogs. If the end user selects that check box and then clicks Finish, the log file is opened in a
text file viewer or editor.

Earlier versions of Windows Installer ignore the MsiLogging setting. The Show the Windows Installer log check box is not
visible in run-time dialogs that are displayed on systems running earlier versions of Windows Installer.

Important • The MsiLogFileLocation property is read-only; it cannot be used to set or change the log file location.

See Also
Logging Options for Windows Installer 4.0 and Later Dialog Box

Running an InstallScript Installation Multiple Times

InstallShield 2020

The InstallScript project type offers several options for the behavior of your installation when a target machine already has
your product installed and the end user reruns the installation.

Table 4-2 • Maintenance Experience Settings

Number of Entries Created in Add or

Maintenance Experience When Maintenance UI Is Displayed Remove Programs

Standard Whenever the installation is rerun One

Multi-Instance Only when the installation is rerun Multiple—a separate entry for each
from the Add or Remove Programs instance

No uninstall or maintenance Never None

You can select these options from the Maintenance Experience setting in the General Information view.

For the default behavior—the standard option—the maintenance user interface is displayed if end users rerun an
installation on machines.

The multi-instance option lets your end users rerun an installation multiple times as a first-time installation rather than as
a maintenance installation. By default, this option lets end users install the product to a different location each time that
they run the installation. Each time that they run the installation as a first-time installation, the components that they
select (whether directly or by selecting a setup type) are installed.

536 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

If one or more instances of your product are present on a machine when an end user reruns the multi-instance installation
with a user interface, the installation displays the Qualifying Product(s) Detected dialog. This dialog enables the end user to
select the instance to which the update should be applied. However, if the end user reruns the installation silently, the
installation suppresses the Qualifying Product(s) Detected dialog and creates a new instance on the machine.

Project • For information on multiple-instance support in Basic MSI projects, see Installing Multiple Instances of Products.

Configuring the Enable Maintenance Setting

InstallShield 2020

Project • This information applies to InstallScript MSI projects.

Use the Enable Maintenance setting in the General Information view to indicate whether you want to display the full
maintenance user interface (UI) or the uninstallation UI when end users rerun the installation on a system on which the
product is already present.

The following table shows the available options for the Enable Maintenance setting.

Table 4-3 • Enable Maintenance Setting Options

Option Description

Yes Unless the /removeonly command-line parameter is passed to Setup.exe, the system variable
REMOVEONLY is set to FALSE when an end user reruns the installation, and the standard
maintenance UI is displayed.

No The system variable REMOVEONLY is set to TRUE when an end user reruns the installation, and
the uninstallation UI is displayed.

Note • Selecting No for the Enable Maintenance setting does not cause the OnUninstall event
handler to be called. If you want the OnUninstall event handler to be called, you must use the /
uninst command-line parameter for Setup.exe. Note that this is applicable only if the InstallScript
UI style is the traditional style, which uses the InstallScript engine as an external UI handler. The /
uninst command-line parameter is not supported if the InstallScript UI style is the new style (which
uses the InstallScript engine as an embedded UI handler). To learn more, see Using the InstallScript
Engine as an External vs. Embedded UI Handler for InstallScript MSI Installations.

Note • InstallScript MSI installations show separate Change and Remove buttons in Add or Remove Programs in the Control
Panel by default. Clicking the Change button always displays the maintenance UI, and clicking the Remove button always
displays the uninstallation UI.

The Enable Maintenance setting has no effect on the behavior that occurs if end users initiate maintenance for your product by
clicking the Change button for your product’s entry in Add or Remove Programs.

InstallShield 2020 User Guide ISP-2600-UG00 537

Chapter 4
Specifying Installation Information

If you want to prevent end users from being able to run maintenance from within Add or Remove Programs, select Yes for the
Disable Change Button setting in the General Information view.

See Also
General Information View
Setup.exe and Update.exe Command-Line Parameters
REMOVEONLY

Using the InstallScript Engine as an External vs. Embedded UI Handler for

InstallScript MSI Installations
InstallShield 2020

Project • This information applies to InstallScript MSI projects.

InstallScript MSI installations use two different installer engines:

• The Windows Installer engine runs the standard Execute sequence of the .msi package. This is the sequence that
typically modifies the target system.

• The InstallScript engine serves as the custom user interface (UI) handler of the installation. It also executes the
InstallScript code. The advantage of using the InstallScript engine for the UI is that it offers support for highly
customized run-time dialogs.

Traditionally, Windows Installer has had support for only external custom UI handlers; therefore, InstallScript MSI
installations have always required a Setup.exe setup launcher. The setup launcher serves as a bootstrap application that
initiates the InstallScript engine to display the UI and run the InstallScript code, and the Windows Installer to run the
Execute sequence of the .msi package.

Windows Installer 4.5 introduces support for embedded custom UI handlers. If the InstallScript engine is embedded within
the .msi package, an InstallScript MSI installation does not require the Setup.exe setup launcher; end users can launch the
installation by launching the .msi package. In this case, the .msi package contains the information that the Windows
Installer needs to know about launching the InstallScript engine for the installation’s UI.

Thus, InstallShield offers two different styles for the UI of InstallScript MSI installations:

• Traditional style (requires a Setup.exe setup launcher)—This style lets you use the InstallScript engine as an external
UI handler for your InstallScript MSI installation. This is the default style.

• New style (requires Windows Installer 4.5 on the target machine)—This style lets you use the InstallScript engine as an
embedded UI handler for your InstallScript MSI installation. With this style, InstallShield embeds the InstallScript
engine within the .msi package. Note that this option has some limitations.

The following sections provide detailed information about these two styles; review this information to determine which
style would best meet your requirements.

538 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Traditional Style (InstallScript Engine as an External UI Handler)

The general flow in a traditional-style InstallScript MSI package during a first-time installation is as follows:

1. The InstallScript engine opens the .msi package.

2. All actions in the Installation UI sequence are run with the exception of the ExecuteAction. The actions are run in
ascending sequence order.

3. The InstallScript engine performs its own internal component costing to determine the space required for all features
and components in the installation.

4. The InstallScript engine launches the compiled script contained in ISSetup.dll. The event sequence for the events
that are run before the .msi package installation is as follows:

a. OnBegin

b. OnXxxUIBefore (where Xxx is First, Maint, Admin, Patch, Resume, etc.)

c. OnGeneratingMsiScript

d. OnMoving

e. OnFeaturesInstalling (Any feature installing and uninstalling events are run at this point.)

f. OnInstallFilesActionBefore

g. OnGeneratedMsiScript

5. The InstallScript engine launches the .msi package installation through MsiInstallProduct. The following factors
determine the command line that the InstallScript engine passes through MsiInstallProduct: installation mode (for
example, first-time installation, maintenance mode, minor upgrade, patch), internal feature selections, and current
property values.

6. If the .msi package installation is successful, the InstallScript engine writes the secondary uninstall key
(InstallShield_{ProductCode}) to the machine and then launches the following events:

a. OnInstallFilesActionAfter

b. OnFeaturesInstalled (Any feature installed and uninstalled events are run at this point.)

c. OnMoved

d. OnXxxUIAfter (where Xxx is First, Maint, Admin, Patch, Resume, etc.)

e. OnEnd

7. After the script has completed, the InstallScript engine writes the InstallScript log to the machine.

8. The InstallScript engine shuts down.

InstallShield 2020 User Guide ISP-2600-UG00 539

Chapter 4
Specifying Installation Information

New Style (InstallScript Engine as an Embedded UI Handler)

The InstallScript MSI embedded UI support attempts to follow the same general flow as traditional-style InstallScript MSI
installation. However, there are certain portions of the flow that do not occur or are unnecessary. The general flow in a
new-style InstallScript MSI package during a first-time installation is as follows:

1. The .msi package is launched directly or by Setup.exe (which then launches Msiexec.exe, which is the same behavior
for a Basic MSI installation).

2. The Windows Installer engine extracts all files that are in the MsiEmbeddedUI table and calls the initialize embedded
UI function in the DLL that contains the embedded UI handler attribute. (In the InstallScript MSI case, this is
ISSetup.dll).

3. The InstallScript engine initializes and manually launches the ISSetupFilesExtract action if it is present and its
condition in the InstallUISequence evaluates to true.

4. The InstallScript engine performs manual resolution of all entries in the Directory table.

5. The InstallScript engine performs its own internal component costing to determine the space required for all features
and components in the installation.

6. The InstallScript engine launches the compiled script contained in ISSetup.dll. The event sequence for the events
that are run before the .msi package installation is as follows:

a. OnBegin

b. OnXxxUIBefore (where Xxx is First, Maint, Admin, Patch, Resume, etc.)

c. OnGeneratingMsiScript

d. OnMoving

e. OnFeaturesInstalling (Any feature installing and uninstalling events are run at this point.)

f. OnInstallFilesActionBefore

g. OnGeneratedMsiScript

7. The InstallScript engine returns control to the Windows Installer engine, which then begins running the installation’s
Execute sequence.

8. If the .msi package installation is successful, the Windows Installer engine calls back into ISSetup.dll. ISSetup.dll
then launches the following events:

a. OnInstallFilesActionAfter

b. OnFeaturesInstalled (Any feature installed and uninstalled events are run at this point.)

c. OnMoved

d. OnXxxUIAfter (where Xxx is First, Maint, Admin, Patch, Resume, etc.)

e. OnEnd

9. The InstallScript engine shuts down and returns control to the Windows Installer.

For the new-style InstallScript MSI installations, the Install UI sequence is not run. If any custom actions are sequenced in
the Install UI sequence, they will not run, similar to how such actions would not run in a Basic MSI that is launched with /qb
or /qn.

The InstallScript engine does not log any changes that are made to the system from InstallScript events.

540 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Most command-line parameters that are supported by traditional-style InstallScript MSI installations are also supported
for new-style InstallScript MSI installations. If an end user launches the .msi package directly, these parameters can be
passed through the ISSCRIPTCMDLINE property.

Limitations with the Traditional Style (InstallScript Engine as an External UI Handler)

Uninstallable Patch Support

The traditional style does not have support for creating uninstallable patches.

Limitations and Known Issues with the New Style (InstallScript Engine as an Embedded UI Handler)
If you are considering the new style, note the following details.

Windows Installer 4.5 Requirement

The new style requires that Windows Installer 4.5 be present on the target system. You can add InstallShield prerequisites
for Windows Installer 4.5 to your project so that Windows Installer 4.5 is installed if it is not present. If you include these
InstallShield prerequisites in your installation, you need to use a Setup.exe setup launcher. For more information, see
Adding Windows Installer Redistributables to Projects. Note that Windows Installer 4.5 cannot be installed on some of the
early versions of Windows.

If Windows Installer 4.5 is not installed on a target system at run time, and the installation is launched with Setup.exe, the
setup launcher displays error 1713 and indicates that the installation requires Windows Installer 4.5 or later in order to run.
The installation aborts after the end user dismisses this error message. If the .msi package is launched directly, the
installation displays an error indicating that the package needs to be launched from the Setup.exe file.

Upgrade and Patch Support

InstallShield does not include any built-in support for creating an upgrade that uses the new style if the upgrade updates a
product that was installed with the traditional style. Therefore, if you use the traditional style to build a release of your
product and then you later create an upgrade, consider using the traditional style again for the upgrade. This applies to all
types of upgrades (major upgrades, minor upgrades, and small updates) that are packaged as full-installations or as
patches.

Note that if the previous setups that a patch is targeting use the traditional style, the patch should also use the traditional
style. Also note that a QuickPatch project maintains the UI style from the original installation. Therefore, if the original
installation used the traditional style, the QuickPatch package also uses the traditional style. If the original installation
used the new style, the QuickPatch package also uses the new style.

As a workaround for the major upgrade scenario, you could consider having your new-style major-upgrade installation
read the uninstall string of the earlier product from the registry, and launching it with the InstallScript function
LaunchApplication to uninstall the earlier version of your product before installing the new version. Note that you may
need to set LAAW_SHELLEXECUTEVERB to runas before using LaunchApplication in your script.

MsiDoAction
Attempting to call the MsiDoAction function from one of the events that are run before the .msi package installation
returns an error. This error occurs because of the handle that the Windows Installer passes to the InstallScript engine. The
handle does not support running standard or custom actions in the .msi package. This function can be called from
InstallScript custom actions if needed.

InstallShield 2020 User Guide ISP-2600-UG00 541

Chapter 4
Specifying Installation Information

MsiGetTargetPath and MsiSetTargetPath

The Windows Installer MsiGetTargetPath and MsiSetTargetPath functions do not work correctly in the new style if they
are in event-driven script. These functions rely on the Directory Manager having been initialized by the Windows Installer
costing actions. In new-style InstallScript MSI installations, Windows Installer costing is not performed. Thus,
MsiGetTargetPath fails to return any path information, and MsiSetTargetPath fails to set the requested target path. In
both cases, Windows Installer logs messages in a verbose log if either of these functions are called.

To update installation paths, use FeatureSetTarget.

Note that MsiGetTargetPath and MsiSetTargetPath can be called through InstallScript custom actions that are
sequenced after CostFinalize in the Installation Execute sequence.

FeatureTransferData and ComponentTransferData

The behavior of the InstallScript functions FeatureTransferData and ComponentTransferData is undefined for the new
style of InstallScript MSI installations and should not be used.

program…endprogram

New-style InstallScript MSI installations cannot use procedural scripts (that is, those with a program…endprogram block).
The program function is not called in this case. An event-driven script should be used to customize the behavior of the
installation.

/uninst
New-style InstallScript MSI installations do not support the /uninst command-line parameter.

BATCH_INSTALL

Attempting to reboot by setting the BATCH_INSTALL variable does not work correctly. To perform a reboot, use the
ScheduleReboot action for the REBOOT property.

Reboot Support

Reboots for new-style InstallScript MSI installations are handled in the same manner as they are handled for Basic MSI
installations—not as they are handled for InstallScript-based installations (where the installation resumes after the restart
and the OnRebooted event handler is called).

New-style InstallScript MSI installations should be authored similarly to Basic MSI installations to handle reboots; the
installation does not run after a scheduled reboot occurs, and the OnRebooted event handler is not called.

Msiexec.exe /x (for Uninstallation)

If an end user tries to uninstall the product through the command line using the statement Msiexec.exe /x
{ProductCode}, the uninstallation may be successful. However, the Windows Installer displays an error dialog near the end
of the uninstallation. The error dialog indicates that the Windows Installer service could not be accessed.

To perform an uninstallation from the command line, the current recommended method is to use one of the following:

msiexec.exe /i {ProductCode} REMOVE=ALL

msiexec.exe /x {ProductCode} /qn

Neither of these examples triggers the Windows Installer error.

542 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Recommendations
For new-style InstallScript MSI installations, the UI functionality may be run without administrator privileges. Therefore,
the following points are recommended (and, in general, also apply to all Windows Installer–based installations):

• Do not assume that administrator privileges will be available from any InstallScript events.

• Any system changes that need to be made should be done with custom actions in the Installation Execute sequence.
InstallScript custom actions can be used. To ensure that sufficient privileges are available, custom actions should
have an in-script execution setting of deferred in system context.

• Custom actions that modify the system should have corresponding rollback actions that restore the system to its
earlier state if the installation fails.

• Custom actions that modify the system should also have corresponding actions that run during uninstallation to
remove the installed items from the system.

• If changes are made to the system from InstallScript events, the changes are not logged by the InstallScript engine and
would need additional script code to clean up these resources during uninstallation.

Using InstallScript to Differentiate Between the Two Styles at Run Time

You can use the INSTALLSCRIPTMSIEEUI variable to write a single script that produces different run-time behavior for the
different UI styles. To learn more, see INSTALLSCRIPTMSIEEUI.

See Also
Event Handlers
Installation Sequence
User Interface Sequence
Execute Sequence
MsiDoAction (Windows Installer Help Library)
MsiDoAction (Windows Installer Help Library)
MsiGetTargetPath (Windows Installer Help Library)
MsiGetTargetPath (Windows Installer Help Library)
MsiSetTargetPath (Windows Installer Help Library)
MsiSetTargetPath (Windows Installer Help Library)

Specifying the InstallScript User Interface Type for InstallScript MSI Installations
InstallShield 2020

Project • This information applies to InstallScript MSI projects.

In InstallScript MSI projects, you have the choice of two different types of InstallScript user interface (UI). For detailed
information about these two styles, including any limitations, see Using the InstallScript Engine as an External vs.
Embedded UI Handler for InstallScript MSI Installations.

Task To specify the InstallScript user interface type for an InstallScript MSI project:

1. In the View List under Installation Information, click General Information.

2. For the InstallScript User Interface Type setting, select the appropriate option.

InstallShield 2020 User Guide ISP-2600-UG00 543

Chapter 4
Specifying Installation Information

• Traditional Style (Requires Setup.exe)—If you want to use the InstallScript engine as an external UI handler for
your InstallScript MSI installation, select this option. With this style, your installation must include a Setup.exe
setup launcher. The setup launcher serves as a bootstrap application that initiates the InstallScript engine to
display the UI and run the InstallScript code, and the Windows Installer to run the Execute sequence of the .msi
package.

This is the default option for this setting.

• New Style (Requires Windows Installer 4.5)—If you want to use the InstallScript engine as an embedded UI
handler for your InstallScript MSI installation, select this option. With this style, InstallShield embeds the
InstallScript engine within the .msi package. The Windows Installer calls the InstallScript engine to display the UI.
The Windows Installer also runs the Execute sequence of the .msi package.

This option requires Windows Installer 4.5 on the target machine. This option also has some limitations that
require careful planning if you decide to use this style.

See Also
General Information View

Entering Summary Information Stream Data

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Some of the Summary Information Stream settings are available in DIM projects. In this project type, the values in these
settings are not displayed or used at run time. You can use these settings in this project type as a reference for internally
identifying the project.

Windows Installer databases (.msi and .msm files) are implemented as COM structured storage, and COM structured
storage files usually contain a Summary Information Stream. The Summary Information Stream contains information
about your company and the software being installed. For more information, see Accessing the Summary Information
Stream Panel to learn how to view your file’s summary information.

For a description of each Summary Information Stream setting, see General Information View.

See Also
Setting Summary Information Stream Properties
Using the Template Summary Property
Accessing the Summary Information Stream Panel

544 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Accessing the Summary Information Stream Panel

InstallShield 2020

Task To access summary information for an .msi or .msm file:

1. Right-click the .msi file or .msm file and click Properties. The Properties dialog box opens.

2. Click the Summary tab to view the summary information.

Tip • The General Information view is where you populate the information for the Properties dialog box for your installation.

See Also
Setting Summary Information Stream Properties
Entering Summary Information Stream Data

Setting Summary Information Stream Properties

InstallShield 2020

Task To specify summary information for the project:

1. In the View List under Installation Information, click General Information.

2. Find the Summary Information Stream area of the view.

3. Modify the values of the settings as needed.

Setting the Summary Information Stream Comments at Build Time

You also have the option of entering comments at build time. You can use the SummaryInfoComments parameter of
MSBuild.exe task to set the Summary Information Stream comments at build time, such as including the build number,
as shown in the following example:

MSBuild.exe c:\installers\Setup.sln /Property:SummaryInfoComments="Insert Comments Here"

See Also
General Information View

Using the Template Summary Property

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 545

Chapter 4
Specifying Installation Information

• Merge Module
• MSI Database
• MSM Database
• Transform

You can use the Template Summary setting in the General Information view to essentially establish conditions for
processor type and language; if a target system does not meet these requirements, the installer displays an error message
and exits the installation.

Tip • You can also set the Template Summary setting for a product configuration in the Releases view. Any value entered in
the Releases view overrides the value set in the General Information view.

Syntax
List the processor type first, followed by your installation’s default language. For language, enter any four-digit language ID
or 0 (zero) for language neutral.

• Separate the two categories with a semicolon.

• If your installation supports multiple products and you want to have multiple entries in the language category—for
example, 1033 for English and 1031 for German—separate them with a comma.

Caution • If your installation targets 64-bit machines, do not enter both Intel and Intel64 in this field. Doing so causes your
installation to fail. Also, if you enter Intel64, your installation will not run on 32-bit operating systems.

Valid processor values include:

• Intel

• Intel64

• x64

Setting Conditions Based on Processor Type and Language

If your installation runs only on Intel processors and English-based systems, use the following syntax in the Template
Summary property:

Intel;1033

If the processor-type condition fails, the installer displays an error message and then exits.

If your product runs on x64 processors and supports English and German, enter the following:

x64;1033,1031

To specify that the package is language-independent, you can use the syntax Intel; or Intel;0.

Setting Conditions Based on Language Only

To put a condition on the language only, start the entry with a semicolon and specify your setup’s default language:

;1036

546 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Leaving the first portion empty indicates that the target processor is Intel. If a language is not specified, InstallShield
provides the release languages in the Summary Information Stream.

See Also
Targeting 64-Bit Operating Systems
Selecting the Appropriate Type of Architecture Validation for Builds
General Information View
Setting Product Conditions
Template Summary Property (Windows Installer Help Library)
Template Summary Property (Windows Installer Help Library)

Configuring Add or Remove Programs Information

InstallShield 2020

The settings in the Add or Remove Programs area of the General Information view describe the information that appears in
Add or Remove Programs tool in the Control Panel.

If you have not entered a value for a particular Add or Remove Programs setting, a sample value appears in grey text. This
value is meant to serve as an example and is not included in the final Windows Installer database.

The General Information view enables you to set much of the information that is displayed to the end user through Add or
Remove Programs.

Project • In Basic MSI and InstallScript MSI projects—Most of the values that you specify are stored in Windows Installer
properties with names beginning with ARP, such as ARPPRODUCTICON or ARPHELPLINK. One exception to this is the Publisher
setting. This value should be set with your company name and is stored in the Manufacturer property.

In a Basic MSI project—To prevent your product from appearing in the Add or Remove Programs, you can set the Windows
Installer property ARPSYSTEMCOMPONENT to 1 in the Property Manager. Note that setting this property simply suppresses the
display of your product in Add or Remove Programs. An end user can still remove your product by running the installation in
maintenance mode or from the command line.

In an InstallScript MSI project—To prevent your product from appearing in the Add or Remove Programs, select Yes for the
Hide Add/Remove Panel Entry setting in the Releases view.

See Also
Requirements for the Windows Logo Program
General Information View

Specifying a Readme File

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript

InstallShield 2020 User Guide ISP-2600-UG00 547

Chapter 4
Specifying Installation Information

• InstallScript MSI
• InstallScript Object
• MSI Database
• Suite/Advanced UI
• Transform

In the Read Me setting in the General Information view, enter the name of the Readme file for your product. On some
versions of Windows, this information is displayed on the Support Info dialog box for your product’s entry in Add or
Remove Programs. Alternatively, you can link to a Readme file located on the Internet by specifying a valid URL.

Project • In a Windows Installer–based project (Basic MSI or InstallScript MSI project), special formatting is required to
properly display a path when the Readme file is installed as part of your installation; see the following section. In an
InstallScript or InstallScript Object project, enter a hard-coded path or a URL, or specify a path relative to a system variable
enclosed by angle brackets, for example, <TARGETDIR>\Readme.txt. This data is written to the target system’s registry by the
default OnMoveData event handler.

Displaying the Readme File Path in Basic MSI and InstallScript MSI Projects
You can enter a hard-coded path or a URL for the Readme file. However, the name of a folder, such as [MyDirectory], or of
a component, such as [$MyComponent], is not resolved. That means that the Readme value in the Support Information
dialog box would be displayed as [INSTALLDIR]Readme.txt or [$MyComp]Readme.htm. The path is not resolved because
this property is merely setting the initial value of the Windows Installer property ARPREADME, and formatted strings are
never resolved for Windows Installer properties.

InstallShield’s solution is to use a custom action to set ARPREADME with the value that you enter in the Read Me setting. By
setting it with the SetARPReadme custom action, the path is resolved during the installation. For example, Readme.doc
might be a file in the component Help_Files. In this case, enter [$Help_Files]Readme.doc for the Read Me setting.
Assuming Help_Files is installed to C:\Program Files\MyCompany\MyProduct\Help, the path that would be displayed in
Add or Remove Programs on the target system would be C:\Program Files\MyCompany\MyProduct\Help\Readme.doc.

Instead of the component name, you can use the file key. Do not use a folder from the Directory table because it will not
be resolved at run time. The file key is not as reliable as the component name, because it is subject to change if the files are
dynamically linked or the release uses patch optimization. Continuing the example above, if Readme.doc has a file key of
F501_Readme.doc, enter [#F501_Readme.doc] for the Read Me setting. If it is installed to the same folder, Add or Remove
Programs displays the following path on the target system:

C:\Program Files\MyCompany\MyProduct\Help\Readme.doc

The custom action SetARPReadme is added every time that the Read Me setting in the General Information view contains a
string and the Installation Execute sequence contains the CostFinalize action. SetARPReadme is inserted into the
Installation Execute and User Interface sequences directly after CostFinalize.

See Also
General Information View

548 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

Including a Software Identification Tag for Your Product

InstallShield 2020

Project • This information applies to Basic MSI projects.

ISO/IEC 19770-2 is an international standard for the creation of software identification tags. A software identification tag is
a small XML-based file that contains descriptive information about the software, such as the product name, product
edition, product version, and publisher. Software asset management tools collect the data in the tags to provide accurate
application identification for software that is installed in an enterprise.

Software identification tagging is evolving as an industry standard, enabling independent software vendors to create
smarter applications that give their customers better information for software asset management and license optimization
initiatives. Including the identification tag in your product’s installation makes it possible for your customers to use tools
that can monitor their internal usage of your product, allowing them to understand, manage, and optimize the number of
licenses of your product that they obtain from you.

Proper tag creation requires that you configure standard General Information settings such as Product Name and Product
Version. It also requires that you configure a few identification-specific settings, which are also in the General Information
view.

Task To include a software identification tag in your installation:

1. In the View List under Installation Information, click General Information.

2. In the Software Identification Tag area of the view, modify the values of the settings as needed.

The Use Software Identification Tag setting lets you specify whether you want to include a tag in your installation.
Select Yes, which is the default value, and then configure the other settings in the Software Identification Tag area
as needed.

When you use tagging in your project, InstallShield adds the tag to two new components that it creates, and it associates
the components with one of your project’s features. The components are:

• ISO19770_LocalTag, which has a destination of INSTALLDIR

• ISO19770_SystemTag, which has a destination of CommonAppDataFolder

Use the Setup Design view if you want to associate these components with a different feature in your project. For more
information, see Component-Feature Associations.

At build time, if the following conditions are true, InstallShield includes the software identification tag with the installation
that it builds:

• Yes, the default value, is selected for the Use Software Identification Tag setting in the General Information view.

• The Unique ID, Tag Creator, and Tag Creator ID settings in the General Information view have values.

Note that if tagging is enabled but you have not entered values in one or more of the three aforementioned tag
identification settings, InstallShield generates a build warning to inform you that the tag could not be included in your
release. To resolve this warning, configure the settings in the Software Identification Tag area of the General Information
view as needed.

InstallShield 2020 User Guide ISP-2600-UG00 549

Chapter 4
Specifying Installation Information

If you configure your project to include a software identification tag and you also configure the release in the Releases view
to use a .pfx file to digitally sign your release, InstallShield digitally signs the tag at build time. Note that the .NET
Framework 3.5 must be installed on your build machine in order to sign a tag file.

See Also
General Information View Settings

Including Microsoft System Center Configuration Manager

Application Model Data About Your Product
InstallShield 2020

Project • This information applies to Basic MSI projects.

Microsoft System Center 2012 Configuration Manager is a solution that helps IT administrators manage and deploy
applications to users throughout an enterprise. It takes a user-centric approach to application delivery, allowing IT
administrators to define each application so that it can be deployed to users on a variety of devices in the most appropriate
format, with the required application dependencies.

Accurate identification of deployment metadata is necessary for migrating applications into the Configuration Manager
application model. InstallShield includes the ability to specify some of the application model metadata for an application
through a software identification tag. When AdminStudio users import a package into the AdminStudio Application
Catalog, AdminStudio Application Manager mines package elements for deployment data such as detection methods,
dependencies, requirements, as well as information in the software identification tag. AdminStudio makes this information
available to users for review and tests before publishing to Microsoft System Center 2012 Configuration Manager.

Task To include application model data for System Center Configuration Manager in your installation:

1. Ensure that you are including a software identification tag in your project. For more information, see Including a
Software Identification Tag for Your Product.

2. In the View List under Installation Information, click General Information.

3. In the Add SCCM App Model Data setting, select Yes.

4. Configure the subsettings under the Add SCCM App Model Data setting as needed. For more information, see General
Information View Settings.

When you include tagging and application model data in your project, InstallShield adds the tag with the application
model data to two new components that it creates, and it associates the components with one of your project’s features.
The components are:

• ISO19770_LocalTag, which has a destination of INSTALLDIR

• ISO19770_SystemTag, which has a destination of CommonAppDataFolder

Use the Setup Design view if you want to associate these components with a different feature in your project. For more
information, see Component-Feature Associations.

At build time, if the following conditions are true, InstallShield includes the software identification tag with the installation
that it builds; it also includes the application model data in the tag:

550 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Specifying Installation Information

• Yes, the default value, is selected for the Use Software Identification Tag setting in the General Information view.

• The Unique ID, Tag Creator, and Tag Creator ID settings in the General Information view have values.

• Yes is selected for the Add SCCM App Model Data setting in the General Information view.

If you configure your project to include a software identification tag and you also configure the release in the Releases view
to use a .pfx file to digitally sign your release, InstallShield digitally signs the tag at build time. Note that the .NET
Framework 2.0 or later must be installed on your build machine in order to sign a tag file.

See Also
General Information View

InstallShield 2020 User Guide ISP-2600-UG00 551

Chapter 4
Specifying Installation Information

552 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Organizing Files for Your Installation

InstallShield 2020

The primary task of an installation is to transfer files from your distribution media to your end user’s hard drive. In an
InstallShield installation, files are organized in a hierarchy: files are included in components; components are associated
with features (and optionally subfeatures); and, in InstallScript and InstallScript MSI installations, features are associated
with setup types.

At run time, your end user simply selects the setup type—or, if you allow it, the features and subfeatures—that he or she
wishes to install. End users do not see components, which you use to group your files according to their type and purpose.
For example, files that are installed to the same target folder can be placed in the same component, as can self-registering
files.

A file often relies on functions in other files to perform a task. However, you may not be aware of all these other files—
known as dependencies—when you include your application’s files in your project. To help you identify dependencies,
InstallShield offers three dependency scanners that automatically add these files to your project.

In addition to including individual files in your project, you can also include redistributables (InstallShield prerequisites,
merge modules, and objects), which contain logic and files needed to install distinct pieces of functionality. For example,
to include the Java Runtime Environment (JRE) files in your installation, you can add the InstallShield prerequisite for JRE
to your installation project.

See Also
Files and Folders View
Components View
Features View
Setup Types View
Dependency Scanners
Redistributables View
DIM References View

Designing Installations
InstallShield 2020

There are two main perspectives in an installation project—that of the developer and that of the end user. In InstallShield,
these perspectives are addressed in detail in the Components and Features views, respectively.

Components
Components represent the developer’s view of the product. They are installation authoring tools that help the developer
organize similar application data—such as files, registry entries, and shortcuts—into logical groups.

To enable the end user to choose which features to install, you should divide your application into components that
correspond with the features of your application.

Using InstallShield, you can also publish your project’s components.

Note • The conditions that you specify for the Publish Components, Publish Features, or Publish Product actions are not
validated during design time, so use proper syntax and check to ensure that the condition produces the expected outcome.

InstallShield 2020 User Guide ISP-2600-UG00 553

Chapter 4
Organizing Files for Your Installation

Features
Features are the building blocks of an application from the end user’s perspective. Each feature represents a specific piece
of functionality for your product—such as the help files. End users should be able to install and uninstall discrete features
of your product.

For example, an end user with limited hard drive space could elect not to install a product tutorial. If the user subsequently
purchases another computer or frees resources on an existing one, the previously uninstalled product tutorial could then
be installed.

You should separate your application into features that correspond to the components of your application.

See Also
Components View
Features View

Separating Applications into Components

InstallShield 2020

Use the following guidelines to separate an application into components.

• Identify resources that function as a group; each group can be a component.

• Windows Installer requires that every file in a component be installed to the same directory. If you need to install a
directory structure, each subdirectory must correspond to a separate component.

• The resources in a component should require the same conditions.

• To take full advantage of Windows Installer repair functionality, each .exe, .dll, and .ocx file should be placed in its own
component, and each should be the component’s key file. The Best Practices option of the Component Wizard can
create components for you using this rule.

• Similarly, each .chm or .hlp file should be placed in its own component, along with any corresponding .chi or .cnt file.

• No resource should be included in more than one component, even across products. If a component’s resources are
required by more than one product, consider creating a merge module with the shared resources.

• When mapping a component to one or more features, ensure that all parts of a component map to the features.

• When testing your installation, you may want to divide your application into several components to thoroughly
measure its performance.

See Also
Setting Component Key Files

Separating Applications into Features

InstallShield 2020

Use the following guidelines to separate an application into features.

• Separate your application into independent parts, such as help, clip art, and program files. This gives the end user
combination options when installing your application. For instance, if your application contains a large, graphic-
intensive clip art file, you could make the clip art file a feature. This gives the end user the option of installing or not
installing the file—a vital ability for users with limited available resources.

554 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• In separating your application into features, ensure that end users can recombine the parts in several ways to fulfill
specific needs. When doing this, consider the needs of all users, from system administrator to customer service
representative to developer and everyone in between. By addressing all groups of users, you are promoting increased
distribution and usage of your application.

• Each feature should have one function—such as help files—and should be clearly defined according to this
functionality to facilitate recognition and comprehension. Features should possess an independent functionality,
such that users can install and use the feature by itself, if they so choose.

• If one feature requires another, make the dependent feature a child of the other.

• To eliminate confusion, keep any information pertaining to the management of the system or application transparent
to the user.

Using Path Variables

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

Traditionally, to link to source files in an installation project, you would need to create a reference to that file using a hard-
coded path. For example, you might have a source file called Program.exe located at C:\Work\Files that you want to
include in your installation. However, if you used hard-coded paths, you needed to enter the entire path every time that
you want to associate a source file from that directory. If you moved the file to another directory, you needed to change the
hard-coded path as it appears in your installation project. If your installation consisted of a small number of source files,
this might not have been a problem. Unfortunately, some installations contain thousands of files that all would need to be
remapped if you change the folder structure or migrate the project to a different machine.

With path variables, you can define commonly used paths in a central location so that you do not need to change every
source file’s path each time you move the project or change the directory structure.

All path variables can be viewed and modified in the Path Variables view. You can use path variables in almost any location
in InstallShield where you link to source files, such as in the Dialog Editor, dynamic file links, and the release location.
Instead of entering the path variables yourself, you can have InstallShield recommend them whenever you browse to a
path. To have InstallShield automatically recommend path variables, select the Always display the Path Variable
Recommendation dialog to me option on the Path Variables tab of the Options dialog box.

InstallShield 2020 User Guide ISP-2600-UG00 555

Chapter 4
Organizing Files for Your Installation

Note • Path variables are used during the development of your installation project. These paths do not apply to the target
machines where the application is being installed. Rather, they are used to link to source files for your installation project.
When the project is built, those links are evaluated and the files they point to will be built into the installation.

See Also
Path Variables View
Path Variables Tab (on the Options dialog box)

Types of Path Variables

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

InstallShield includes support for several types of path variables:

• Predefined Path Variables

• Standard Path Variables

• Registry Path Variables

• Environment Path Variables

Predefined path variables define standard Windows directories; this type of variable cannot be renamed or modified. The
standard, registry, and environment types of path variables are custom variables that you can create and define as needed.

See Also
Path Variables View
Path Variables Tab (on the Options dialog box)

Predefined Path Variables

InstallShield 2020

Project • This information applies to the following project types:

556 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

Predefined path variables are variables that are set to certain standard Windows directories. These variables cannot be
renamed or modified, but they can be used in your installation project to point to predefined directories. Following is a list
of predefined path variables, their typical values, and the corresponding InstallScript path variables. (In an InstallScript
project, InstallScript path variables are used in InstallShield, for example, as options in the list for the Destination property
of a component. InstallScript path variables also correspond to system variables that can be used in the installation script.)

Table 4-1 • Predefined Path Variables

InstallScript Path
Predefined Path Variable Value Variable

<CommonFilesFolder> C:\Program Files\Common Files\ <COMMONFILES>

<ISProductFolder> C:\Program Files\InstallShield\2020

<ISProjectDataFolder> <ISProjectFolder>\ProjectName <ISPROJECTDIR>

<ISProjectFolder> C:\InstallShield 2020 Projects\

<ISRedistPlatformDependentExpressFolder> C:\Program
Files\InstallShield\2020\Redist\Language
Independent\i386 Express

<ISRedistPlatformDependentFolder> C:\Program
Files\InstallShield\2020\Redist\Language
Independent\i386

<ProgramFilesFolder> C:\Program Files\ <PROGRAMFILES>

<SystemFolder> C:\Windows\System32\ <WINSYSDIR>

<VSSolutionFolder> Varies. This variable references a higher-level base

directory. This support enables you to have in your
InstallShield projects static links to files in sibling
projects that are within the Visual Studio solution
folder. To learn more, see Using the
VSSolutionFolder Path Variable with Visual Studio
Solutions.

<WindowsFolder> C:\Windows\ <WINDIR>

InstallShield 2020 User Guide ISP-2600-UG00 557

Chapter 4
Organizing Files for Your Installation

Using Predefined Path Variables

Project • Windows Installer based projects only: The Path Variable Recommendation dialog box enables you to specify
whether you want to use predefined path variables. This dialog box is launched if you enter a hard-coded path when inserting
a source file into your installation and you have selected the Always display the Path Variable Recommendation dialog to me
check box on the Path Variables tab of the Options dialog box. If you enter a path that is included in a predefined path variable,
InstallShield suggests that you use the path variable rather than the hard-coded path.

You can also use predefined path variables when defining the value for a standard path variable. You may want to define a
standard path variable to a subfolder of a predefined variable. For example, <ProgramFilesFolder>\InstallShield could
be used as the value for a standard path variable.

Predefined path variables are smart variables. This means they are set to the correct directory, even if your Windows
directory is located on your D drive instead of your C drive. If you change the default project location on the File Locations
tab of the Options dialog box, InstallShield updates this variable to reflect the new directory.

See Also
Path Variables View

Standard Path Variables

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

Standard path variables are sometimes referred to as user-defined variables. These variable types are native to
InstallShield. That is, they do not rely upon outside resources, as do registry or environment variables.

Using Standard Path Variables

Once you have created a standard path variable, you can use it every time you add a source file to your project. For
example, you might create a variable called <MyFiles> and have it pointing to C:\Work\Files. If you add a source file to
your project that contains that variable’s path in its destination, it is recommended that you use the variable rather than
hard-coding the path. This recommendation is displayed in the Path Variable Recommendation dialog box.

To have InstallShield automatically recommend path variables, select the Always display the Path Variable
Recommendation dialog to me option on the Path Variables tab of the Options dialog box.

558 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Tip • To override the value of a user-defined path variable, an environment variable, or a registry value for a particular
release at build time, use the Path Variable Overrides setting on the Build tab for that release. To learn more, see Overriding
the Value of a Custom Path Variable for a Release.

See Also
Path Variables View

Registry Path Variables

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

Registry path variables enable you to define your own variables based on the default value of a specified registry key.

Once you have created a registry path variable, you can use it every time that you add a source file to your project. When
you add a file to a component from a folder that contains the value of MyRegVar, it is recommended that you use the
variable rather than hard-coding the path. This recommendation is displayed in the Path Variable Recommendation dialog
box.

To have InstallShield automatically recommend path variables, select the Always display the Path Variable
Recommendation dialog to me option on the Path Variables tab of the Options dialog box.

Tip • To override the value of a user-defined path variable, an environment variable, or a registry value for a particular
release at build time, use the Path Variable Overrides setting on the Build tab for that release. To learn more, see Overriding
the Value of a Custom Path Variable for a Release.

See Also
Path Variables View

InstallShield 2020 User Guide ISP-2600-UG00 559

Chapter 4
Organizing Files for Your Installation

Environment Path Variables

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

Environment path variables enable you to define your own path variables based on certain values on the Environment
dialog box.

Task To view the Environment dialog box:

1. Right-click My Computer and click Properties. The System Properties dialog box opens.

2. On the Advanced tab, click Environment Variables.

A common scenario where environment path variables may be useful is when performing a build from the command line. If
you do nightly builds on a machine dedicated to that purpose, you may need to change the path variables from the
command line. As long as you use environment path variables, you can define the paths to your project’s files from either a
batch file or the command line. These paths are evaluated when the installation project is built, and the correct paths to
the files will be used.

Using Environment Path Variables

After you have created an environment path variable, you can use it every time that you add a source file to your project.
For example, you might create a variable called <MyFiles> and have it point to C:\Work\Files. If you add a source file to
your project that contains that variable’s path in its destination, it is recommended that you use the variable rather than
hard-coding the path. This recommendation is displayed in the Path Variable Recommendation dialog box.

To have InstallShield automatically recommend path variables, select the Always display the Path Variable
Recommendation dialog to me option on the Path Variables tab of the Options dialog box.

Tip • To override the value of a user-defined path variable, an environment variable, or a registry value for a particular
release at build time, use the Path Variable Overrides setting on the Build tab for that release. To learn more, see Overriding
the Value of a Custom Path Variable for a Release.

See Also
Path Variables View

560 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Creating and Defining a Custom Path Variable

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

The Path Variables view is where you create and define standard path variables, environment path variables, and registry
path variables.

Task To create and define a path variable:

1. Do one of the following:

• In QuickPatch projects: In the View List under Patch Settings, click Path Variables.

• In all other project types: In the View List under Media, click Path Variables.

2. Do one of the following:

• To create a standard path variable, click the New Path Variable button.

• To create an environment variable, click the arrow next to the New Path Variable button, and then click
Environment.

• To create a registry variable, click the arrow next to the New Path Variable button, and then click Registry.

InstallShield adds a new row at the bottom of the view.

3. Complete each of the settings in the new row as needed.

For descriptions of each column, see Path Variables View.

Tip • To override the value of a user-defined path variable, an environment variable, or a registry value for a particular
release at build time, use the Path Variable Overrides setting on the Build tab for that release. To learn more, see Build Tab for
a Release.

See Also
Standard Path Variables
Registry Path Variables
Environment Path Variables

InstallShield 2020 User Guide ISP-2600-UG00 561

Chapter 4
Organizing Files for Your Installation

Overriding the Value of a Custom Path Variable for a Release

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

InstallShield lets you override the values of your project’s standard path variables, environment path variables, and
registry path variables for each release in your project. This functionality enables you to essentially replace certain files and
folders in your project with others at build time, depending on the particular release that you are building.

For example, in a Basic MSI project, you could use this functionality to swap out the custom action DLL files—a 32-bit
version for your project’s 32-bit release, and a 64-bit version for your project’s 64-bit release. Or perhaps for a Suite/
Advanced UI project, you might want to use this functionality to swap out UI elements such as images and EULAs for
different releases in your project; this would enable you to easily generate installations for different editions or branded
versions of your product.

Task To override the value of a custom path variable for a release:

1. In the View List under Media, click Releases.

2. In the Releases explorer, select the release that you want to configure.

3. On the Build tab, in the Path Variable Overrides setting, click the ellipsis setting (...). The Path Variable Overrides
dialog box opens.

The Path Variable Overrides dialog box shows check boxes for the path variables, environment path variables, and
registry path variables that are configured in the Path Variables view. Note that it does not include check boxes for any
predefined path variables, or for path variables that are already overridden for the same release in the Releases view.

4. Select the check box of each path variable that you would like to override for the selected release.

5. Click OK. InstallShield closes the dialog box. Under the Path Variable Overrides setting, InstallShield adds a new
subsetting for each path variable that you selected.

6. For each path variable subsetting, specify the appropriate new value.

At build time, InstallShield uses the new values that you specified in the Releases view to override the default values that
are set in the Path Variables view.

Additional Methods for Overriding Path Variables

As an alternative to overriding a path variable in the Releases view, you can override a path variable in the following ways:

562 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• If you are building from the command line with IsCmdBld.exe, use the -l parameter to specify a path variable and a
new value.

• If you are building through MSBuild or Team Foundation Server (TFS), use the PathVariables parameter on the
InstallShield task. This parameter is exposed as the ItemGroup InstallShieldPathVariableOverrides when the default
targets file is used.

Note those methods take precedence over any value that you set in the Path Variable Overrides setting in the Releases
view.

See Also
Overriding Path Variables in a DIM Project for Use in an Installation Project
Targeting 64-Bit Operating Systems
Path Variable Overrides Dialog Box
Path Variables View

Converting Absolute Path References in Your Project to Path Variables

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

You might not need to use path variables when you begin your installation project, but you may realize the benefits they
provide well after you have started. Rather than going through each file link and changing it to a path variable, you can use
the Converting Source Paths Wizard.

This wizard scans your project for static links and converts them all to path variables. If any of your static links can be
replaced with existing path variables, the wizard does this automatically. For all other links, the wizard provides a list of the
possible variables. After you choose the variables that you want to use, the wizard converts all of the links.

Task To launch the Convert Source Paths Wizard:

On the Project menu, click Convert Source Paths.

See Also
Convert Source Paths Wizard

InstallShield 2020 User Guide ISP-2600-UG00 563

Chapter 4
Organizing Files for Your Installation

Deleting a Path Variable

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• QuickPatch
• Suite/Advanced UI

Task To remove a path variable from your project:

1. Do one of the following:

• In QuickPatch projects: In the View List under Patch Settings, click Path Variables.

• In all other project types: In the View List under Media, click Path Variables.

2. Select one or more path variables that you want to delete.

To select multiple consecutive path variables, select the first path variable, press and hold SHIFT, and select the last
path variable. To select multiple nonconsecutive path variables, select the first path variable, press and hold CTRL,
and select each additional path variable.

3. Click the Delete Selected Path Variables button.

See Also
Path Variables View

Including Files and Folders

InstallShield 2020

Your files, the core of your product, are also the core of your installation. Files are added to a project only at the component
level. In installation projects, components are associated with features, which are what end users see when they run your
installation. If the component’s feature is selected for installation, the component’s files are installed to the target system.

When you are adding files to components in Windows Installer–based projects, you should be aware of Setup Best
Practices. By default, the Setup Best Practices Wizard monitors your setup design and alerts you if you have violated Best
Practices.

You can add files to your project in the Setup Design view (for installation projects) or the Components view, and in the
Files and Folders view.

564 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

See Also
Files and Folders View
Setting Component Key Files
Specifying Hard-Coded Destination Directories
Adding Files to Components
Tips for Managing Files and Folders in Your Project

Adding to Your Project Files to Be Installed on Target Systems

InstallShield 2020

You can use the Files and Folders view to add files to your project.

Task To add a file to your project:

1. In the View list under Application Data, click Files and Folders.

2. In the View Filter list, select the feature that should contain the file that you want to add.

3. Windows Installer–based projects only: In the Destination computer’s folders pane, right-click Destination
Computer, point to Show Predefined Folder, and then click the predefined folder that you want to use.

4. In the Destination computer’s folders pane, click the folder into which you want to place the file.

5. In the Source computer’s folders pane, navigate to the folder containing the file you want to add.

INSTALLDIR (for Windows Installer–based projects) or Application Target Folder (for InstallScript projects) is the most
commonly used target location, because this is the default root directory for your application’s files.

6. Select and drag the file you want to add from the Source computer’s files pane to the Destination computer’s files
pane.

Tip • You can specify how INSTALLDIR is displayed in the Destination computer’s folders pane of the Files and Folders view by
setting your preference on the Directory tab of the Options dialog box.

You can also specify a hard-coded destination directory.

The Destination computer’s folders pane contains a list of predefined destinations. You can add a file to either a predefined
destination or to a destination that you create.

Automatically Creating New Components When You Add Files

InstallShield can create new components to properly handle the new files as you add them to your project. To
accommodate this, use the View Filter in this view to select the feature with which you want to associate any newly created
components.

If no features exist, you have the option of creating one when you first add files in this view.

InstallShield 2020 User Guide ISP-2600-UG00 565

Chapter 4
Organizing Files for Your Installation

Project-Specific Differences for Automatic New Component Creation

In a Windows Installer–based project, InstallShield creates components according to Setup Best Practices. For example, all
portable executable files (.exe, .dll, .ocx files) are given their own component. All other files are added to the default
component for each destination directory. However, if you drag files directly to one of the components listed under a
destination folder, the Setup Best Practices rules are ignored.

In an InstallScript project, InstallShield creates components based on the file types—for example, all self-registering files
are contained in one component, all non-self-registering files in another component, and all .NET files in a different
component. The components appear as subfolders in the Files and Folders view.

Changing the Component/Feature Relationship

You can change the component/feature relationship by right-clicking a component in the Destination computer’s folders
pane and then clicking Properties. On the Properties dialog box, use the Features tab to make the necessary changes.

Tip • To display components in the Files and Folders view, right-click a destination folder (in the lower-left pane of the view)
and click Show Components.

See Also
Files and Folders View
Adding Files to Components
Setting Component Key Files
Specifying Hard-Coded Destination Directories
Setup Best Practices
Tips for Managing Files and Folders in Your Project

Dragging and Dropping Files Using the Context Menu

InstallShield 2020

The files explorer in the Files and Folders view enables you to drag and drop folders from your source computer to
destinations on the target system. You have a number of options when you drag files from the Source computer’s folders
pane to the Destination computer’s folders pane.

Tip • When you are using InstallShield on a 64-bit system and you want to add to your project a system file whose source
location is the 64-bit System folder (System32) on your development machine, it is not possible to drag the file from one of the
source computer panes at the top of the Files and Folders view to the appropriate location in one of the destination computer
panes. To learn more, see Adding Files from Your 64-Bit Source Machine’s 64-Bit System32 Folder.

Task To display the context menu:

1. In the View list under Application Data, click Files and Folders.

2. In the Source computer’s folders pane or the Source computer’s files pane, right-click a folder or file and drag it to
the Destination computer’s folders pane or the Destination computer’s files pane. Then release the mouse button.

If the predefined folder to which you adding the folder or file is not displayed in the Destination computer’s folders
pane, you can add it. To learn how, see Displaying Predefined Folders in the Files View.

566 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

InstallShield displays a context menu that contains several commands.

Table 4-2 • Commands that Are Available on the Context Menu in the Files and Folders View

Command Description

Add Adds the folder, subfolders, and/or files selected. This is the same as the default
drag-and-drop behavior.

Add Preserving Source Structure Adds the selected folder, subfolders, and/or files while preserving the file/folder
structure found on the source computer.

This command is available only if the source folder matches a predefined

Windows destination folder. In addition, the destination on which you drop the
file or folder must be the Destination Computer.

Add Folder(s) Only Adds only the folders selected and any subfolders contained in the selected
folder. Does not add any files contained within the selected folders or subfolders.

Add Folder(s) Only Preserving Adds only the folders selected and any subfolders contained in the selected
Source Structure folder. Does not add any files contained within the selected folders or subfolders.
This option also preserves the folder structure found on the source computer.

This option is available only if the source folder matches a predefined Windows
destination folder. In addition, the destination on which you drop the file or folder
must be the Destination Computer.

Cancel Ends the drag-and-drop operation without making any changes.

Adding Files from Your 64-Bit Source Machine’s 64-Bit System32 Folder
InstallShield 2020

On 64-bit systems, the System32 folder is reserved for 64-bit applications. When you try to view your development
machine’s 64-bit System folder from within the Files and Folders view in InstallShield, Windows redirects the view to
instead display the SysWOW64 folder—the 32-bit version of the folder. Thus, when you are using InstallShield on a 64-bit
system and you want to add to your project a system file whose source location is the 64-bit System folder (System32) on
your development machine, it is not possible to drag the file from one of the source computer panes at the top of the Files
and Folders view to the appropriate location in one of the destination computer panes.

To work around the redirection and add a 64-bit System32 file on your development machine to your InstallShield project,
you can browse to the Sysnative folder on your machine and then select the appropriate file for your project. The following
instructions explain how.

Caution • Note that in many cases, including system files in an installation is not recommended, since the system folder is
protected by Windows. In these cases, the preferred way to deliver and update system files is to use a Microsoft redistributable,
if one is available for the technology, or to have end users obtain the updates through Windows Update.

InstallShield 2020 User Guide ISP-2600-UG00 567

Chapter 4
Organizing Files for Your Installation

Task To add to your project a file in the 64-bit System32 folder of a development system that has 64-bit Windows:

1. In the View list under Application Data, click Files and Folders.

2. In the Destination computer’s folders pane, click the folder into which you want to place the file.

3. Right-click in the Destination computer’s folders pane, and then click Add File. The Open dialog box opens.

4. Specify the following path (but replace the drive letter with the applicable drive letter if appropriate):

C:\Windows\Sysnative

5. Select the appropriate file that you want to add to your project, and then click the Open button.

InstallShield adds the file to your project. InstallShield uses the Sysnative folder as part of the path for the source file that
you added. WOW64 sees the Sysnative folder as a special alias; the file system does not redirect access away from this
folder.

Tip • Note that you can also add 64-bit System32 files through the Components view or the Setup Design view: in these views,
expand the node of the component that you want to contain the 64-bit System32 file. Select the Files node under that
component. Then, right-click the Files pane on the right, and then click Add File. Specify the C:\Windows\Sysnative path, as
described in the aforementioned procedure.

Availability of Sysnative Folder Support on Windows-Based Systems

Use of the Sysnative folder is not supported on 32-bit machines. If you use the Sysnative folder in an InstallShield project
on a 64-bit system but then you try to build a release in that InstallShield project on a 32-bit system, InstallShield generates
one or more build errors or warnings informing you that it could not find the source file.

If you are using the automation interface with InstallShield or the Standalone Build to create, edit, or build an installation
on a 64-bit machine that has Sysnative support, you can use the Sysnative folder in paths when you are specifying the
source folder for system files that are in the 64-bit System folder.

See Also
Developing and Building Installations on 32-Bit vs. 64-Bit Systems

Creating New Destination Folders

InstallShield 2020

Task To create subfolders of the predefined folders:

1. In the View list under Application Data, click Files and Folders.

2. In the Destination computer’s folders pane, right-click a folder and click New Folder.

3. Rename your new folder by selecting it, pressing F2, and typing the new name.

Alternately, you can drag an entire folder onto one of the destination folders, thereby adding a new subfolder to the target
folder that contains the source folders files. This new subfolder has the same name as the source folder.

568 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Creating Empty Folders

InstallShield 2020

Basic MSI Projects

You can use the CreateFolder table of an .msi database—exposed in the Direct Editor—to create empty directories.

For an example, see Knowledge Base article Q103218.

InstallScript MSI Projects

The CreateDir function creates an empty directory.

Specifying Hard-Coded Destination Directories

InstallShield 2020

In the Files and Folders view, you can specify hard-coded destination directories.

Specifying Drive Destinations

Task To specify a particular drive:

1. In the View list under Application Data, click Files and Folders.

2. In the Destination computer’s folders pane, right-click Destination Computer and click New Folder, or click
Destination Computer and press INSERT. InstallShield adds a new folder.

3. For the name of the folder, type the drive letter followed by a colon (for example, C:).

4. Press ENTER.

Specifying Folders and Subfolders to Create a Destination Path

You can specify folders and subfolders beneath a drive letter folder to create a hard-coded destination path:

1. Right-click the drive folder (for example, C:) under which you want to add a folder or—to add a subfolder—right-click
the folder under which you want to add a subfolder. You can also click the folder and press INSERT.

2. For the name of the folder, type the folder name, and then press ENTER.

Quickly Creating Destination Paths

Task To quickly create a nested destination path:

1. Right-click a folder and click New Folder, or click a folder and press INSERT.

2. For the name of the folder, type the destination path—for example, a\b\c. This creates a folder structure with a at the
top, b below a, and c below b.

InstallShield 2020 User Guide ISP-2600-UG00 569

Chapter 4
Organizing Files for Your Installation

See Also
Files and Folders View
Tips for Managing Files and Folders in Your Project

Removing Files and Folders from Target Systems

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield has built-in support that makes it easy to specify files and folders that you want to be removed from target
systems at run time. This file and folder removal capability is useful for scenarios such as removing application-created
files that your installation does not otherwise track.

You can schedule the removal of a file or folder for one of the following events:

• When the file or folder’s component is being installed

• When the file or folder’s component is being uninstalled

• When the file or folder’s component is being installed or uninstalled

Note that if the item to be removed is a folder, that folder is removed only if it is empty.

InstallShield offers different methods for configuring a file or folder removal in a project.

Using the Files and Folders View to Specify Files and Folders to Be Removed

Task To configure file and folder removals through the Files and Folders view:

1. In the View list under Application Data, click Files and Folders.

2. In the Destination computer’s folders pane, select the destination folder that contains the file or folder that you
want to be removed.

3. Right-click in the Destination computer’s files pane and click Add File Removal. The Properties dialog box opens.

4. Configure the settings as needed. For details, see File Removal Properties Dialog Box.

InstallShield adds a file or folder icon to the Destination computer’s files pane. The icon has a red X through it to indicate
that it is referencing an item to be removed.

570 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Using the Setup Design View or Components View to Specify Files and Folders to Be
Removed

Task To configure file and folder removals through the Setup Design view or the Components view:

1. In the View list under Organization, click Setup Design (in installation projects) or Components.

2. In the Setup Design or Components tree, expand the node of the component that contains the file or folder that you
want to be removed, and then click the Files subnode.

3. Right-click in the Files pane and click Add File Removal. The Properties dialog box opens.

4. Configure the settings as needed. For details, see File Removal Properties Dialog Box.

InstallShield adds a file or folder icon to the Files pane. The icon has a red X through it to indicate that it is referencing an
item to be removed.

Editing File or Folder Removal Settings

To change the settings for a file or folder removal, right-click the removal item and then click Properties. The Properties
dialog box opens, enabling you to edit the settings as needed.

See Also
Files and Folders View
Setup Design View
Components View
Tips for Managing Files and Folders in Your Project

Tips for Managing Files and Folders in Your Project

InstallShield 2020

Through drag-and-drop operations, common keyboard shortcuts such as CTRL+C and CTRL+P, and context menus that are
available when you right-click items, you can easily move the files and folders to different destination folders and to
different features.

Managing the Destination of Files and Folders in Your Project

Task To manage the destination of files and folders in your project:

1. In the View list under Application Data, click Files and Folders.

2. Do any of the following:

• To change the settings for a file or folder, right-click the item and then click Properties. The Properties dialog
box opens, enabling you to edit the settings as needed.

• To move a file from one destination folder to another, drag it from one location in the Destination computer’s
files pane to the appropriate folder in the Destination computer’s folders pane.

• To move a folder from one destination folder to another, drag it from one location in the Destination computer’s
folders pane to the appropriate folder in the same pane.

InstallShield 2020 User Guide ISP-2600-UG00 571

Chapter 4
Organizing Files for Your Installation

• To copy a file or folder from one location to another, press and hold CTRL while dragging the item from one
location to another.

As an alternative, you can copy an item to your Clipboard and then paste it into the appropriate location. Right-
click the item and click Copy, or click it and press CTRL+C. Next, select another folder that you want to contain
the file. Then right-click its folder and click Paste, or click the folder and press CTRL+P.

• To delete a file or folder from your project, right-click it and then click Delete.

Managing the Feature Associations for Files in Your Project

Task To manage the feature associations of files in your project:

1. In the View list under Application Data, click Setup Design (in installation projects) or Components.

2. Expand the node of the component that contains the file whose feature association you want to manage, and then
click the Files subnode. InstallShield displays its files in the Files pane on the right.

3. Do any of the following:

• To copy a file from one feature to another, you can copy a file to your Clipboard and then paste it into the
appropriate feature. Right-click the file and click Copy, or click it and press CTRL+C. Next, select another feature
that you want to contain the file. Then right-click its Files pane, and click Paste, or click it and press CTRL+P.

• To remove a file from a feature, right-click the file and then click Remove.

Finding Files and Folders in Your Project

InstallShield 2020

If you have added numerous folders and files to your project, you may have trouble finding a particular folder or file. You
can perform a search for folders and files in the Files view; InstallShield locates any matches and highlights the first one.
You can keep searching until you find all matches for your search criteria.

Task To find files and folders in your project:

1. In the View list under Application Data, click Files and Folders.

2. In the Destination computer’s folders pane, select Destination Computer.

3. On the Edit menu, click Find. The Find dialog box opens.

As an alternative, you can press CTRL+F.

4. In the Find What box, type the text to be found. You can use wildcard expressions, such as *.exe.

5. In the Look at area, specify whether you want to search for files, folders, or both.

6. Specify any other desired criteria.

7. Click Find Next. The first item (if any) that matches your search criteria is selected in either the Destination
computer’s folders pane or the Destination computer’s files pane.

8. To find the next item (if any) that matches your criteria, press the F3 key. Repeat this step as necessary.

572 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Displaying Components in the Files and Folders View

InstallShield 2020

Task To display the components in your installation and the files that are associated with them:

1. In the View list under Application Data, click Files and Folders.

2. In the Destination computer’s folders pane, right-click any folder and click Show Components (in Windows
Installer–based projects) or Show Components and Subfolders (in InstallScript-based projects).

Components in installation projects that are not associated with a feature are displayed with the orphaned component

icon ( ).

Modifying Components through the Files and Folders View

InstallShield 2020

In the folders explorer of the Files and Folders view, you can right-click a component and click Properties to display the
Component Properties dialog box. Through this dialog box, you can modify the component’s properties, add dynamic file
links, and change that features contain the component.

Note • (Windows Installer–based projects only) You can launch the Component Wizard by right-clicking a folder icon and then
clicking Launch Component Wizard.

Configuring Settings for a File

InstallShield 2020

You can set a number of properties for each file that is to be installed on the target system.

Task To specify the properties for a file:

1. In the View list under Application Data, click Files and Folders.

2. In the Destination computer’s folders pane, click the folder that contains the file whose properties you want to
configure.

3. In the Destination computer’s files pane, right-click the file and then click Properties. The Properties dialog box
opens.

To see a description of each property that you can set, see File Properties Dialog Box.

InstallShield 2020 User Guide ISP-2600-UG00 573

Chapter 4
Organizing Files for Your Installation

File Associations
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

File associations are registry settings that tell Windows what application to use to open files of a certain type. For example,
Windows typically launches Notepad.exe when a text (.txt) file is opened.

To view and modify registered file types on your system, open Windows Explorer, and on the Tools menu, click Folder
Options. Use the File Types tab of the Folder Options dialog box to see how the file associations are configured.

Similarly, you can identify the application that is associated with a given file by right-clicking the file in Windows Explorer
and then clicking Properties.

File associations are stored in both HKLM\SOFTWARE\Classes and HKCU\SOFTWARE\Classes; you can see a merged view of
the data under HKEY_CLASSES_ROOT.

Creating File Associations for Your Installation Project

Best-practice guidelines recommend that you create a file association for every nonhidden type of file created or used by
your product. You can quickly and easily create file associations for your installation project with the File Extensions view,
which is available as an advanced setting within the Components view and the Setup Design view (for installation projects
only). When an end user installs a feature that contains a file association, the file association is registered on the target
machine; an entry is made in the appropriate part of the registry, and the entry links your file type to your application
through the ProgID. The ProgID, which is sometimes called a file type’s application identifier or tag name, uniquely
identifies your application and helps the operating system recognize your file association.

See Also
Registering a File Extension

Adding New File Extensions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

574 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• MSI Database
• MSM Database
• Transform

If your application manipulates files with a unique file extension, you can register your file type. For example, if your
application manipulates files with the .xyz extension, registering the file type instructs the operating system to open the file
with your application when the user double-clicks its icon.

Task To add a new file extension:

1. In the View List under Organization, click Setup Design (in installation projects only) or Components.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Click File Types. The File Types explorer opens.

5. In the File Types explorer, right-click Extensions and click New Extension. InstallShield creates a new extension with
the default name New ExtensionN, where N is a unique number.

6. Type your extension without the dot (for example, enter ext instead of .ext).

See Also
File Type Settings
Registering a File Extension

Removing File Extensions

InstallShield 2020

Project • This information does not apply to InstallScript or InstallScript Object projects.

Task To remove an extension:

1. Open the Setup Design view (for installation projects only) or the Components view.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Click File Types. The File Types explorer opens.

5. In the File Types explorer, right-click the extension and click Delete.

InstallShield 2020 User Guide ISP-2600-UG00 575

Chapter 4
Organizing Files for Your Installation

Setting File Extension Properties

InstallShield 2020

Project • This information does not apply to InstallScript or InstallScript Object projects.

The extension properties determine the registry entries for your file extension, as well as the ProgID associated with it.
Detailed help is available in the help pane in InstallShield when you click each property.

See Also
Registering a File Extension

Specifying Command Verbs

InstallShield 2020

Project • This information does not apply to InstallScript or InstallScript Object projects.

By default, the verb open is added to your file extension.

Task To add a new verb and specify its properties:

1. Open the Setup Design view (for installation projects only) or the Components view.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Click File Types. The File Types explorer opens.

5. In the File Types explorer, right-click the extension and click New Verb. InstallShield creates a new verb with the
default name New VerbN, where N is a unique number.

6. Type the name of your new verb. You can use any of the canonical verbs, such as open, print, find, and properties.

7. Select the new verb to edit its properties. Its property sheet opens to the right.

Removing a Verb from a File Extension

InstallShield 2020

Project • This information does not apply to InstallScript or InstallScript Object projects.

Task To remove a verb:

1. Open the Setup Design view (for installation projects only) or the Components view.

2. In the explorer, expand the component.

576 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

3. Click the Advanced Settings item to expand it.

4. Click File Types. The File Types explorer opens.

5. Right-click the verb and click Delete.

Adding New MIME Types

InstallShield 2020

Project • This information does not apply to InstallScript or InstallScript Object projects.

Task To add a new MIME type:

1. Open the Setup Design view (for installation projects only) or the Components view.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Click File Types. The File Types explorer opens.

5. In the File Types explorer, right-click the extension and click New MIME Type. InstallShield creates a new MIME type
with the default name MIME TypeN, where N is a unique number.

6. Type the MIME type; for example, image/jpeg.

Click the MIME type to view its Class ID property. Click the Class ID property to edit it in the lower pane. Press CTRL+V to
paste a class ID into the property field.

See Also
Registering a File Extension

Removing MIME Types

InstallShield 2020

Project • This information does not apply to InstallScript or InstallScript Object projects.

Task To remove a MIME type:

1. Open the Setup Design view (for installation projects only) or the Components view.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Click File Types. The File Types explorer opens.

5. Right-click the MIME type and click Delete.

InstallShield 2020 User Guide ISP-2600-UG00 577

Chapter 4
Organizing Files for Your Installation

Creating ProgIDs

InstallShield 2020

Project • This information does not apply to InstallScript or InstallScript Object projects.

The ProgIDs item in the File Types explorer contains all of the programmatic identifiers—ProgIDs, also known as
application identifiers or tag names when they support file types—that you want to associate with file extensions. A file
type’s ProgID is an arbitrary string, but it should be unique on the target system. One ProgID naming convention is to
append the word file to your extension without a dot—the .ext extension might use the ProgID extfile. Another convention
is to name a file-type ProgID after the application used to open the file type, as in SampleApp.Document.

For example, an .xyz file extension could point to a xyzfile ProgID, and all of the .xyz file-type information would be
registered under xyzfile.

Task To create a ProgID:

1. Open the Setup Design view (for installation projects only) or the Components view.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Click File Types. The File Types explorer opens.

5. In the File Types explorer, click the extension. The extension properties are displayed in the right pane.

6. In the ProgID property, type the name of your ProgID. InstallShield adds your ProgID under ProgIDs in the File Types
explorer.

7. In the File Types explorer, click the new ProgID and then set its properties.

See Also
Registering a File Extension

Removing ProgIDs

InstallShield 2020

Project • This information does not apply to InstallScript or InstallScript Object projects.

Task To remove a ProgID:

1. Open the Setup Design view (for installation projects only) or the Components view.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Click File Types. The File Types explorer opens.

578 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

5. In the File Types explorer, click the extension. The extension properties are displayed in the right pane.

6. In the ProgID property, delete the ProgID.

Dynamic File Linking

InstallShield 2020

If you want to add the contents of an entire directory to your project, you can do so through the use of dynamic file linking.
When you select a source folder for dynamic linking, InstallShield adds the files within that folder to your release at build
time. InstallShield scans the source folder before every build and automatically incorporates any new or changed files into
your release. Dynamic file linking is useful when the list of files in a folder—and possibly the list of files in its subfolders—
might change between builds.

Important • Dynamic file linking should be used with caution. If you inadvertently delete a dynamically linked file from the
source folder that your dynamic link references, that file is not included in your release the next time you build it, and
InstallShield does not display any build warning or error. Your product may install without any issues, but it may not work as
expected, since the dynamically linked file that was inadvertently deleted is no longer being installed. Therefore, it is
recommended that you avoid using dynamic file links for critical executable files—such as .exe, .dll, or .ocx files—especially if
your product requires them in order to run successfully.

Whenever possible, it is better to use the best practice method, instead of the by-directory method, for creating components
for dynamically linked files. Note that with both methods, however, a minor upgrade, a small update, or a patch may not
install correctly if a file that was present in a target image is removed from the dynamic link for the upgrade or patch.

Filtering Dynamically Linked Files

When you are configuring your dynamic file link, you can specify whether you want to include subfolders of the
dynamically linked folder. To further filter the files that are dynamically linked, you can identify specific names of files that
you want to be included in or excluded from the dynamic link. In addition, you can use wild cards to specify only certain
files or file types to be added or excluded.

For example, if all of your image files are in one folder along with sound files and you want to dynamically link only the
image files, you could specify that you would like to include only .bmp and .ico files in the dynamically linked folder. To do
so, you would use an asterisk (*) in your include pattern, as in the following example:

*.bmp, *.ico

To include or exclude a specific file, you would enter the full file name in the include or exclude pattern box. For more
details, see Creating a Dynamic Link.

Distinguishing Dynamically Linked Files and Folders from Static Files and Folders in the
InstallShield Interface
When a dynamic file is displayed within the InstallShield interface, the lower-left corner of the file’s icon includes an image
that indicates that it is a dynamically linked file:

InstallShield includes that same dynamic file image on the icon of subfolders that are included in dynamic file links:

InstallShield 2020 User Guide ISP-2600-UG00 579

Chapter 4
Organizing Files for Your Installation

Furthermore, InstallShield adds an arrow to the folder image—in addition to the dynamic file image—on the component
icon of subfolders that are included in dynamic file links:

The icons that the InstallShield interface displays for static files and folders do not include this dynamic link image.

See Also
Limitations of Dynamic File Linking
Determining the Appropriate Component Creation Method for Dynamically Linked Files
Working with Releases
Setting Component Key Files
Using Path Variables

Limitations of Dynamic File Linking

InstallShield 2020

Important • Dynamic file linking should be used with caution. If you inadvertently delete a dynamically linked file from the
source folder that your dynamic link references, that file is not included in your release the next time you build it, and
InstallShield does not display any build warning or error. Your product may install without any issues, but it may not work as
expected, since the dynamically linked file that was inadvertently deleted is no longer being installed. Therefore, it is
recommended that you avoid using dynamic file links for critical executable files—such as .exe, .dll, or .ocx files—especially if
your product requires them in order to run successfully.

Whenever possible, it is better to use the best practice method, instead of the by-directory method, for creating components
for dynamically linked files. Note that with both methods, however, a minor upgrade, a small update, or a patch may not
install correctly if a file that was present in a target image is removed from the dynamic link for the upgrade or patch.

Limitations for Windows Installer–Based Projects

Note the following limitations if you are considering dynamic file linking in Basic MSI, DIM, InstallScript MSI, and Merge
Module projects:

• You cannot create custom actions to a dynamically linked file.

• You cannot associate a file extension with a dynamically linked file.

• You cannot extract COM information from a dynamically linked file.

• You cannot set any properties such as Shared, Permanent, or Never Overwrite for a dynamically linked file.

• You cannot use the .NET installer class functionality for a dynamically linked file.

• You cannot specify that COM interop should be enabled for a dynamically linked file.

• You cannot change default file settings (such as Read-Only or Hidden).

• You cannot set file permissions for a dynamically linked file.

• You cannot create shortcuts to a dynamically linked file.

• You cannot perform a static or dynamic scan of a dynamically linked file.

• You cannot exclude a subfolder from a dynamically linked folder.

580 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• For Basic MSI projects: You cannot launch a dynamically linked file from the SetupCompleteSuccess end-user dialog.

Any file that you add directly (not through dynamic linking) to your project has an internal name (FileKey). When you create
a custom action, a file extension, shortcut, or other type of item, it actually points to this internal name.

When you add files to your project through dynamic links, the files are not physically added to the project. This means that
these files do not have any FileKeys that can be associated with custom actions, file extensions, etc.

Limitations for InstallScript–Based Projects

For InstallScript and InstallScript Object projects, a single component cannot contain both static files and dynamically
linked files.

See Also
Working with Releases
Setting Component Key Files
Using Path Variables

Determining the Appropriate Component Creation Method for Dynamically Linked Files
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

InstallShield provides two methods for creating components for dynamically linked files: the best practice method and the
one-component-per-directory method.

Using the Best Practice Method

When best practices for component creation are followed, InstallShield performs the following tasks at build time for all of
the files that meet the include and exclude filter criteria of your dynamic link:

• InstallShield creates a separate component for each portable executable (PE) file in the dynamically linked folder.
Each PE file is the key file of its component.

• InstallShield adds all non-PE files at the root level of the dynamic link to the component that contains the link.

• If the dynamic link includes a subfolder, InstallShield creates a new component for all of the non-PE files in that
subfolder. If the dynamic link includes more than one subfolder, InstallShield creates a separate component for all of
the non-PE files in each subfolder.

This is the default functionality for all new dynamic links.

Tip • The File Extensions tab on the Options dialog box is where you specify which file types are PE files.

InstallShield 2020 User Guide ISP-2600-UG00 581

Chapter 4
Organizing Files for Your Installation

Using the By-Directory Method

When the by-directory method is used for component creation, InstallShield performs the following tasks at build time for
all of the files that meet the include and exclude filter criteria of your dynamic link:

• InstallShield creates one component for all of the files that are in the root-level dynamically linked folder, regardless
of the file types.

• If the dynamic link includes one or more subfolders, InstallShield creates a separate component for all of the files in
each subfolder, regardless of the file types. The first dynamically linked file in a subfolder’s component is the key file of
that component.

This method of component creation is the traditional method that was available in InstallShield before the best practice
method was introduced.

Determining Which Component Creation Method to Use

For most dynamic links, the preferred component creation method is the best practice method. This method enables you
to create patches more easily than with the by-directory method. For minor upgrades and small updates, the components,
key files, and feature-component organization need to be maintained across the earlier and later .msi databases; for
patches, the File table keys also need to be maintained. Since each component name and component code—and possibly
key files—change at each build with the by-directory method of dynamic file linking, issues may occur. The advantage of
the best practice method is that it allows for greater predictability than with the by-directory method.

Tip • When you are configuring an upgrade, use the patch optimization functionality in your build settings. Using patch
optimization helps you keep component names, component codes, File table keys, and Directory table keys synchronized
from the earlier release. For more information, see Upgrade Considerations.

Note that if you want to create a patch for an earlier version of your product, and the earlier installation includes dynamic
links that used the by-directory method, you must continue to use the by-directory method for the same dynamic links.
However, if you add new dynamic links in your upgrade project, you can use the best practice method for those new
dynamic links. That is, you can mix both types of dynamic linking in the same project and create a patch to deliver the
upgrade.

Important • Whenever possible, it is better to use the best practice method, instead of the by-directory method, for creating
components for dynamically linked files. Note that with both methods, however, a minor upgrade, a small update, or a patch
may not install correctly if a file that was present in a target image is removed from the dynamic link for the upgrade or patch.

Note • For information on the rules that Windows Installer uses when determining whether a file included in a package
should overwrite a file that already exists on the target system, see Overwriting Files and Components on the Target System.

Specifying Which Component Creation Method You Want to Use

The File Linking tab on the Component Properties dialog box is where you specify which component creation method you
want to use.

582 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

See Also
Creating a Dynamic Link
Limitations of Dynamic File Linking
Setting Component Key Files

Creating a Dynamic Link

InstallShield 2020

Project • The procedure for creating dynamic file links differs, depending on which project type you are using. Note that parts
of the procedure apply to the following Windows Installer–based projects:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

Parts of the procedure apply to the following InstallScript-based projects:

• InstallScript
• InstallScript Object

You can use the Files and Folders view to create a dynamic link.

Task To create a dynamic link:

1. In the View List under Application Data, click Files and Folders.

2. In the View Filter list, select the feature that should contain components with the dynamically linked files.

3. Ensure that components are displayed in the Destination computer’s folders pane.

If components are not displayed: In the Destination computer’s folders pane, right-click Destination Computer and
click Show Components (in Windows Installer–based projects) or Show Components and Subfolders (in
InstallScript-based projects).

4. For a Windows Installer–based project: right-click a component and click Dynamic File Linking. The Component
Properties dialog box opens, and the File Linking tab is displayed.

For an InstallScript-based project: right-click a component and click File Linking. The Link Type dialog box opens.

5. Define the dynamic link and click OK.

Tip • You can also use the Components view to add dynamic file links. For more information, see Adding Dynamic File Links to
Components.

See Also
Limitations of Dynamic File Linking
Files and Folders View

InstallShield 2020 User Guide ISP-2600-UG00 583

Chapter 4
Organizing Files for Your Installation

Adding Dynamic File Links to Components

InstallShield 2020

You can use the Components view to add dynamic file links to components in both Windows Installer–based and
InstallScript-based projects. The procedure for creating dynamic file links differs, depending on which project type you are
using.

Windows Installer–Based Projects

The following procedure applies to Basic MSI, DIM, InstallScript MSI, and Merge Module projects.

Task To add a dynamic link to a component:

1. In the View List under Organization, click Components.

2. In the Components explorer, expand the component for which you want to add dynamic file links, and then click the
Files item under that component.

3. Right-click the Files pane and click Dynamic File Linking. The Modify Dynamic File Links dialog box opens.

4. Click the New Link button. The Dynamic File Link Settings dialog box opens. This dialog box is where you set the
source folder for your link, indicate whether to include its subfolders and whether the files are self-registering, and
specify which file types to include and exclude.

5. Click OK. Any file conflicts are resolved with prompts to overwrite existing files with the new versions. Click Yes to
overwrite, No to retain the existing file version, or Cancel to exit the dialog box without saving any of your dynamic file
link settings. You will also be warned if the folder contains no files, or if it is already in use in another dynamic link.

Your new file link details appear in the Files pane.

InstallScript-Based Projects
The following procedure applies to InstallScript and InstallScript Object projects.

Task To add a dynamic link to a component:

1. In the View List under Organization, click Components.

2. In the Components explorer, click the component that should contain the dynamic link.

3. Select the value of the Link Type property and click the ellipsis button (...). The Link Type dialog box opens.

4. Specify the folder that contains the files to include, and specify any other desired options.

5. Click OK.

Tip • You can also use the Files and Folders view to add dynamic file links. For more information, see Creating a Dynamic Link.

See Also
Limitations of Dynamic File Linking
Creating a Dynamic Link

584 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Setting a Key File for a Dynamic File Link

InstallShield 2020

Project • This information applies to dynamic links that use the one-component-per-directory method of component creation
(as described in Determining the Appropriate Component Creation Method for Dynamically Linked Files) in the following
Windows Installer–based projects:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

This information does not apply to dynamic links that use the best practice method of component creation.

A dynamically linked file whose component uses the one-component-per-directory method of component creation cannot
be the key file of a component.

To set a key file for a component containing a dynamic link, add a static link to the desired file, and then set the static link
to be the key file of the component. In the dynamic link settings, enter the full name of the key file in the Exclude files with
the following extensions field.

For example, you might have a source directory containing several .txt files, and you want the file called Key.txt to be the
key file. First, add a static link to Key.txt to a component, and set Key.txt as the key file. Next, create a dynamic link with the
same source folder, setting the Include files with the following extensions setting to *.txt and the Exclude files with
the following extensions setting to Key.txt.

For a dynamic link that includes subdirectories, the build process sets the first file in a subdirectory’s component as the key
file of the dynamically generated component.

See Also
Dynamic File Linking

Overwriting Files and Components on the Target System

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

At run time, Windows Installer considers the following questions when determining whether files should be overwritten on
the target system:

• Should the component be installed?

• If the component should be installed, do its files need to be installed or updated?

The following sections explain how Windows Installer evaluates these questions.

InstallShield 2020 User Guide ISP-2600-UG00 585

Chapter 4
Organizing Files for Your Installation

Determining Whether a Component Needs to Be Installed

During costing, Windows Installer checks the key path of a component to determine if the component should be installed.
If the component has a directory or ODBC key path, Windows Installer installs the component. In addition, if a registry key
path is used for the component and both of the following conditions are true, Windows Installer installs the component:

• No is selected for the Never Overwrite setting of the component.

• The key path does not exist on the target system.

If one or both of those conditions are false for a component that has a registry key path, Windows Installer does not install
the component at run time.

If a component has a key file instead of a key path, Windows Installer checks the target system for the presence of that file.
Windows Installer installs the component in all of the following scenarios:

• The file is not present on the target system.

• The file is present on the target system, and the key file of the component has a higher or equal version number
compared to the version number of the file on the target system.

• The file is present on the target system, and the key file of the component and the file on the target system are
unversioned.

If the key file of the component has a lower version number than the file on the target system, Windows Installer does not
install the component at run time. In addition, Windows Installer does not install the component at run time if the key file
of the component is unversioned but the file on the target system is versioned. Thus, Windows Installer does not install a
component if its key file could be downgraded at run time.

Determining Whether a File Needs to Be Installed

If Windows Installer determines that a component needs to be installed, it reviews the files for that component and
determines if they need to be installed. If the name and target location of the key file matches the name and location of a
file on the target system, Windows Installer uses the following rules by default to determine whether the file in your
installation should overwrite the corresponding file on the target system:

• Always Overwrite—If the Always Overwrite check box for the file is selected, the file on the target system is
overwritten, regardless of version number.

• Versioned Files—In all cases, the file with the highest version is maintained, even if the file already on the target
system has a higher version than the one being installed. Additionally, a file of any version is maintained over
unversioned files.

• File Language—All other things being equal, the file that is the same language as the installation is maintained over
different language versions of the file. The only exception to this rule applies to multiple language files. Files with
multiple languages are maintained over single language versions of a file.

• Date—If the modified date of a file already present on the target system is later than the creation date of that file, the
file is not overwritten. This rule protects user preference files from being overwritten during an upgrade or
reinstallation.

If a file is in the component that is being installed but it is not present on the target system, Windows Installer always
installs that file.

586 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Note • The REINSTALLMODE property can be set to modify the default file-versioning rules. For more information, see
Understanding File Overwrite Rules.

See Also
Checking File Versions Before Installing
Setting Component Key Files
File Versioning Rules (Windows Installer Help Library)
File Versioning Rules (Windows Installer Help Library)

Displaying Predefined Folders in the Files View

InstallShield 2020

Task To display a predefined destination folder:

1. In the View list under Specify Application Data, click Files.

2. In the Destination computer’s folders pane, right-click Destination Computer, point to Show Predefined Folders,
and then click the type of predefined folder that you want to use.

See Also
Destination Folders

Companion Files
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

The use of companion files enables you to bind the installation action of one file to another file. For example, if your
installation project has two files—FileA.exe and FileB.dat—companion files let you bind FileB.dat to FileA.exe so that if
FileA.exe needs to be installed or reinstalled, then FileB.dat is also installed or reinstalled. If FileA.exe needs to be
uninstalled, then FileB.dat is also uninstalled.

Using Companion Files

This mechanism is useful when trying to override the Windows Installer’s default file versioning rules. For instance, file
versioning rules state that for non-versioned files, any file on the target machine that has a modified date later than its
created date is considered user data and should not be overwritten. This is not always a valid assumption, so you may want
to use companion files to bind a non-versioned file to a versioned file.

InstallShield 2020 User Guide ISP-2600-UG00 587

Chapter 4
Organizing Files for Your Installation

Creating Companion File Associations

Task To create a companion file association:

1. In the Files and Folders view, add the versioned file to your project.

2. Open the Components view.

3. In the Components explorer, expand the component that contains the file that you just added, and then click Files.
Note the value in the Key column for that file.

4. Right-click the file and then click Add.

5. Select the unversioned file to add it to the selected component.

6. Right-click the second file and then click Properties. The Properties dialog box opens.

7. Select the Override system version check box.

8. In the Version box, type the name of the value noted in the Key column from step 3.

Note • InstallShield generates a unique file key every time you add a file. Therefore, if you remove the file that you have
created a binding to, it is possible that the file key will not persist. You would need to update the version of the unversioned file.

See Also
Overwriting Files and Components on the Target System

Configuring Permissions for Files and Folders

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield lets you configure settings for securing files and folders for end users who run your product in a locked-down
environment. You can assign permissions for a file or folder to specific groups and users. For example, you may assign
Read, Write, and Delete permissions for a particular file to the Administrators group, but only Read permissions for all of
the users in a different group.

588 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Task To configure the permissions for a file or folder:

1. In the View List under Application Data, click Files and Folders.

2. For a file: In the Destination computer’s files pane, right-click the file and then click Properties. The Properties
dialog box opens.

For a folder: In the Destination computer’s folders pane, right-click the folder and then click Properties. The
Properties dialog box opens.

3. Click the Permissions button. The Permissions dialog box opens.

4. Add, modify, and remove permissions entries as needed. For more information, see Permissions Dialog Boxes for Files
and Directories.

Depending on what is selected for the Locked-Down Permissions setting in the General Information view of your project,
InstallShield adds permissions data to either the ISLockPermissions table or the LockPermissions table. To learn more,
see Securing Files, Folders, Registry Keys, and Windows Services in a Locked-Down Environment.

Tip • You can also configure permissions for a component’s destination folder. To do so, first click a component in the
Components view. Next, click the value for the Destination Permissions setting, and then click the ellipsis button (...). The
Permissions dialog box opens. On this dialog box, you can configure permissions as needed.

See Also
Configuring Permissions for Registry Keys

Extracting COM Data When Files Are Added

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

When you drag and drop new files in the Files and Folders view or in the Files subview under a component, you can
statically extract COM data for self-registering files. This is an alternative to extracting COM registration data at build time.

This option is also available in the COM Registration node under Advanced Settings in the Components view.

InstallShield 2020 User Guide ISP-2600-UG00 589

Chapter 4
Organizing Files for Your Installation

Extracting a File’s COM Data

Task To extract COM data on demand, rather than at build time:

Right-click the file (or in the COM Registration node, right-click COM Registration) and click Extract COM Data for Key
File.

Note • This option is enabled only if the file is an .exe file or a file that is self-registering, and if the file is the component’s key
file.

Tip • If you are using InstallShield on a 64-bit system, InstallShield can extract COM data from a 64-bit COM server. In order to
install the data to the correct locations, the component must be marked as 64 bit. To learn more about 64-bit support, see
Targeting 64-Bit Operating Systems.

Refreshing a File’s COM Data

If the file’s COM data has already been statically extracted, you can select Refresh COM Data for Key File. When you refresh
the COM data, the old COM data is deleted from the project, then the current COM data for the file is added to the project.

Installing Self-Registering Files

InstallShield 2020

The installer uses “traditional” self-registration to register your self-registering files when the files are marked as self-
registering and (in a Windows Installer–based project) they are in a component that has the COM Extract at Build property
set to No. The files are unregistered when they are uninstalled. The self-registration functions supported are
DllRegisterServer and DllUnregisterServer.

Before setting a file’s Registration property, make sure the file is self-registering. According to Setup Best Practices, there
should be only one .dll file, .ocx file, or .exe file per component.

Tip • The recommended method for installing self-registering files with Windows Installer is to write the registration
information to the .msi database tables (Class, ProgID, and others). Instead of marking a file as self-registering, you can use
the component’s advanced settings, extract the COM information at build time, or extract the COM information when you add
a file in the Files and Folders view in order to register the ProgIDs, type libraries, and so on. Using the advanced settings works
whether you are installing the file in the installation or advertising it for “just-in-time installation.” A further advantage is that
the file can be unregistered if the installation fails.

Even if you set the component’s COM Extract at Build property to No, any information that is contained in the COM
Registration advanced setting will nonetheless be registered during installation. You might want to check the COM
Registration advanced setting and the component’s registry data to verify that the entries are intentional and do not
conflict with those made by the self-registration functions.

590 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Identifying Properties and Dependencies of .NET Assemblies

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield offers support for identifying the properties and dependencies of .NET assemblies. The functionality depends
on the project type that you are using.

Windows Installer–Based Projects

In Basic MSI, DIM, InstallScript MSI, and Merge Module projects, when you add a .NET assembly to your project, it is
recommended that you set it as the key file of its component. No other .NET assemblies should be included in that
component.

When a .NET assembly is the key file of its component, you can use one of the following methods to identify its
dependencies:

• If you know which files and merge modules are required for the .NET assembly, you can manually add them to the
same feature that contains the .NET assembly component in your project. This method is recommended, since it gives
you the most control over what is included in your project.

• If you do not know which files and merge modules are required for the .NET assembly, use one of the following built-in
methods:

• To identify the .NET assembly’s dependencies on demand, use the Static Scanning Wizard to detect possible
dependencies. This wizard displays a list of the dependencies that it finds, and it lets you specify whether you
want to include each one in your project. Note that this method is available in Basic MSI and InstallScript MSI
projects, but not in DIM or Merge Module projects.

• To identify the .NET assembly’s dependencies each time that you build your project, select Dependencies and
Properties for the component’s .NET Scan at Build setting. If InstallShield detects any possible missing
dependencies at build time, InstallShield incorporates them into the release that it generates.

Configuring the properties of a .NET assembly makes it possible for Windows Installer to update and uninstall the assembly
when needed. When a .NET assembly is the key file of its component, you can use either of the following methods to
identify its properties:

• Manually enter the properties and their values: In the Components view, under the Advanced Settings area for the
component that contains the .NET assembly, select .NET assembly subnode under the Assembly node, and configure
the properties as needed. Note that the properties and values that you enter must match the information in the
assembly’s manifest file. If they do not match, the assembly might be left on the target system when the feature that
contains the .NET component is uninstalled.

• To identify the .NET assembly’s properties each time that you build your project, select the Properties Only option or
the Dependencies and Properties option for the component’s .NET Scan at Build setting. If InstallShield detects any
possible missing properties at build time, InstallShield incorporates them into the release that it generates.

InstallShield 2020 User Guide ISP-2600-UG00 591

Chapter 4
Organizing Files for Your Installation

InstallScript Projects
In InstallScript projects, when you add a .NET assembly to a component in your project, you can use the component’s .NET
Assembly setting to identify the assembly as a local .NET assembly. You can also use one of the following methods for
identifying the dependencies of the .NET assembly:

• If you know which files and merge modules are required for the .NET assembly, you can manually add them to the
same feature that contains the .NET assembly component in your project. This method is recommended, since it gives
you the most control over what is included in your project.

• If you do not know which files and merge modules are required for the .NET assembly, use one of the following built-in
methods:

• To identify the .NET assembly’s dependencies on demand, use the Static Scanning Wizard to detect possible
dependencies. This wizard displays a list of the dependencies that it finds, and it lets you specify whether you
want to include each one in your project.

• To identify the .NET assembly’s dependencies each time that you build your project, select Dependencies for the
component’s .NET Scan at Build setting. If InstallShield detects any possible missing dependencies at build time,
InstallShield incorporates them into the release that it generates.

If Not an Assembly is selected for the component’s .NET Assembly setting, InstallShield does not scan for dependencies of
the component’s assembly.

Note that when Local Assembly is selected for the component’s .NET Assembly setting, the installation performs COM
interop registration and configures .NET installer class information for the component at run time.

See Also
Scanning 64-Bit .NET Assemblies for Dependencies
Reviewing .NET Dependency Scanner Results
Filtering Files in Dependency Scanners

Scanning 64-Bit .NET Assemblies for Dependencies

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

If you use InstallShield on a 64-bit version of Windows Vista or later or a 64-bit version of Windows Server 2008 or later, and
you use either of the following built-in methods for detecting dependencies, InstallShield can scan for 64-bit dependencies
of the 64-bit .NET assemblies in your project:

• To identify a 64-bit .NET assembly’s dependencies on demand, use the Static Scanning Wizard to detect possible
dependencies. This wizard displays a list of the dependencies that it finds, and it lets you specify whether you want to
include each one in your project.

592 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• To identify a 64-bit .NET assembly’s dependencies each time that you build your project, select one of the dependency
options for the component’s .NET Scan at Build setting. For InstallScript projects, the component’s .NET Assembly
setting must also be set to Local Assembly. If InstallShield detects any possible missing dependencies at build time,
InstallShield incorporates them into the release that it generates.

These methods also scan for 32-bit dependencies of the 32-bit .NET assemblies in your project.

Note that if you use InstallShield on a 32-bit version of Windows, these built-in scans can check for only 32-bit
dependencies of the 32-bit files in your project. If your project includes 64-bit files, you can manually add any
dependencies to the project as needed.

How the Built-In Scanning Methods Detect Platform-Specific and Platform-

Independent .NET Dependencies in Windows Installer–Based Projects
In Basic MSI, DIM, InstallScript MSI, and Merge Module projects, when you use either of the aforementioned built-in
methods for detecting .NET dependencies, InstallShield uses a specific order for detection, as indicated in the following
table.

Table 4-3 • Order for Detecting .NET Assembly Dependencies

Scan Results on 32-Bit Windows Scan Results on 64-Bit Windows

Type of File Being Scanned Systems Systems

Platform-independent .NET InstallShield uses the following order InstallShield uses the following order
assembly in the GAC when scanning for dependencies: when scanning for dependencies:

1. 32-bit-specific .NET 1. 64-bit-specific .NET

dependencies dependencies

2. Platform-independent .NET 2. Platform-independent .NET

dependencies dependencies

64-bit .NET assembly in the GAC InstallShield does not detect any InstallShield uses the following order
dependencies. when scanning for dependencies:

1. 64-bit-specific .NET
dependencies

2. Platform-independent .NET
dependencies

32-bit .NET assembly in the GAC InstallShield uses the following order InstallShield uses the following order
when scanning for dependencies: when scanning for dependencies:

1. 32-bit-specific .NET 1. 32-bit-specific .NET

dependencies dependencies

2. Platform-independent .NET 2. Platform-independent .NET

dependencies dependencies

If a .NET assembly is not in the GAC, InstallShield checks the same folder that contains the assembly when scanning for
dependencies, and then it checks any subfolders.

InstallShield 2020 User Guide ISP-2600-UG00 593

Chapter 4
Organizing Files for Your Installation

See Also
Identifying Properties and Dependencies of .NET Assemblies
Reviewing .NET Dependency Scanner Results
Filtering Files in Dependency Scanners

Reviewing .NET Dependency Scanner Results

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield offers different built-in methods for identifying dependencies of .NET assemblies. If you use these built-in
methods, the scanning may identify as a dependency a file or merge module that is not required by your product. If you are
using the Static Scanning Wizard and that occurs, you can specify in the wizard that you do not want to add that
dependency to your project. If you are using the .NET scan at build functionality to automatically include any possible .NET
dependencies in your project at build time, you can change the values of the component’s settings so that the .NET
assembly is not scanned for dependencies automatically:

• In Basic MSI, InstallScript MSI, and Merge Module projects, InstallShield scans each component’s .NET assembly for
dependencies automatically at build time by default. You can override this default behavior by changing the value of a
component’s .NET Scan at Build setting as needed.

• In InstallScript projects, InstallShield does not scan each component’s .NET assembly for dependencies at build time
by default. You can override this default behavior by changing the values of a component’s .NET Assembly setting and
its .NET Scan at Build setting as needed.

In addition, InstallShield enables you to specify on a machine-wide basis any files that you want to be included or excluded
automatically any time that you perform a dependency scan through InstallShield. For more information, see Filtering Files
in Dependency Scanners.

To obtain the best results when you are trying to identify dependencies, it is recommended that you thoroughly test your
product and its installation on a clean machine. If your product does not behave as expected, determine whether any
dependencies are missing from the machine, and if so, whether they should be included in the installation.

See Also
Identifying Properties and Dependencies of .NET Assemblies
Scanning 64-Bit .NET Assemblies for Dependencies

Installing Fonts Through InstallScript and InstallScript Object Projects

InstallShield 2020

Project • This information applies to the following project types:

594 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• InstallScript
• InstallScript Object

When you include a font file—.ttf, .ttc, or .fon file—in your installation project (using either the Components view or the
Files and Folders view), the file is automatically marked internally to be registered on the target machine if you have
enabled global font registration. At run time, the OnInstalledFontFile event handler function is called immediately after
each font file is installed; the default code for this event handler function calls the RegisterFontResource function to
register the font if it is internally marked for registration.

Font Titles
InstallShield determines the font title that the installation registers for the font in the following manner:

• For an .fon file, InstallShield—by default—reads the font title from the registry of the source system. If no title can be
found in the registry, InstallShield stores the file name as the font title. For an .fon file in a component whose Link Type
property is set to Static, InstallShield displays the font title in the Font title box on the file’s File Properties dialog box.

• For a TrueType file (.ttf or .ttc file), by default the installation reads the font title from the file at run time, and at design
time no text is displayed in the Font title box.

• For all three types of files, in a component whose Link Type property is set to Static, if you enter non-default text in the
Font title box, the installation registers that text as the font title.

Installing Fonts to the Windows Fonts Folder

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript Object

Task To install a font file to the Windows Fonts folder, do either of the following:

• In the Files and Folders view, place the font file in the Destination computer’s folders pane’s Fonts Folder folder,
which is a subfolder of the Windows folder.

• In the Components view, place the font file in a component whose Destination property is set to <FOLDER_FONTS>.

Enabling or Disabling Global Font Registration

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript Object

You can enable or disable automatic registration of font files globally.

InstallShield 2020 User Guide ISP-2600-UG00 595

Chapter 4
Organizing Files for Your Installation

Task To enable or disable global font registration:

1. In the View List under Installation Information, click General Information.

2. In the Font Registration setting, specify the appropriate option:

• To enable global font registration, select Enabled.

• To disable global font registration, select Disabled.

Enabling or Disabling Registration of a Font File

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript Object

You can enable or disable automatic registration of font files for individual files.

Task To enable or disable automatic registration of an individual font file:

1. Open the Components view, Setup Design view, or Files and Folders view.

2. Right-click the font file and click Properties. The Properties dialog box opens.

3. To enable automatic registration of the font file, select the Register Font File check box.

To disable automatic registration, clear the Register Font File check box.

4. Click OK.

Using Components
InstallShield 2020

Components are elements of the application from the installation developer’s perspective. Components are not visible to
the end user. When the user selects a feature for installation, the installer determines which components are associated
with that feature and then those components are installed. Components of an application would contain the executable
binary files, data files, shortcuts, help system files, and registry entries.

You can create and modify components in the Setup Design view (for installation projects) or the Components view.

Component-Feature Relationships

Project • Features are not used in DIM or Merge Module projects.

596 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Components are associated with features in the Setup Design view. For more information, see Associating New
Components with Features.

Files
Expand a component’s tree in the Setup Design view or the Components view and click Files to view a list of all files
associated with that component. To learn how to add files, see Adding Files to Components.

See Also
Setup Design View
Components View

Setup Best Practices

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield makes adhering to Setup Best Practices easier by alerting you to Best Practices violations while you are
creating components in the Setup Design view and in the Component Wizard. By following these guidelines, you can create
clean installations that distribute reusable components efficiently and avoid problems that result from file incompatibility.

When you are creating components in the Setup Design view, the Setup Best Practices Wizard monitors the files that you
add to the components, alerts you when you have done anything that conflicts with Best Practices, and then gives you the
opportunity to correct the action in the wizard. To turn off the wizard’s automatic scanning of your setup design, select
Options from the Tools menu.

InstallShield 2020 User Guide ISP-2600-UG00 597

Chapter 4
Organizing Files for Your Installation

InstallShield checks for compliance with the following Setup Best Practices:

Table 4-4 • Setup Best Practices that InstallShield Monitors

Best Practice Description

Components should not contain Each component should contain only one portable executable file (an .exe, .dll, or
multiple .exe, .dll, .ocx, .chm, or .ocx file) or WinHelp file (.hlp file). Windows Installer components are designed
.hlp files such that all of the advanced settings and component settings, such as the GUID
code, refer ideally to a single portable executable file or help file. Place other .exe,
.dll, .ocx, and .hlp files into new components.

One reason for this rule is that, at run time, if the user chooses Repair for an
installed product, Windows Installer checks for the existence of each installed
component’s key file. If the key file is missing, Windows Installer reinstalls the
missing component. Therefore, if a file that is not the key file of a component is
missing, it may not be restored during repair mode.

Use merge modules Merge modules contain all of the files, registry entries, and logic necessary to
install a distinct piece of functionality. You should not distribute a file for which a
merge module is available. Using merge modules also helps you comply with two
related requirements—the Best Practice to avoid associating a file with more than
one component and the Windows logo guideline not to ship any core
components.

If the Best Practices monitoring option is enabled, the Setup Best Practices
Wizard alerts you whenever you try adding to a component any file that is part of
the merge modules that InstallShield provides.

You should also be aware of the following component creation Setup Best Practices, to which InstallShield does not
automatically alert you:

Table 4-5 • Setup Best Practices for which InstallShield Does Not Automatically Provide Alerts

Best Practice Description

Put a shortcut target in its own Any file that serves as the target for a shortcut requires its own component. That
component file must be the key file for the component.

Group other files into Organize all files that do not fall into any of the above categories in components
components according to the files’ requirements, such as a common destination folder or
version checking.

598 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Table 4-5 • Setup Best Practices for which InstallShield Does Not Automatically Provide Alerts (cont.)

Best Practice Description

Do not self-register files Instead of calling self-registration functions to register and unregister COM server
information, you should register this information for the component during
installation (and the installer will unregister it during uninstallation).

Self-registration is an unreliable method for registering and unregistering files.

One advantage of having the installation register the information is that if the file
is advertised, or not immediately installed, the registration is in place when the
file is later requested from the installer. Therefore, InstallShield supports
advanced settings specifically for registering COM servers.

See Also
Overwriting Files and Components on the Target System

Component Creation
InstallShield 2020

InstallShield offers several methods for creating components.

• Use the Setup Design view (in installation projects only) or the Components view to create a new component and
manually configure it. For more information, see Using the Setup Design or Components Views to Create a
Component.

• Use the Component Wizard to allow InstallShield to define components for you according to Setup Best Practices.
This wizard is available in the following project types: Basic MSI, DIM, InstallScript MSI, and Merge Module. For more
information, see Using the Best Practices Option with the Component Wizard.

• If you are creating a component for a COM server, or a font, it is recommended that you use the Component Wizard.
This wizard is available in the following project types: Basic MSI, DIM, InstallScript MSI, and Merge Module. For more
information, see Using the Component Type Option with the Component Wizard.

Using the Setup Design or Components Views to Create a Component

InstallShield 2020

For installation projects, you can create a new component in the Components view and then associate it later with a
feature, or you can create a component under a specific feature in the Setup Design view, as described below. Note that the
Setup Design view is not available in DIM or Merge Module projects.

Using the Setup Design View to Create a Component

For installation projects only, follow the steps below to create a component in the Setup Design view.

InstallShield 2020 User Guide ISP-2600-UG00 599

Chapter 4
Organizing Files for Your Installation

Task To create a component in the Setup Design view:

1. In the View List under Organization, click Setup Design.

2. In the Setup Design explorer, right-click a feature or subfeature and click New Component, or press CRTL+INSERT.
InstallShield adds a new component with the default name New Component n (where n is a successive number).

3. Enter a new name, or right-click it later and click Rename to give it a new name.

The new component is automatically associated with the selected feature.

Using the Components View to Create a Component

For installation projects, DIM projects, and Merge Module projects, follow the steps below to create a component in the
Components view.

Task To create a component in the Components view:

1. In the View List under Organization, click Components.

2. Right-click the Components explorer and click New Component, or press INSERT. InstallShield adds a new
component with the default name New Component n (where n is a successive number).

3. Enter a new name, or right-click it later and click Rename to give it a new name.

4. For installation projects, associate the component with one or more features.

Note • In installation projects, components that are not associated with a feature are displayed with the orphaned

component icon ( ).

In InstallScript projects, the following characters are invalid in component names:

\ / : * ? " ’ < > |

When you create a component, its property sheet is displayed to the right. You should immediately specify the
component’s properties, including the required Component Code (Windows Installer–based projects only) and Destination
properties.

After you have created a component and specified its properties, you can associate your application’s files, registry entries,
and shortcuts with it.

See Also
Component Settings

Using the Best Practices Option with the Component Wizard

InstallShield 2020

Project • This information applies to the following project types:

600 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The fastest way to create components is to launch the Component Wizard and have InstallShield organize your files into
components for you. Select the Create components for me using best practices option to have the wizard generate
components by applying Setup Best Practices to the files you specify.

Task To launch the Component Wizard, do one of the following:

• For installation projects only: Right-click a feature in the Setup Design view and select Component Wizard.

• For installation projects, DIM projects, and Merge Module projects: Right-click Components in the explorer of the
Components view and click Component Wizard.

See Also
Best Practice Rules for Creating Components

Best Practice Rules for Creating Components

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

When you select the Best Practices option for creating a component through the Component Wizard, the wizard
automatically organizes your files into components based on Setup Best Practices. It creates components according to the
following rules:

• The wizard looks at every file that you add to see if it is already included in your project. If the file is a duplicate, the
wizard does not create a component for it.

• A new component must be created for each portable executable file (.exe, .dll, or .ocx file). The component bears the
name of the portable executable file. The wizard creates a GUID for the Component Code property and sets the
portable executable file as the component’s key file.

• The Component Wizard attempts to extract registration information for each portable executable file. If it succeeds,
the wizard creates a COM server component and writes the data to the component’s COM Server advanced setting.

InstallShield 2020 User Guide ISP-2600-UG00 601

Chapter 4
Organizing Files for Your Installation

• Every help (.hlp) file that you specify will reside in its own component along with its associated contents (.cnt) file. The
component is named after its help file. The wizard creates a GUID for the Component Code property and makes the
help file the component’s key file. The same rule applies to HTML Help (.chm) files and the .chi files that accompany
them.

• The Component Wizard puts all font (.ttf and .ttc) files into a single component called Font Files. The wizard creates a
GUID for the Component Code property and sets the first file in the list as the key file. Any .fon files that you specify will
automatically be included in the AllOtherFiles component that is created. Since .fon files do not have a title, they will
not be added to the Font table in the .msi package. To have these files added as fonts, you will need to use the Fonts
option in the Component Wizard.

• Any files that do not fall into the above categories are grouped into a single component named All Other Files. The
wizard creates a GUID for the Component Code property and sets the first file in the list as the key file.

Letting InstallShield Create a COM Server Component

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

If you select the Create components for me using Best Practices option on the Welcome panel of the Component Wizard,
InstallShield automatically creates a separate component for each portable executable file that you specify. The wizard
also attempts to extract registration information for each portable executable file.

If it succeeds, all of the registration information that maps to the COM Registration advanced setting is written there. The
wizard creates any additional entries, such as the InProcServer32 ThreadingModel value, in the component’s registry data.

Note • If your COM server is an executable, you must put an OLESelfRegister attribute with the value of 1 into the Version
section of the component’s resource file.

See Also
Editing the Registry

Letting InstallShield Create Font Components

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

602 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

If you select the Create components for me using Best Practices option on the Welcome panel of the Component Wizard,
InstallShield automatically creates a separate component for all font (.ttf and .ttc) files that you specify. Any .fon files are
added to the AllOtherFiles component that is created due to the fact that these files do not have an embedded font title. To
have .fon files added to your setup as fonts, use the Fonts option in the Component Wizard.

The destination folder for the font component is set to the destination folder that you chose in the Component Wizard.
After the component is created, you can set its Destination Folder to the Windows Installer folder property FontsFolder
(that is, use [FontsFolder] as the destination), the usual default location for fonts. Place square brackets around
FontsFolder, as you would when specifying [INSTALLDIR].

Task If the font was not registered on your system, you must specify the font title by doing the following:

1. In the View List under Organization, click Setup Design (in installation projects only) or Components.

2. In the explorer, expand the component that contains the font file and click Files. The Files view opens.

3. Right-click the font file and click Properties. The Properties dialog box opens.

4. In the Font title box, type a font title in the format FontName (FontType)—for example, Roman (All res).

5. Click OK.

Using the Component Type Option with the Component Wizard

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

If you have files with special installation requirements, using the Let me select a type and define the component myself
option of the Component Wizard is the recommended method for organizing them into components.

InstallShield 2020 User Guide ISP-2600-UG00 603

Chapter 4
Organizing Files for Your Installation

Task To launch the Component Wizard, do one of the following:

• For installation projects only: In the Setup Design view, right-click a feature and click Component Wizard.

• For installation projects, DIM projects, and Merge Module projects: In the Components view, right-click the
Components explorer and click Component Wizard.

The Let me select a type and define the component myself option of the Component Wizard supports the following
component types:

• COM servers

• Font files

• Install services

• Control services

Note • If you want to create a component that installs, starts, stops, or deletes a service during installation or uninstallation,
you can use the Services view. You can also use this view to configure extended service customization options, which are not
configurable through the Component Wizard. For more information, see Installing, Controlling, and Configuring Windows
Services.

See Also
Component Wizard

Installing COM Servers

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Although you can create a component in one of several ways, the recommended method for installing a COM server (.exe,
.dll, or .ocx) file in an installation is to create a COM server component in the Component Wizard.

The wizard panels displayed depend on the selections you made in previous panels. For example, the Classes panel is not
displayed if the wizard succeeds in extracting the registration information in the COM Server Executable panel.

Tip • InstallShield includes support for 64-bit COM extraction. For more information, see Targeting 64-Bit Operating Systems.

604 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

See Also
Registering COM Servers
Component Wizard

Installing Fonts

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Although you can create a component in one of several ways, the easiest way to install a font (a .ttf, .fon, or .ttc file) in an
installation is to create a Fonts component in the Component Wizard.

In the Component Wizard, the panels that are displayed depend on the selections made in previous panels. For example,
the Add New Fonts panel is not displayed unless you selected I also want to add fonts not installed on this system in the
Add Installed Fonts panel.

See Also
Component Wizard

Exporting Components to Other Projects

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Task To save a component to another project:

1. In the View List under Organization, click Setup Design (in installation projects only) or Components.

2. Right-click the component and click Export Components Wizard.

InstallShield 2020 User Guide ISP-2600-UG00 605

Chapter 4
Organizing Files for Your Installation

Tip • You can also access the Export Components Wizard from the Project menu in InstallShield.

When you export a component into a project, a copy of this component is added to the specified .ism file, along with all of
the component’s data, such as its files, shortcuts, registry entries, and advanced settings. Any string entries, properties,
and path variables used in the dialog are also copied to your new project.

If the target .ism file already has a component of the same name with different properties, the Resolve Conflict dialog box
opens to offer you options for resolving the conflicts.

See Also
Reusing Project Elements

Deleting a Component in Your Project

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

You can permanently delete components in both the Setup Design view and the Components view.

Task To delete a component:

1. In the View List under Organization, click Setup Design (in installation projects only) or Components.

2. Right-click the component and click Delete from project.

The component is permanently deleted from your project.

See Also
Associating New Components with Features

606 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Component-Feature Associations
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• MSI Database
• Transform

A component can be associated with as many features or subfeatures as necessary. For example, a text editor product
might have two features—an editor and a spell checker. Both the editor and spell checker have dependencies that are in a
System .dll files component. When designing this installation, you should associate the System .dll files component with
both the editor and the spell checker features.

You can associate components with features in the Setup Design view. There are two ways to associate components with
features in the Setup Design view, depending on whether or not the component already exists. For more information, see
Associating New Components with Features and Associating Existing Components with Features.

Note • Components that are not associated with a feature are displayed with the orphaned component icon:

Associating New Components with Features

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• MSI Database
• Transform

Task To associate a new component with a feature:

1. In the View List under Organization, click Setup Design.

2. Right-click the feature or subfeature and click New Component or Component Wizard. InstallShield creates a
component and associates it with the selected feature.

InstallShield 2020 User Guide ISP-2600-UG00 607

Chapter 4
Organizing Files for Your Installation

Associating Existing Components with Features

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• MSI Database
• Transform

Task To associate an existing component with a feature:

1. In the View List under Organization, click Setup Design.

2. Right-click the feature or subfeature and click Insert Components.

3. Select the components you want to associate with this feature from the list of components, and click OK.

You can move or copy existing components from one feature to another using a drag-and-drop operation:

• To move an existing component, drag the component from one feature to another.

• To copy an existing component, press CTRL while you drag the component from one feature to another.

Disassociating Components from Features

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• MSI Database
• Transform

Task To remove a component-feature association:

1. In the View List under Organization, click Setup Design.

2. Right-click the component that you want to dissociate from the feature, and click Remove from feature.

Even though the component is no longer associated with this feature, it is still present in your project.

608 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

See Also
Setup Design View

Adding Data to a Component

InstallShield 2020

You can use the Components view to add files, registry data, and shortcuts to components.

Adding Files to Components

InstallShield 2020

All of the files in a component must share the same component settings.

Criteria for Adding Files to a Component

You can add a group of files to a component only if they satisfy all of the following criteria:

• All files have the same destination folder.

• All files should be installed with the same conditions (including operating system and language).

Create new components organized around your files’ installation needs and component properties. You should also be
aware of Setup Best Practices when adding files to a component. Setup Best Practices helps you to write clean installations
and distribute reusable components effectively.

Methods for Adding Files to Components

The way in which you add files to a component varies slightly depending on how you create your component. The sections
below discuss how to associate files with components based on the way in which the component was created.

Creating a New Component in InstallShield

When you create a component by right-clicking in the Setup Design view (for installation projects) or the Components view,
first select the component’s Files item to view its file list.

Task Use one of the following methods to associate files with this component:

• Drag and drop files from Windows Explorer onto the file list.

• Right-click in the file list and click Add. In the resulting dialog box, browse to select as many files as you want to add
from that folder. Click Open.

Creating a New Component Using the Component Wizard

If you use the Component Wizard to create a component, you can add files to the component in the Files panel.

Task Use one of the following methods to associate files with this component:

• Drag and drop files from Windows Explorer onto the file list.

InstallShield 2020 User Guide ISP-2600-UG00 609

Chapter 4
Organizing Files for Your Installation

• Right-click in the file list and click Add. In the resulting dialog box, browse to select as many files as you want to add
from that folder. Click Open.

InstallShield creates links to your application’s files. These links are used to locate the files when you build a release of your
installation. If any of these links becomes invalid, File Not Found appears next to the file.

All of the above methods for adding files link the files statically, which means that the file links do not change if new files
are added to or removed from the source folder. For an alternative to static linking, see Adding Dynamic File Links to
Components.

See Also
Setup Best Practices

Changing the Value in the Link To Column for a Component’s File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

In the Components view, you can expand a component to display the Files node, which shows the files associated with that
component. In the Files explorer, the Link To column provides the directory or the path variable that you used when you
added the file. You can use the Direct Editor to change what appears in this column.

Task To edit the directory:

1. In the View List under Additional Tools, click Direct Editor.

2. In the Tables explorer, click File.

3. Locate the file and edit the value in the ISBuildSourcePath column.

See Also
Direct Editor

Deleting a File from a Component

InstallShield 2020

Project • This information applies to the following project types:

610 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

Task To delete a file from a component:

1. In the View List under Organization, click Components.

2. In the Components explorer, expand the component that contains the file that you want to delete, and then click
Files item under it. The files associated with that component are displayed in the right pane.

3. Right-click the file that you want to delete and click Delete.

Adding Registry Data to Components

InstallShield 2020

You can use the Registry view to add registry keys and values to a component. This information is written to the target
system’s registry if the component is installed. To learn how to add registry keys and values, see the following:

• Creating Registry Keys

• Dragging and Dropping Registry Entries to Create Registry Keys

• Creating Registry Values

• Importing Registry Files

• Exporting Registry Files

Creating Shortcuts in the Components View

InstallShield 2020

Project • For installation projects, you can create shortcuts in the Shortcuts view.

Before you can create a shortcut, you must create a component that contains the file to which the shortcut is going to link.

InstallShield 2020 User Guide ISP-2600-UG00 611

Chapter 4
Organizing Files for Your Installation

Task To create a new shortcut:

1. In the View List under Organization, click Components.

2. In the Components explorer, expand the component that should be associated with the shortcut that you are
creating, and then click Shortcuts. The Shortcuts explorer opens in a new pane.

3. In the Shortcuts explorer, right-click a destination folder and click either New Folder or New Shortcut. You can
create a program folder if you want your shortcut to appear under your company name, for example.

If you created a folder for your shortcut, create the shortcut by right-clicking your new folder and clicking New
Shortcut.

4. Define the shortcut’s properties.

See Also
Shortcuts View
Creating Shortcuts and Program Folders

Adding Subfolders to Statically Linked Components

InstallShield 2020

Project • This information applies to InstallScript projects.

Task To add a subfolder to a statically linked component:

In the Components or Setup Design view, right-click the component’s Static File Links subnode and then click New
Folder.

Component Key Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

612 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

One of your component’s files can serve as its key file. A key file is a file that the Windows Installer uses to detect the
component’s presence on the target machine and determine whether it needs to be updated. In order to create advanced
component settings or shortcuts, a key file must be specified.

Caution • If your project includes dynamically linked files, InstallShield may automatically set some of the dynamically linked
files as the key file of a component. For more information, see Determining the Appropriate Component Creation Method for
Dynamically Linked Files.

See Also
Setting Key Paths for Components
Overwriting Files and Components on the Target System

Setting Component Key Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Task To specify one of your component’s files as the key file:

1. In the View List under Organization, click Setup Design (in installation projects only) or Components.

2. In the explorer, expand the component and click Files.

3. Right-click in the files list and click Set Key File. The file icon ( ) for that file is replaced with a key icon ( ).

A component can have either one key file or one key path. If you have already set a key file or a key path for a component, a
warning message box appears if you try to set another key file. Click Yes in the message box to replace the existing key file
or key path with the new key file.

Note • You cannot specify a key file in the Files and Folders view. Key files must be set in either the Setup Design or
Components view.

See Also
Setting Key Paths for Components
Overwriting Files and Components on the Target System

InstallShield 2020 User Guide ISP-2600-UG00 613

Chapter 4
Organizing Files for Your Installation

Clearing a Key File from a Component

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

If you no longer want a file to serve as the component’s key file, you can clear the key file from that component.

Task To clear the key file from a component:

1. In the View List under Organization, click Setup Design (in installation projects only) or Components.

2. In the explorer, expand the component and click Files.

3. Right-click the key file and click Clear Key File.

Component Settings
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

When you create a component, its settings have default values, depending on whether you created the component using a
view, or using a wizard.

614 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Task To edit a component’s settings:

1. In the View List under Organization, click Setup Design (in installation projects only) or Components.

2. Click the component that you want to configure, and modify its settings as needed.

For descriptions of each of the settings, see Component Settings.

See Also
Components View

Component Destination vs. Feature Destination

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Note that DIM, Merge Module, and MSM Database projects do not include features. These types of projects are added to
features in Basic MSI projects. Thus, components in DIM, Merge Module, and MSM Database projects are associated with the
features in the installation projects that consume them.

Both components and features have a destination setting, but there are some differences in how they are used when an
end user runs your installation.

Allowing End Users to Change the Destination

You can use the feature’s destination setting if you want to allow the end user to modify where the feature is installed on
the target system. Because a feature’s destination can be changed by the end user, you must use a public property for the
feature destination. A public property has a name with only uppercase letters (for example, INSTALLDIR).

Note • If you want all the components in a feature to be installed to the feature’s destination, you must set all of the
components’ destinations to match the feature’s destination.

Setting a Specific Destination

If you want a component to go to a specific location that cannot be changed by the end user, you must set the component
destination to some directory that is not used as a feature destination.

InstallShield 2020 User Guide ISP-2600-UG00 615

Chapter 4
Organizing Files for Your Installation

See Also
Setting a Destination Folder for the Component’s Files
Setting a Feature’s Destination

Setting a Destination Folder for the Component’s Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

Each component can have a different destination location for its files. The default value for the Destination setting is as
follows:

• For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, and MSM Database, and Transform projects—
INSTALLDIR, initialized to [ProgramFilesFolder]Company Name\Product Name in the product’s INSTALLDIR property

• For InstallScript and InstallScript Object projects—TARGETDIR, initialized by default to PROGRAMFILES ^

IFX_COMPANY_NAME ^ IFX_PRODUCT_NAME in the default script code for the OnFirstUIBefore event handler function

Windows Logo • According to Windows logo requirements, the default destination of your application’s files must be a
subfolder of the end user’s Program Files folder. If you use INSTALLDIR or ProgramFilesFolder as the parent folder for your
feature’s Destination setting, your files will be installed to the correct location.

Task To change the component’s destination folder:

1. In the View List under Organization, click Setup Design (installation projects only) or Components.

2. Select the component whose destination you want to change.

3. In the Destination setting, select one of the options from the list, or click the ellipsis button (...) to select or create a
directory.

Other Destination Folder Considerations

Project • These considerations apply to the following project types:

• Basic MSI

616 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Component’s Remote Installation Setting

Setting the component’s Remote Installation setting to Favor Source (or to Optional when the component’s feature is set
to Favor Source) means that the component’s files will not be installed on the target system, regardless of the component’s
Destination setting.

Feature’s Remote Installation Setting

Each feature also has a Destination setting. If different, the component’s Destination setting overrides the feature’s
destination. The feature’s Destination setting is optional, but the component’s is required.

INSTALLDIR as Default Destination

The assumption behind using INSTALLDIR as the default Destination setting for all of your features and components is that
you want all of your application’s files installed to the same root folder. This way, when an end user changes the
destination folder for any of the features in the CustomSetup dialog, the destination folders for all of the features that are
set to be installed to the path contained in INSTALLDIR also change.

Note • If the component’s destination is set to something other than INSTALLDIR, the components are installed to the
destination specified for each component and changing INSTALLDIR has no effect on the components’ destinations.

An installer folder property such as INSTALLDIR specifies a default value. An end user can change this value by setting a
property when launching Msiexec.exe at the command line or by selecting a new destination folder for a feature in the
CustomSetup dialog.

[GlobalAssemblyCache] for Components Containing a .NET Assembly

If a component contains a .NET assembly, you can set the component’s destination to [GlobalAssemblyCache]. When a
.NET assembly is installed to a target system’s Global Assembly Cache (GAC), the assembly can be accessed by other
applications on the system.

In general, it is preferable to install assemblies to the local application directory. This increases application isolation.

Note • To install an assembly to the Global Assembly Cache, the .NET Scan at Build setting for the assembly’s component
must be set to either Properties Only or Dependencies and Properties.

See Also
MsiExec.exe Command-Line Parameters
CustomSetup Dialog Options
Windows Installer Property Reference
Scanning for .NET Dependencies and Properties

InstallShield 2020 User Guide ISP-2600-UG00 617

Chapter 4
Organizing Files for Your Installation

Specifying a Component’s Destination from the Script

InstallShield 2020

Project • This information applies to InstallScript projects.

Specifying the target destination of a component’s files from the script lets you change that destination at run time based
on end-user input or other conditions.

Task To specify the target destination of a component’s files from the script:

1. In the View List under Application Data, click Files and Folders.

2. In the Destination computer’s folders pane, right-click Script-defined Folders and click New Folder. InstallShield
adds a subfolder with the default name <NEW VARIABLE N>, where N is a successive number. You can rename this
subfolder to any string that is enclosed in angle brackets; for example, <My Script-defined Folder>.

3. To specify the target destination of an existing component’s files:

a. In the View List under Organization, click Components or Setup Design.

b. Select the component that you want to configure.

c. In the component’s property grid, click the value of the Destination property and in the list, select the name of
the subfolder that you created in step 1.

To create a new component and specify the target destination of its files:

a. In the Files and Folders view, drag the desired file or files from the Source computer’s folders pane and drop
them on the subfolder that you created in step 1. InstallShield creates a new component with the default name
FilesN.

b. In your script, call FeatureSetTarget to assign a target location to the subfolder that you created in step 1; for
example:

AskDestPath( "" , "Choose a location for the XYZ files." , svEndUserSelectedPath, 0 );

FeatureSetTarget( MEDIA , "<My Script-defined Folder>" , svEndUserSelectedPath);

Uppercase Directory Identifiers and Component Destinations

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

618 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• Transform

Declaring a Directory Identifier in uppercase letters makes that value a public property that can be set from the user
interface. In order to allow the end user or administrator to change the destination via the user interface or from the
command line, the Directory Identifier for the component’s destination must be a public property.

Using mixed-case or lowercase letters for the Directory Identifier defines the directory entry as a private property. Private
properties cannot be changed from the user interface.

Specifying Whether a Component’s Files and Other Associated Data Are Uninstalled During
Uninstallation
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

You may need to ensure that a component’s files, registry entries, shortcuts, and other data are not uninstalled when end
users uninstall your product. Following are examples of scenarios where it may be appropriate to ensure that a
component’s data are not uninstalled:

• You want to prevent the uninstallation of files that may be used by other products.

• The component contains a font.

• The component is being installed to [SystemFolder]. According to validation rules, if a component is installed to this
location, it should not be uninstalled during uninstallation.

The setting that controls whether the component’s data are uninstalled depends on which project type you are using.

Task To specify whether a component’s files, registry entries, and other data are uninstalled:

1. In the Setup Design view (installation projects only) or the Components view, select the component that you want to
configure. InstallShield displays its settings in the right pane.

2. In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—Configure
the Permanent setting as appropriate:

• If the component data should not be uninstalled when end users uninstall the product, select Yes.

• If the component data should be uninstalled, select No.

InstallShield 2020 User Guide ISP-2600-UG00 619

Chapter 4
Organizing Files for Your Installation

In InstallScript and InstallScript Object projects—Configure the Uninstall setting as appropriate:

• If the component data should not be uninstalled when end users uninstall the product, select No.

• If the component data should be uninstalled, select Yes.

The Permanent and Uninstall settings apply to all types of data that are associated with a component. This includes files,
registry entries, shortcuts, XML file changes, and SQL scripts.

Configuring Component Conditions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Conditional installation of your components can be useful if you are creating different versions of the same product—for
example, a trial version and a full version. You might not want to provide full functionality in the trial version, therefore you
would not install all of the components. Another use for conditional component installation is to save disk space. If the
target system does not have enough disk space for all of the components, you can set non-required components to install
conditionally.

Using the component’s Condition setting, you can enter a statement that the installation must evaluate before setting up
your component’s data on the target system. The component is not installed if its condition evaluates to false. However,
the component is installed or advertised if its condition evaluates to true, assuming that its feature is selected for
installation.

Task To set a condition for a component in your project:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. Select the component that you want to configure.

3. Click the Condition setting and then click the ellipsis button (...). The Condition Builder dialog box opens.

4. Do one of the following:

• In the Conditions box, type the component condition.

• Use the Properties list, the Operators list, and the Add buttons to build your condition:

a. In the Properties list, select a property and then click the Add button. InstallShield adds the property to the
Condition column.

620 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

b. If your conditional statement should contain an operator, select an operator in the Operators list and then
click the Add button. InstallShield adds the operator to the conditional statement.

c. If your conditional statement should contain a value, enter the value.

5. Click OK.

Important • InstallShield performs basic condition validation; however, you should still double-check that your condition
statements evaluate to the expected outcome. For more information and example conditions, see Building Conditional
Statements.

See Also
Condition Builder Dialog Box
Reevaluating Component Conditions During Reinstallation
Conditional Statement Syntax
Setting Feature Conditions

Reevaluating Component Conditions During Reinstallation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Windows Installer evaluates a component’s condition again when a product is reinstalled if you select Yes for the
component’s Reevaluate Condition setting. If the condition evaluates to true upon reinstallation, the component is
reinstalled—or installed for the first time if the condition initially evaluated to false or if the component was never selected
for installation.

Transitive Components
Components that were installed but whose conditions evaluate to false upon reinstallation are removed. Because of this
special feature, which allows you, in effect, to swap components during reinstallation, components with Yes selected for
the Reevaluate Condition setting are considered transitive components.

Consider an application that requires a different .dll file depending on whether it is installed on Windows XP or Windows
Vista. You could create a component for each file and attach a condition to each component to check the version of the
operating system. The component for Windows Vista would have the following condition:

VersionNT=600

The Windows XP–specific component might have the following condition:

InstallShield 2020 User Guide ISP-2600-UG00 621

Chapter 4
Organizing Files for Your Installation

VersionNT<600

When the product is installed on a Windows XP system, the appropriate version of the .dll file is installed and the Windows
Vista version is not. What happens if the end user upgrades to Windows Vista? When the product is reinstalled, the Windows
XP–specific component is uninstalled, and the Windows Vista–specific component is installed (as long as these
components are both transitive).

See Also
Configuring Component Conditions
Using Transitive Components (Windows Installer Help Library)
Using Transitive Components (Windows Installer Help Library)

Managing Reference Counts for Shared Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

A file’s reference count (also referred to as refcount) is the number of products on a target system that use the file.
Reference counts help to ensure that if multiple products are sharing a file, the file remains on the target system until all of
the products that share it are removed.

Reference counts for shared files are stored in the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\SharedDLLs

Both Windows Installer–based projects and InstallScript-based projects include support for managing the reference counts
for shared files. The functionality is slightly different, depending on the project type.

Behavior in Windows Installer–Based Installations

In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects, you can indicate
that a key file is shared by selecting Yes for the Shared setting of the key file’s component. If the installation installs the key
file and Yes is selected for the component’s Shared setting, a reference count is created in the registry—if it does not
already exist—and incremented. During uninstallation of the key file, the reference count is decremented.

Windows Logo • Windows logo guidelines require that the reference count be incremented when installing shared files and
decremented when uninstalling. Core component files (which they recommend you not install) should not be reference
counted.

622 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Behavior in InstallScript-Based Installations

In InstallScript and InstallScript Object projects, you can mark a component as shared. If the installation installs the
component’s files and Yes is selected for the component’s Shared setting, a reference count for each file is created in the
registry—if it does not already exist—and incremented. During uninstallation of the component, the reference count is
decremented.

You can call the InstallScript function GetFileInfo with the FILE_SHARED_COUNT constant to determine an existing file’s
reference count.

How to Mark a Component as Shared

Task To specify that a component’s key file (in a Windows Installer–based project) or that a component (in an InstallScript-
based project) is shared:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. Select the component that you want to configure.

3. For the Shared setting, select Yes.

Tip • One example of when you should always mark a component as shared is if its files are to be installed to a shared
directory such as the System folder or the Common Files folder.

Note • Note that the installation increments any existing reference count for any file in a component regardless of whether
you mark the component as shared. However, if no reference count exists, the installation does not create one unless you
select Yes for this Shared setting.

Checking File Versions Before Installing

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

For InstallScript projects, this functionality is handled by the component’s Overwrite setting. When you click the ellipsis button
(...) in this setting, the Overwrite dialog box opens, enabling you to specify whether files of the component should overwrite
existing files on the target system.

InstallShield 2020 User Guide ISP-2600-UG00 623

Chapter 4
Organizing Files for Your Installation

The Never Overwrite setting for a component enables you to indicate whether you want your installation to overwrite a
file if it already exists on the target system:

• If you select Yes, the file—if it exists on the target system—is never overwritten, regardless of the file version. Selecting
Yes for this setting overrides file versioning rules.

• If you select No and the file version on the target system is newer than the version being installed, the file on the target
system is not overwritten. However, if the version being installed is newer, the file on the target system is overwritten.

Windows Installer checks for the existence of the component’s key file when determining if it should install the component.
For more information, see Overwriting Files and Components on the Target System.

Installing Files of the Same Name

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

The Source Location setting for a component identifies a subfolder where the component’s files will be stored in the source
disk images, if the component’s files are not compressed. The component’s files will be copied to this subfolder in your
release image.

The Source Location setting does not require a value, and in most cases, it can be left blank. If you enter a value, it must be
a valid Windows folder name.

One instance where the Source Location setting could be used is when you are creating an installation that contains more
than one language. In this scenario, you can have multiple files with the same name. You can create a component for each
language and configure the Source Location setting as needed for each one. When you use the Source Location setting, any
file with the same name can be copied onto the disk in two different locations, without the risk of being overwritten.

For example, create two components called German and English. For the first component’s Source Location setting, enter
GermanVersion. For the second component’s Source Location setting, enter EnglishVersion. Create two files called
Test.txt, giving them slightly different contents. Assign each file to a component.

When you build your installation with uncompressed files, two separate folders on the disk images will be created, one
called GermanVersion and one called EnglishVersion. Separate versions of Test.txt will be copied to each of these folders,
but neither copy will be overwritten.

Note • The Source Location setting is not the same as the destination location. While it is conceivable that you might want to
copy both versions of the file to the end user’s machine, it is more likely that you would want to filter the files by language.

See Also
Adding Files to Components
Working with Releases

624 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Setting a Component’s Remote Installation Setting

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The Remote Installation setting for a component determines whether the component’s files are installed on the target
system or run from the source medium, such as a CD-ROM or network server. The default value for a new component is
Favor Local, which means that the component’s files are installed on the target system.

Task To change this value so the component’s files run only from the source medium:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. Select the component that you want to configure.

3. In the Remote Installation setting, select Favor Source. Selecting Optional gives this component the Remote
Installation setting of its feature.

The component’s Remote Installation setting overrides the feature’s. For more information, see Component’s Remote
Installation Setting vs. Feature’s Remote Installation Setting.

Caution • If the component contains a Windows service, select the Favor Local option. Although an end user could change the
feature’s installation state through the CustomSetup dialog, the Windows Installer cannot install a service remotely.

See Also
Setting a Feature’s Remote Installation Setting
CustomSetup Dialog Options

Component’s Remote Installation Setting vs. Feature’s Remote Installation Setting

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 625

Chapter 4
Organizing Files for Your Installation

• Transform

The component’s Remote Installation setting always overrides the feature’s Remote Installation setting. For example, if a
component’s Remote Installation setting is set to Favor Local, its files are installed on the target system regardless of the
feature’s Remote Installation setting.

The files are run from the source medium when a component’s Remote Installation setting is set to Favor Source. If you
want a component’s feature to dictate whether the files run from the source medium, select Optional for the component’s
Remote Installation setting.

When a component is associated with more than one feature and Optional is selected for the component’s Remote
Installation setting, the files are installed locally if any of its features is set to Favor Local. If the component is set to Favor
Local or Favor Source, the files are installed accordingly.

See Also
Setting a Component’s Remote Installation Setting
Setting a Feature’s Remote Installation Setting

Extracting COM Registration Data at Build Time

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

By selecting Yes for a component’s COM Extract at Build setting, you indicate that you want InstallShield to scan the
component’s key file for COM registration data whenever you build a release that contains that component. The extracted
information is placed into the release so that Windows Installer registers the COM server when it is installed or advertised.
All the necessary registry settings made by the component are extracted when you select Yes for this setting.

Unlike the Component Wizard, the build process does not write the extracted COM information to the project (.ism) file.
Instead, it is dynamic, in that it is updated each time that you rebuild. It also means that you can rebuild an existing release
through InstallShield or the command line even when you do not have write access to the project file.

Note • The PATH system variable on the build machine must be set to include the directories of all of the .dll files to which the
COM server links; otherwise, the file will fail to register and COM information will not be extracted.

The build feedback (displayed in the Output window and in the build log files) details the registration information that was
extracted.

Tip • If you are using InstallShield on a 64-bit system, InstallShield can extract COM data from a 64-bit COM server. In order to
install the data to the correct locations, the component must be marked as 64 bit. To learn more about 64-bit support, see
Targeting 64-Bit Operating Systems.

626 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Resolving Conflicts
Despite selecting Yes for the COM Extract at Build setting, you can still specify COM information under the component’s
COM Registration advanced setting and in the component’s Registry explorer. The existing information will always be
registered when the component is installed.

If entries are detected under COM Registration, InstallShield asks you if you want to delete them if Yes is selected for the
COM Extract at Build setting. If any conflicts are found during the build, you receive a warning about the item in the
advanced setting that was overwritten with the dynamically acquired data.

Even with these safeguards, you might want to check the COM Registration advanced setting and the component’s registry
data to verify that the entries are intentional and do not conflict with the data extracted at build time.

See Also
Working with Releases
Building a Release from the Command Line
Registering COM Servers
Extracting COM Data When Files Are Added

Scanning for .NET Dependencies and Properties

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

InstallShield lets you indicate that a component should be scanned for .NET dependencies and properties at build time.
The functionality depends on the project type that you are using.

Windows Installer–Based Projects

In Basic MSI, DIM, InstallScript MSI, and Merge Module projects, you can use the .NET Scan at Build setting to indicate
whether you want a component’s key file to be scanned for .NET dependencies and properties at build time.

Note • The build-time scan does not scan the key file of a component if the key file is not a .NET assembly file.

InstallShield 2020 User Guide ISP-2600-UG00 627

Chapter 4
Organizing Files for Your Installation

Several options are available from the .NET Scan at Build setting for a component:

Table 4-6 • Options for the .NET Scan at Build Setting in Windows Installer–Based Projects

Option Description

None InstallShield does not scan the key file of this component for .NET dependencies
or properties.

Properties Only At build time, InstallShield scans the key file of this component for .NET
properties. InstallShield populates the MsiAssembly and MsiAssemblyName
tables with the assembly properties, as needed.

Dependencies and Properties At build time, InstallShield scans the key file of this component for .NET
dependencies and properties. InstallShield populates the MsiAssembly and
MsiAssemblyName tables with the assembly properties, as needed. In addition,
InstallShield adds the missing files, components, and merge modules that are
required by the .NET assembly to the release.

Note • To install an assembly to the Global Assembly Cache, the .NET Scan at Build setting must be set to either Properties
Only or Dependencies and Properties.

This setting affects how the Static Scanning Wizard scans the files in your project.

InstallScript-Based Projects
In InstallScript and InstallScript Object projects, you can use the .NET Scan at Build setting to indicate whether you want a
component’s files to be scanned for .NET dependencies at build time.

Several options are available from the .NET Scan at Build setting for a component:

Table 4-7 • Options for the .NET Scan at Build Setting in InstallScript-Based Projects

Option Description

None InstallShield does not scan the files of this component for .NET dependencies.

Dependencies InstallShield scans the files of this component for .NET dependencies.
InstallShield adds the missing dependencies to the release.

See Also
Identifying Properties and Dependencies of .NET Assemblies
MsiAssembly Table (Windows Installer Help Library)
MsiAssembly Table (Windows Installer Help Library)
MsiAssemblyName Table (Windows Installer Help Library)
MsiAssemblyName Table (Windows Installer Help Library)

628 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Specifying the .NET Application File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

The .NET Application File setting is used when the component is scanned at build time (based on the .NET Scan at Build
setting) or by the Static Scanning Wizard. The scanner uses this setting—along with the component destination—to
determine the value of the File Application setting for the assembly.

The scanning algorithm works in the following way to configure the .NET assembly’s File Application setting:

1. The scanning algorithm checks the component’s Destination setting. If the value is [GlobalAssemblyCache], the .NET
assembly’s File Application setting is set to null.

2. If the component’s destination is something other than [GlobalAssemblyCache], the scanning algorithm checks the
component’s .NET Application File setting. If this value is not null, the value of this setting is used to set the assembly’s
File Application setting.

3. If the component’s destination is something other than [GlobalAssemblyCache] and the .NET Application File setting
is null, the component’s key file is used to set the assembly’s File Application setting.

See Also
Static Scanning
Static Scanning Wizard
Component Settings

Reading Properties Passed to the .NET Installer Class

InstallShield 2020

This is an example of a .NET class that implements the installer class and demonstrates how to read properties that are
passed to the installer class from the installation.

using System;
using System.Configuration.Install;
using System.Windows.Forms;
using System.Collections;

namespace MyInstall
{
///
/// Summary description for Class1.
///
[System.ComponentModel.RunInstallerAttribute(true)]
public class MyInstallClass : Installer
{
public MyInstallClass()
{

InstallShield 2020 User Guide ISP-2600-UG00 629

Chapter 4
Organizing Files for Your Installation

}
public override void Install(IDictionary stateSaver)
{

base.Install(stateSaver);
foreach(string strKey in Context.Parameters.Keys)
{
MessageBox.Show(strKey + " is " + Context.Parameters[strKey]);
}
}

public override void Commit(IDictionary stateSaver)

{
base.Commit(stateSaver);
foreach(string strKey in Context.Parameters.Keys)
{
MessageBox.Show(strKey + " is " + Context.Parameters[strKey]);
}
}

public override void Uninstall(IDictionary stateSaver)

{
base.Uninstall(stateSaver);
foreach(string strKey in Context.Parameters.Keys)
{
MessageBox.Show(strKey + " is " + Context.Parameters[strKey]);
}
}

public override void Rollback(IDictionary stateSaver)

{
base.Rollback(stateSaver);
foreach(string strKey in Context.Parameters.Keys)
{
MessageBox.Show(strKey + " is " + Context.Parameters[strKey]);
}
}
};
}

See Also
.NET Installer Class Arguments Dialog Box

Enabling and Disabling Registry Reflection

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

630 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• Transform

Registry reflection keeps the 32-bit registry view and the 64-bit registry view in sync on the target machine.

Note • Only 64-bit systems with Windows Installer 4 and later support registry reflection. In addition, only Windows Vista and
later and Windows Server 2008 and later support it.

If an end user installs a 64-bit application that has a component with registry reflection enabled, Windows Installer makes
the associated registry changes in the 64-bit view of the registry, and the reflector copies the registry changes to the 32-bit
registry view. Similarly, if an end user then installs a 32-bit application that modifies the same registry key or value,
Windows Installer makes the associated registry changes in the 32-bit view of the registry, and the reflector copies the
registry changes to the 64-bit registry view.

If registry reflection is disabled, Windows Installer calls the RegDisableReflectionKey function on each key being accessed
by the component. This function disables registry reflection for the specified key. Disabling reflection for a key does not
affect reflection of any subkeys.

Task To enable or disable registry reflection for all new and existing registry keys that are affected by a component:

1. In the View List under Organization, click Components.

2. In the Components explorer, select the component for which you want to configure the registry reflection setting.

3. To enable registry reflection, set the Disable Registry Reflection setting to No. This is the default value.

To disable registry reflection, set the Disable Registry Reflection setting to Yes.

For more information about registry reflection, see Registry Reflection in the MSDN Library.

Specifying Whether Shared Component Patching Should Be Enabled for a Component

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

InstallShield lets you specify whether you want to enable shared component patching for a component. By default, it is
disabled.

If this multiple-package sharing feature were enabled in at least one package that is installed on the target system,
Windows Installer 4.5 treats the component as shared among all of those packages. If a patch that shares this component is
uninstalled, Windows Installer can continue to share the highest version of the component’s files on the system.

The purpose of this multiple-package component sharing is to prevent files from being downgraded during the
uninstallation of a patch that contains a component that is shared with one or more other installed packages. The intent is
to keep the highest version of the component’s files present on the machine after uninstallation of that patch.

InstallShield 2020 User Guide ISP-2600-UG00 631

Chapter 4
Organizing Files for Your Installation

Note • If the DisableSharedComponent policy is set to 1 on a target system, Windows Installer ignores this setting for all
packages.

Windows Installer 4.0 and earlier ignore this setting.

The following diagram illustrates an example of two products, ABC and XYZ, that share a component that contains a file
called file.dll. An end user installs product ABC first, and version 1.0.0.0 of file.dll in the shared component is installed. Next,
the end user installs product XYZ, which includes version 1.1.0.0 of file.dll. Since this version is higher than the file that was
installed for product ABC, Windows Installer overwrites the current version with version 1.1.0.0. Then, the end user installs
an uninstallable patch for product ABC. This patch contains version 1.2.0.0 of file.dll. Since this version is higher than the
one that is already present on the target system, Windows Installer overwrites the current version with version 1.2.0.0. If
the end user uninstalls the patch, either of the following results may occur:

• If the value of the Multiple Package Shared Component setting is Yes for either product ABC or product XYZ and if
Windows Installer 4.5 is present, uninstalling the patch from product ABC could restore version 1.1.0.0 to the target
system.

• If the value of this setting is No for product ABC and product XYZ, the file would be downgraded to version 1.0.0.0, even
though product XYZ used 1.1.0.0. As a result, if product XYZ requires version 1.1.0.0, product XYZ may no longer work
properly.

632 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Figure 4-1: If the Multiple Package Shared Component setting for the shared component is set to Yes in either package
and if Windows Installer 4.5 is present, version 1.1.0.0 of the file may be restored. Otherwise, the file may be unintentionally
downgraded to version 1.0.0.0.

InstallShield 2020 User Guide ISP-2600-UG00 633

Chapter 4
Organizing Files for Your Installation

Task To specify whether to enable shared component patching for a component:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. Select the component that you want to configure.

3. Select the appropriate value for the Multiple Package Shared Component setting:

• To enable shared component patching, select Yes. InstallShield sets the msidbComponentAttributesShared
attribute of the selected component to indicate that it should be shared.

• To disable shared component patching, select No. InstallShield does not set the
msidbComponentAttributesShared attribute of the selected component. However, if this component is shared
with another package, the msidbComponentAttributesShared attribute may be set for this component in that
package. Therefore, Windows Installer 4.5 would consider the multiple-package component to be shared.

Advanced Component Settings

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The Advanced Settings area under a component in the Components view (and in the Setup Design view) enables you to
fulfill installation requirements for special component types. For example, when you copy an .ocx file to the target system,
you must register its classes, ProgIDs, and type libraries so that the file’s methods can be properly accessed. Advanced
settings use Windows Installer’s built-in functionality for registering COM servers; setting up ODBC drivers, data sources,
and translators; installing, controlling, and configuring Windows services; and registering a file association.

By specifying the advanced settings, you can publish your component and register COM servers, file extension servers, and
MIME types. If the component is selected, an advanced setting is made on the target system when the component is
installed or advertised. That way, the file is ready to execute once it is installed. Publishing components—a type of
advertising—is accomplished through the Publishing advanced setting.

Configuring COM Registration Settings Manually

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

634 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Important • The recommended method for installing a COM server is to have Windows Installer register its classes, ProgIDs,
and so on. Calling self-registration functions violates Setup Best Practices.

It is recommended that you avoid using the TypeLib table. For more information, see TypeLib Table in the Windows Installer
Help Library.

The easiest way to populate the COM Registration advanced setting is to have the Component Wizard extract the necessary
information or extract COM data for a key file. (You can also have it extracted dynamically at build time, in which case you
do not need to use this advanced setting.) It is recommended that you modify the COM Registration advanced setting or
create COM entries in the component’s Registry explorer only if you are familiar with the technical details behind your file’s
registration.

Task To install a COM server solely through editing the component’s advanced settings:

1. Ensure that a single COM server is added to the component. The file must be a single portable executable file (such as
an .exe, .dll, or .ocx file), according to Setup Best Practices.

2. Make the COM server the component’s key file.

3. For the component’s COM Extract at Build setting, select No.

4. Expand the component’s Advanced Settings item to view all of the advanced settings.

5. Click COM Registration to configure COM server information.

Right-click one of the items in the COM Registration explorer to modify or to create registration information for your COM
server. Right-click an item and click Rename to rename the new item.

Note • The PATH system variable on the build machine must be set to include the directories of all of the .dll files to which the
COM server links; otherwise, the file will fail to register and COM information will not be extracted.

Configure the settings for each registration item or subitem that you create. More help is available in the help pane in
InstallShield when you click each registration setting.

See Also
Setup Best Practices
Setting Component Key Files
Extracting COM Data When Files Are Added
Installing COM Servers
Extracting COM Registration Data at Build Time
Registering COM Servers
COM Registration Settings

InstallShield 2020 User Guide ISP-2600-UG00 635

Chapter 4
Organizing Files for Your Installation

Configuring COM Classes for COM Registration Manually

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Task To register a class ID:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component, and under Advanced Settings, select COM Registration. The COM
Registration explorer appears in a separate pane.

3. In the COM Registration explorer, right-click COM Classes and click New COM Class.

4. Type a new name for the COM class if needed. The name that you give the COM class will be registered as the default
value under HKEY_CLASSES_ROOT\CLSID\<GUID>. To give the class a new name, right-click it and click Rename.

5. Click the new COM class to configure its settings.

6. Specify a context type for this class. The following list tells you which server context is appropriate for which type of
COM server:

• LocalServer32—32-bit .exe file

• LocalServer—16-bit .exe file

• InprocServer32—32-bit .dll or .ocx file

• InprocServer—16-bit .dll or .ocx file

If the server context is LocalServer or LocalServer32, click the context to configure the Default Inproc Handler and
Argument settings.

See Also
Configuring COM Registration Settings Manually
COM Registration Settings

Configuring ProgIDs for COM Registration Manually

InstallShield 2020

Project • This information applies to the following project types:

636 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

A progID is a string used to identify a class in the format Component.Class.N.

Task To specify a new programmatic identifier:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component, and under Advanced Settings, select COM Registration. The COM
Registration explorer appears in a separate pane.

3. In the COM Registration explorer, right-click ProgIDs and click New ProgID.

4. Type a new name for the ProgID. Use the format Component.Class.N. To give the class a new name, right-click it and
click Rename.

5. Click the new ProgID to configure its settings.

Version-Independent ProgIDs
A version-independent progID is a string used to identify a class in the format Component.Class, which is constant for all
versions of a class.

Task To specify a new version-independent programmatic identifier:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component, and under Advanced Settings, select COM Registration. The COM
Registration explorer appears in a separate pane.

3. In the COM Registration explorer, right-click Version-Independent ProgIDs and click New ProgID.

4. Type a new name for the ProgID. Use the format Component.Class. To give the class a new name, right-click it and
click Rename.

See Also
Configuring COM Registration Settings Manually
COM Registration Settings

Configuring Type Libraries for COM Registration Manually

InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 637

Chapter 4
Organizing Files for Your Installation

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Important • It is recommended that you avoid using the TypeLib table. For more information, see TypeLib Table in the
Windows Installer Help Library.

Task To specify a type library or libID:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component, and under Advanced Settings, select COM Registration. The COM
Registration explorer appears in a separate pane.

3. In the COM Registration explorer, right-click Type Libraries and click New Type Library.

4. Type a new name for the type library, or libID, referenced by this COM server. The name that you give the type library
item is registered as the default value under HKEY_CLASSES_ROOT\TYPELIB\<libID>\<version>. Use the format
Component.Class. To give the class a new name, right-click it and click Rename.

5. Click on the type library to configure its settings.

See Also
Configuring COM Registration Settings Manually
COM Registration Settings

Registering a File Extension

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

638 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

If your application manipulates files with a unique file extension, you can register your file type in the File Types area, which
is available as an advanced setting within the Components view and the Setup Design view (for installation projects only).
For example, if your application manipulates files with the .xyz extension, registering the file type instructs the operating
system to open the file with your application when the user double-clicks its icon.

This advanced setting registers the following information about a file type on the target system when the component is
installed or advertised:

Table 4-8 • File Type Information

Information Registered Description

File Extensions You can associate file extensions (such as .doc and .txt) with the component’s key
file.

ProgIDs By setting the ProgID property in the extension, you can name a ProgID—for
example, extfile—that will contain the file type registration.

Verbs You can register command verbs (such as Open and Print) that appear in the
context menu that Windows Explorer displays when an end user right-clicks a file
with the current extension.

MIME Type You can also register multipurpose Internet mail extension (MIME) types, also
known as media types or content types, for the component’s key file. You can also
associate a MIME type with a class ID.

Note • File associations are stored in both HKLM\SOFTWARE\Classes and HKCU\SOFTWARE\Classes; you can see a merged
view of the data under HKEY_CLASSES_ROOT. It is recommended that you use the File Types editor instead of writing directly
to the registry to support Windows Installer feature advertisement.

Note also that Windows Installer writes file-extension advertisement information to the registry, which appears to be a string
of random characters. This behavior is normal.

See Also
File Associations
File Type Settings
Adding New File Extensions
Creating ProgIDs

Installing Assemblies
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 639

Chapter 4
Organizing Files for Your Installation

• Merge Module
• MSI Database
• MSM Database
• Transform

Note • The recommended way to add a .NET assembly to your project is to add an assembly as a component’s key file and
select Properties Only for the component’s .NET Scan at Build setting.

In the Assembly section of a component’s Advanced Settings, you can add a private or global Win32 assembly or .NET
assembly to be registered when the current component is installed. Using assemblies helps you install products that are
self-contained, without affecting other applications on the system.

Note that a component can contain only one assembly.

See Also
Adding Assemblies
Testing for .NET Assembly Support on the Target System
Assembly Settings
Scanning for .NET Dependencies and Properties
Static Scanning Wizard

Adding Assemblies

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

When you add a .NET assembly as the key file of a component, InstallShield automatically adds values to the .NET
assembly settings when the component is scanned at build time, or when you run the Static Scanning Wizard.

Task To add a .NET or Win32 assembly to a component:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Right-click Assembly and then click New Win32 Assembly or New .NET Assembly.

5. Click the assembly and then configure the Manifest, File Application, and related settings.

640 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

InstallShield adds the information that you enter for the assembly to the MsiAssembly and MsiAssemblyName tables of
your Windows Installer database. You can view and edit these tables using the Direct Editor.

See Also
Assembly Settings
Scanning for .NET Dependencies and Properties
Static Scanning
Static Scanning Wizard

Deleting Assemblies

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Task To delete an assembly from a component:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component.

3. Click the Advanced Settings item to expand it.

4. Right-click the assembly and click Delete.

Testing for .NET Assembly Support on the Target System

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield 2020 User Guide ISP-2600-UG00 641

Chapter 4
Organizing Files for Your Installation

To see if a target system supports .NET assemblies, you can test the MsiNetAssemblySupport property. To see if a target
system supports Win32 assemblies, you can test the MsiWin32AssemblySupport property. (Win32 assemblies are
supported only on Windows XP and later.) The assembly tables, actions, and properties require Windows Installer version
2.0 or later.

Specifying an Application Path for a Component

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The App Paths registry key is a useful installation-related key that helps an executable file find its .dll files without having to
modify the PATH environment variable. An executable file’s App Paths key looks like this:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\Filename.exe

A program’s App Paths key typically contains a value named Path, which should contain a semicolon-delimited list of
directories where the program’s .dll files could be located. Windows uses this key to find your application and its .dll files if
their locations are not already in the system’s path. If an end user moves or renames your application’s executable file
through the Explorer shell, Windows automatically updates the file’s App Paths key.

Task To specify an application path for your component:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. Select the component that you want to configure, and expand its Advanced Settings item.

3. Click the Application Paths item under Advanced Settings.

4. Select the check box of the file for which you would like to create a key.

5. In the Application Path column, enter the paths to the file’s dependencies, or select a Windows Installer folder
property from the list rather than hard-coding a path. Separate multiple paths with a semicolon (;).

6. Click OK.

See Also
Application Path Settings

642 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Configuring Device Driver Settings

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

For information on installing device drivers in InstallScript projects, see Installing Device Drivers.

Once you run the Device Driver Wizard, which adds the table and entries, custom actions, features, and components
needed to include device drivers in your installation, you can set properties associated with a component that includes a
device driver. The following information describes the various options that you can set within InstallShield.

The Device Driver advanced setting’s Common tab within the Components view enables you to specify whether the current
component includes a device driver and, if so, select desired run-time installation options. The Sequence tab enables you
to specify the order in which the project’s device drivers (not just the current component’s device drivers) should be
installed.

See Also
Device Driver Settings

Publishing Components
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The Publishing advanced setting for a component enables you to specify publishing information for your component.
Publishing is a type of advertising (just-in-time installation) in which no user-interface elements are created for the
component during installation, but the component can be installed through Add or Remove Programs or when an installed
component requests the published component from the installer.

You must create at least one component ID for each advertised component.

InstallShield 2020 User Guide ISP-2600-UG00 643

Chapter 4
Organizing Files for Your Installation

Important • Do not confuse the component ID with the GUID that is entered in the Component Code setting for the
component; they must be unique values. The component ID that you use for the Publishing advanced setting is a category
identifier that represents the category of components that are being grouped together as a qualified component.

Each component ID must have at least one qualifier. The qualifier is a string that you can use to distinguish this language or
version of the component from any other (for example, to specify a language). It must be unique for the component.

At run time, the installation registers the component IDs and qualifiers and uses these unique values to manage the
published components. By calling the Windows Installer functions, your installed component—or another installed
component (known as cross-product advertisement)—can request information about an advertised component and install
it.

See Also
Specifying Publishing Information
Publishing Settings

Specifying Publishing Information

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The Publishing advanced setting for a component enables you to specify publishing information for your component.
Publishing is a type of advertising (just-in-time installation) in which no user-interface elements are created for the
component during installation, but the component can be installed through Add or Remove Programs or when an installed
component requests the published component from the installer.

Task To publish a component that you have created:

1. In the View List under Organization, click Setup Design (in installation projects only) or Components.

2. In the explorer, expand the component that you want to publish, and under Advanced Settings, select Publishing.
The Publishing explorer appears in a separate pane.

3. Right-click the Publishing explorer and then click New ComponentID to generate an ID for your new component.
InstallShield adds a unique componentID and a corresponding qualifier.

4. In the Publishing explorer, click the new qualifier and configure its value.

In the Custom Actions and Sequences view of an installation project, you can set the conditions that need to be fulfilled in
order for your product to be advertised on the target system.

644 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Task To set the advertisement conditions in an installation project:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Sequences explorer, expand the Advertisement item, and then the Execute item.

3. Click the appropriate Execute action, and then configure its Conditions setting as needed.

See Also
Publishing Settings

Adding ComponentIDs for a Component to Be Published

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

You must add at least one componentID to the Publishing advanced setting of a component if you want the component to
be published.

Task To add a componentID:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component that should have the new componentID, and under Advanced Settings, select
Publishing. The Publishing explorer appears in a separate pane.

3. Right-click the Publishing explorer and then click New ComponentID. InstallShield adds a unique componentID and
a corresponding qualifier.

See Also
Specifying Publishing Information
Publishing Settings

Removing ComponentIDs

InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 645

Chapter 4
Organizing Files for Your Installation

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Task To remove a componentID:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component, and under Advanced Settings, select Publishing. The Publishing explorer
appears in a separate pane.

3. In the Publishing explorer, right-click the componentID and click Delete.

See Also
Specifying Publishing Information
Publishing Settings

Adding Qualifiers to ComponentIDs

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Each componentID must have at least one qualifier. When you create a componentID, by default it has a qualifier. To
rename this qualifier, right-click it and click Rename.

Task To add a new qualifier:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component, and under Advanced Settings, select Publishing. The Publishing explorer
appears in a separate pane.

3. In the Publishing explorer, right-click the componentID and click New Qualifier. InstallShield creates a new qualifier
with a default name.

646 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

4. Type a name for the qualifier.

See Also
Specifying Publishing Information
Publishing Settings

Removing Qualifiers from ComponentIDs

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Task To remove a qualifier:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component, and under Advanced Settings, select Publishing. The Publishing explorer
appears in a separate pane.

3. In the Publishing explorer, right-click the qualifier and click Delete.

See Also
Specifying Publishing Information
Publishing Settings

Configuring Qualifier Settings

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield 2020 User Guide ISP-2600-UG00 647

Chapter 4
Organizing Files for Your Installation

You have the option of specifying an informational string, called application data, for each qualifier.

Task To set the qualifier properties:

1. In the View List under Organization, click Setup Design (for installation projects only) or Components.

2. In the explorer, expand the component, and under Advanced Settings, select Publishing. The Publishing explorer
appears in a separate pane.

3. In the Publishing explorer, click the qualifier.

4. In the Application Data setting, enter the appropriate value.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages
that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) in this
setting to select an existing string. For more information, see Using String Entries in InstallShield.

See Also
Specifying Publishing Information
Publishing Settings

Defining Features
InstallShield 2020

A feature is the smallest installable part of a product, from the end user’s perspective. It represents a specific capability of
your product—such as its help files or a part of a product suite that can be installed or uninstalled based on the end user’s
selections. Your entire installation should be divided into features, each of which performs a specific purpose.

Subfeatures are further divisions of a feature. Because features should be self-contained elements of a product or product
suite that an end user can selectively install, it might make sense for you to organize portions of your installation as
subfeatures of a parent feature.

Tip • Although you can create many levels of subfeatures, you should keep the design as simple as possible for organizational
purposes.

See Also
Features View

Creating Features
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

648 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• InstallScript Object
• MSI Database
• Transform

You can use the Setup Design view or the Features view to create features, as well as subfeatures, for your project.

Task To create a feature:

1. In the View List under Organization, click Setup Design or Features.

2. Right-click the top-level item in the explorer and click New Feature. InstallShield adds a new feature with the default
name New Feature_n (where n is a successive number).

3. Enter a new name, or right-click it later and click Rename to give it a new name.

4. Configure the feature’s settings in the right pane.

Project • In Basic MSI, InstallScript MSI, MSI Database, and Transform projects, feature names must contain only letters,
digits, underscores (_), and periods (.), and they must begin with a letter or an underscore.

In InstallScript and InstallScript Object projects, the following characters are invalid in feature names:

\/:*?"’<>|

Tip • To add a subfeature, right-click the parent feature and click New Feature.

You can create multiple nested features at one time by adding a new feature and typing Feature 1\Feature 2\Feature 3 for
the feature’s name. InstallShield creates a nested feature structure where Feature 3 is a subfeature of Feature 2, which is a
subfeature of Feature 1.

After you have created all of your product’s features and subfeatures, you need to create components and then associate
them with your features.

See Also
Features View
Setup Design View
Associating New Components with Features

Configuring Feature Settings

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object

InstallShield 2020 User Guide ISP-2600-UG00 649

Chapter 4
Organizing Files for Your Installation

• MSI Database
• Transform

Task To configure a feature’s settings:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature that you want to configure.

3. Configure the settings in the grid in the right pane.

See Also
Features View
Setup Design View

Setting a Feature’s Destination

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Each feature and subfeature can have a different destination location for its files. The default value for a new feature’s
Destination setting is INSTALLDIR, which is set in the General Information view.

Windows Logo • According to the Windows logo program requirements, the default destination of your product’s files must
be a subfolder of the Program Files folder or the end user’s Application Data folder, regardless of the language of the target
system.

Task To change the feature’s destination folder:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature whose destination you want to change.

3. In the Destination setting, select one of the options from the list, or click the ellipsis button (...) to select or create a
directory.

If you want the destination to be configurable at run time, the destination folder that you select must be a public
property (containing all uppercase letters).

Note • You can leave the feature’s Destination setting blank.

650 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Other Destination Folder Considerations

Changing Feature Destinations at Run Time

If you want to change a feature’s destination directory at run time based on the end user’s feature selection, you can use
Windows Installer custom action type 35.

For more information about changing a directory’s target location, see Changing the Target Location for a Directory in the
Windows Installer Help Library.

Feature’s Remote Installation Setting

Setting the feature’s Remote Installation setting to Favor Source (or to Favor Parent when the subfeature’s parent feature
is set to Favor Source) means that the feature’s files will not be installed on the target system, regardless of the feature’s
Destination setting.

Component’s Destination Setting

Each component also has a Destination setting. If the feature’s Destination setting and the component’s Destination
setting have different values, the component’s Destination setting overrides the feature’s. The feature’s Destination setting
is optional, but the component’s Destination setting is required.

INSTALLDIR as Default Destination

The assumption behind using INSTALLDIR as the default Destination property for all features and components is that all of
your application’s files should be installed to the same root folder. As a result, when an end user changes the destination
folder for any of the features in the CustomSetup dialog, the destination folders for all of the features that are set to be
installed to the path contained in INSTALLDIR also change.

Note • If the component’s destination is set to something other than INSTALLDIR, the component is installed to the
destination that is specified for the component; changing INSTALLDIR has no effect on the component’s destination.

A directory property such as INSTALLDIR specifies a default value. An end user can change this value by setting a property
when launching Msiexec.exe at the command line or by selecting a new destination folder for a feature in the CustomSetup
dialog.

See Also
Setting the Default Product Destination Folder (INSTALLDIR)
Windows Installer Property Reference
Component Destination vs. Feature Destination
MsiExec.exe Command-Line Parameters
CustomSetup Dialog Options

Setting Feature Conditions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 651

Chapter 4
Organizing Files for Your Installation

• InstallScript MSI
• MSI Database
• Transform

Conditional installation of your features can be useful if you are creating different versions of the same product—for
example, a trial version and a full version. You might not want to provide full functionality in the trial version; therefore, you
would not install all of the features. Another use for conditional feature installation is to save disk space. If the target
system does not have enough disk space for all of the features, you can set non-required features to install conditionally.

Task To set a condition for a feature in your project:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature that you want to configure.

3. Click the Condition setting and then click the ellipsis button (...). The Feature Condition Builder dialog box opens.

4. Click the New Condition button. InstallShield adds a new condition row to the Conditions box.

5. In the Level column, type the install level that should be used for the feature if the condition is met.

Note that if the condition is met, this value overrides the value that is specified for the feature’s the Install Level
setting.

6. Do one of the following:

• In the Condition column, type the feature condition.

• Use the Properties list, the Operators list, and the Add buttons to build your condition:

a. In the Properties list, select a property and then click the Add button. InstallShield adds the property to the
Condition column.

b. If your conditional statement should contain an operator, select an operator in the Operators list and then
click the Add button. InstallShield adds the operator to the conditional statement.

c. If your conditional statement should contain a value, double-click the condition field, press END so that the
insertion point is at the end of the condition statement, and enter the value.

7. Click OK.

Important • InstallShield performs basic condition validation; however, you should still double-check that your condition
statements evaluate to the expected outcome. For more information and example conditions, see Building Conditional
Statements.

Run-Time Behavior for Feature Conditions

The default install level of a feature is the value that is configured in the Install Level setting in the Features view or the
Setup Design view. This value is overridden if a feature condition evaluates as true; in this case, the install level of the
feature is set to the Level value that is associated with the true conditional statement.

Each feature’s install level value is compared to the value of the global public property INSTALLLEVEL; only those features
with install level values less than or equal to INSTALLLEVEL are selected for installation.

652 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

For example, if you have a feature that you want to be selected by default only if the end user has elevated privileges, you
can give the feature a condition of Not Privileged and set the install level for that condition to 200. If the end user does
not have elevated privileges, the condition is true, and the feature will be given the install level 200. Because 200 is greater
than the default product install level (100), the feature will not be selected by default.

Tip • You can conditionally hide a feature by giving the feature a condition that sets the install level to the number 0. If the
condition is true, the feature will be deselected, and it will not be displayed in the CustomSetup dialog.

See Also
Feature Condition Builder Dialog Box
Conditional Statement Syntax
Configuring a Feature’s Install Level Setting
Configuring Component Conditions

Displaying Features to End Users

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

InstallShield enables you to indicate how you want a feature to be presented to the end user in the custom setup type
dialog that corresponds with your project type:

• For Basic MSI, MSI Database, and Transform projects—CustomSetup dialog

• For InstallScript MSI projects—SdFeatureDialog2, SdFeatureMult, or SdFeatureTree

The Display setting for a feature in the Features view or the Setup Design view is where you indicate whether and how the
feature should be displayed. Available options are:

Table 4-9 • Options that Are Available for the Display Setting

Option Description

Visible and Collapsed The feature is displayed in the run-time dialog with its subfeatures collapsed by
default.

Visible and Expanded The feature is displayed in the run-time dialog with its subfeatures expanded by
default.

Not Visible The feature and subfeatures are not displayed in the run-time dialog.

InstallShield 2020 User Guide ISP-2600-UG00 653

Chapter 4
Organizing Files for Your Installation

Note • Selecting Not Visible for this setting does not have any direct impact on whether a feature is installed. A feature is not
automatically installed if it is invisible—it just cannot be deselected if it would otherwise be installed, or selected if it should
not be installed.

See Also
Conditionally Selecting Features
Conditionally Hiding Features
Requiring Features to Be Installed
Features View
CustomSetup Dialog Options

Conditionally Selecting Features

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The procedure for conditionally selecting features at run time depends on the project type that you are using.

Basic MSI, MSI Database, and Transform Projects

The Condition setting for a feature enables you to specify a non-default Install Level value if the condition that you specify
succeeds. If a feature’s Install Level value is less than or equal to the project’s INSTALLLEVEL property, the feature will be
selected to be installed.

Task For example, to deselect a feature if the end user does not have administrator privileges:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature that you want to configure.

3. Click the Condition setting and then click the ellipsis button (...). The Feature Condition Builder dialog box opens.

4. Click the New Condition button. InstallShield adds a new condition row to the Conditions box.

5. In the Level column, type 200.

6. In the Condition column, type Not AdminUser.

7. Click OK.

654 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

At run time, if the end user does not have administrator privileges (that is, if the condition succeeds), the Install Level
property for the feature is set to 200. Because the default INSTALLLEVEL property for a project is 100, the feature is
deselected.

Task You can change the INSTALLLEVEL property in the Property Manager.

InstallScript and InstallScript MSI Projects

The FeatureSelectItem function enables you to select or deselect a feature displayed in a feature-selection dialog such as
SdFeatureTree.

See Also
Property Manager View
FeatureSelectItem

Conditionally Hiding Features

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

The procedure for conditionally hiding features at run time depends on the project type that you are using.

Basic MSI, MSI Database, and Transform Projects

Any feature given an Install Level of zero will be hidden (and deselected).

Task For example, to hide a feature if the end user running your installation does not have administrative privileges:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature that you want to configure.

3. Click the Condition setting and then click the ellipsis button (...). The Feature Condition Builder dialog box opens.

4. Click the New Condition button. InstallShield adds a new condition row to the Conditions box.

5. In the Level column, type 0.

6. In the Condition column, type Not AdminUser.

7. Click OK.

InstallShield 2020 User Guide ISP-2600-UG00 655

Chapter 4
Organizing Files for Your Installation

After rebuilding your project and running the installation, the feature will not be displayed or installed if the end user does
not have administrative privileges.

InstallScript and InstallScript MSI Projects

The FeatureSetData function accepts a FEATURE_FIELD_VISIBLE constant that lets you control whether a specific feature
is displayed. For example, to hide a feature called HiddenFeature, include the following function call in your script:

FeatureSetData (MEDIA,
"HiddenFeature",
FEATURE_FIELD_VISIBLE, FALSE,
"");

Note • Hiding a feature does not automatically deselect it. To deselect the feature so that its data is not installed, call the
following:

FeatureSelectItem(MEDIA, "FeatureName", FALSE);

See Also
FeatureSetData
FeatureSelectItem

Conditionally Setting the Visibility of a Suite Feature at Run Time

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

You can conditionally show or hide a feature of a suite project based upon a property at run time using the Condition
option under the Visible property on the Features view of the Installation Designer.

You can use the Condition setting to specify one or more conditions that the Advanced UI or Suite/Advanced UI installation
should use to evaluate whether the feature should be visible for installation by default on the InstallationFeatures wizard
page.

For example, if you want a particular feature to be visible by default on target systems that have a particular version of
Windows, you can create a condition that specifies that version of Windows.

Task To conditionally display a feature in an Advanced UI or Suite/Advanced UI installation:

1. On the Features view, click in the Condition row under the Visible property. A green plus sign, the New Condition
button, appears at the end of the row.

2. Click the New Condition button. A new row is added under the Condition row.

3. Click the down arrow next to the New Condition button and select the appropriate option—All, Any, or None—from
the list.

656 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

4. Then in the same row, click the New Condition button, and select the appropriate option to continue building the
conditional statement.

If one or more conditional statements are configured, the Condition property lists (Condition). If none are
configured, the Condition property lists (Empty).

For more information, see Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects.

Methods in Automation Interface to Support Conditional Visibility

You can also use the following methods in the automation interface to conditionally set the visibility of a feature in a suite
project at run time:

Table 4-10 • Automation Interface Methods to Support Conditional Visibility in Suite Projects

Method Syntax

AddVisibleCondition AddVisibleCondition() As ISWiSuiteCondition

DeleteVisibleCondition DeleteVisibleCondition()

VisibleCondition Read-only object property

Requiring Features to Be Installed

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

When you select Yes for a feature’s Required setting, the end user cannot deselect it in the CustomSetup dialog (for Basic
MSI, MSI Database, and Transform projects), or the SdFeatureDialog2, SdFeatureMult, or SdFeatureTree dialogs (for
InstallScript MSI projects). The feature will be installed to the target system.

If the value for the Required setting is No, the feature is installed by default, but the end user can deselect it.

In InstallScript MSI projects, the Required setting is applicable to root-level features during a first-time installation. It is also
applicable to subfeatures in an upgrade or patch. This setting is ignored for subfeatures during a first-time InstallScript MSI
installation.

See Also
CustomSetup Dialog Options
Using the Required Features Setting
Features View

InstallShield 2020 User Guide ISP-2600-UG00 657

Chapter 4
Organizing Files for Your Installation

Advertising Features
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• MSI Database
• Transform

InstallShield enables you to selectively enable or disable a feature for advertisement. Advertised features are not installed
immediately during the installation process. Instead, they are installed when requested. If the feature is assigned, the
feature appears to be already installed, although it is not installed until the end user requests it. (Assigned features have
their shortcuts installed, and they can be installed from Add or Remove Programs in the Control Panel. However, an
assigned feature is advertised until a user requests it.) A published feature does not appear on the target system until it is
requested from the installer. (Published features lack any end user–interface elements. They are installed
programmatically or through an associated MIME type.)

Use the Advertised setting in the Features view to specify whether advertisement should be allowed. Available options for
this setting are:

Table 4-11 • Options that Are Available for the Advertisement Setting

Option Description

Allow Advertise End users have the ability to select the advertisement option for this feature in the
CustomSetup dialog. Although advertisement is allowed, it is not the default
option when the installation is run.

Favor Advertise The feature is advertised by default. End users can change the advertisement
option for a feature in the CustomSetup dialog.

Disallow Advertise Advertising is not allowed for this feature. End users cannot elect to have the
feature advertised in the CustomSetup dialog.

Disable Advertise if Not Advertisement works only on systems with Internet Explorer 4.01 or later. If the
Supported target system does not meet this criterion, advertising is not allowed. If the target
system can support advertisement, advertising is allowed.

When you allow feature advertisement, the feature is advertised, regardless of the mode in which the installation is
running, as long as no other factors prevent it from being advertised. In the CustomSetup dialog, the end user can control
which features are immediately installed and which are available later.

Advertisement usually requires support from the application. For example, your product’s spell checker can be advertised.
The application interface offers use of the spell checker through a menu command or toolbar button. You must write to
check the feature’s installation state and install it when the customer clicks the Spell Check command or button.

See Also
Features View
CustomSetup Dialog Options

658 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Configuring a Feature’s Install Level Setting

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

For InstallScript MSI projects, this information applies only if no setup types are defined in the project.

The Install Level setting for a feature is compared against the INSTALLLEVEL property at run time to determine which
features are available for installation. You can use this setting to create specific feature configurations.

Unless the end user deselects features in the CustomSetup dialog, all features with an install level less than or equal to the
value of the package’s INSTALLLEVEL property are installed to the target system.

Note • You can change the package’s INSTALLLEVEL property in the Property Manager.

Task To set a feature’s Install Level property:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature that you want to configure.

3. For the Install Level setting, type an integer for this feature’s install level. The recommended value is 100.

See Also
CustomSetup Dialog Options
Feature Settings
Windows Installer Property Reference
Property Manager View

Setting a Feature’s Remote Installation Setting

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

InstallShield 2020 User Guide ISP-2600-UG00 659

Chapter 4
Organizing Files for Your Installation

The Remote Installation setting for a feature determines whether the feature’s files are installed on the target system or
run from the source medium, such as a CD-ROM or network server. The default value for a new feature is Favor Local, which
means that the files in the selected feature are installed on the target system.

Task To change the Remote Installation setting so that the feature’s files run only from the source medium:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature that you want to configure.

3. In the Remote Installation setting, select Favor Source.

Tip • Selecting Favor Parent gives a subfeature the same value as its parent feature.

Caution • If any of the feature’s components contain a Windows service, select Favor Local for the Remote Installation
setting. Although an end user could change the installation state through the CustomSetup dialog, the Windows Installer
cannot install a service remotely.

See Also
Component’s Remote Installation Setting vs. Feature’s Remote Installation Setting
Setting a Component’s Remote Installation Setting
Installing, Controlling, and Configuring Windows Services
CustomSetup Dialog Options

Using Release Flags with Features

InstallShield 2020

Project • The following project types include support for release flags:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

Release flags enable you to create different versions of your product without having to create more than one project. There
are two steps for filtering features according to release flags: assigning release flags and specifying which flags to include in
the release.

See Also
Assigning Release Flags to Features
Removing Release Flags
Release Flags

660 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Assigning Release Flags to Features

InstallShield 2020

Project • The following project types include support for release flags:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

Release flags must be set on features that you want to exclude from certain builds. For example, if you have a feature called
Add-ons that should be included only in a special edition of your product, you can flag that feature and include it only when
needed.

Task To add a release flag to a feature:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature that you want to configure.

3. For the Release Flags setting, type a string. The string can be any combination of letters or numbers. To have more
than one flag on a feature, use a comma to separate the flags.

To learn how to filter features based on release flags, see Release Flags.

Removing Release Flags

InstallShield 2020

Project • The following project types include support for release flags:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

Task To remove a release flag from a feature:

1. In the View List under Organization, click Setup Design or Features.

2. Select the feature that you want to configure.

3. In the Release Flags setting, delete the value.

InstallShield 2020 User Guide ISP-2600-UG00 661

Chapter 4
Organizing Files for Your Installation

Reordering Features
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• MSI Database
• Transform

When your end users install your product, the CustomSetup dialog (in Basic MSI, MSI Database, or Transform installations)
or one of the feature selection dialogs (in InstallScript or InstallScript MSI installations) displays the features in the same
order that they are displayed in the Features view in InstallShield. You can change the order in which the features are
displayed.

Task To change the feature order:

1. In the View List under Organization, click Setup Design or Features.

2. Right-click the feature that you want to move and click Move Up or Move Down. You can also move a feature left or
right, thereby making it a subfeature of another feature or a top-level feature.

Tip • You can also reorder your features by dragging and dropping. Any feature or subfeature can be moved in this way.

See Also
CustomSetup Dialog Options

Using the Required Features Setting

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI
• InstallScript Object

The Required Features setting enables to you specify features that are required by the selected feature. For example, you
might have an installation with two features—ProgramFiles and HelpFiles. If it is necessary that end users install
ProgramFiles whenever the HelpFiles feature is selected, you need to use the Required Features property.

662 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Task To arrange this feature requirement:

1. In the View List under Organization, click Setup Design or Features.

2. Select the HelpFiles feature.

3. Click the Required Features property and then click the ellipsis button (...). The Required Features dialog box opens.

4. Select the ProgramFiles check box.

5. Click OK.

At run time, if the user selects a Custom setup type, feature-selection dialogs such as SdFeatureTree will not allow the user
to deselect the ProgramFiles feature if the HelpFiles feature is selected.

Working with Setup Types

InstallShield 2020

Project • Setup types are available in the following project types:

• InstallScript
• InstallScript MSI

To create setup types for a Basic MSI project, use the feature’s Install Level setting.

Setup types enable you to provide different versions of your product to your end users. For example, the default setup
types are Complete and Custom. The Complete setup type installs all of the files included in your installation. The Custom
setup type lets the end user select which features are installed.

Setup types are based on features. You select the features that you would like to associate with each setup type. Then,
when an end user selects a certain setup type, only those features that you associated with that setup type are installed.

By default, each project that you create contains predefined setup types. In the Setup Types view, you can add or remove
setup types, rename existing setup types, and change which features are associated with each one.

See Also
Setup Types View

Adding Setup Types

InstallShield 2020

Project • Setup types are available in the following project types:

• InstallScript
• InstallScript MSI

To create setup types for a Basic MSI project, use the feature’s Install Level setting.

InstallShield 2020 User Guide ISP-2600-UG00 663

Chapter 4
Organizing Files for Your Installation

Task To add a setup type:

1. In the View List under Organization, click Setup Types.

2. Right-click the Setup Types explorer and click Add. InstallShield adds a new setup type.

3. Type a new name for the setup type.

See Also
Setup Types View

Editing Setup Types

InstallShield 2020

Project • Setup types are available in the following project types:

• InstallScript
• InstallScript MSI

To create setup types for a Basic MSI project, use the feature’s Install Level setting.

Task To change which features are associated with a setup type:

1. In the View List under Organization, click Setup Types.

2. In the Setup Types explorer, click the setup type that you want to edit. All of the features in your installation project
appear in the lower-left pane.

3. Clear the check boxes next to the features that should not be included in the selected setup type. Select the check
boxes next to those features that you want included.

Any setup types listed in the Setup Types pane are automatically added to your installation project.

Note • The SetupType2 function displays only the standard setup types—Complete and Custom—with fixed description text
for both. If you want greater flexibility, call SdSetupTypeEx in your script instead of SetupType2. (The default code for the
OnFirstUIBefore event handler includes a call to the SetupType2 function.)

Tip • To provide an accelerator key for your setup type, include an ampersand (&) before a letter in the name. For example,
the name Cu&stom becomes the label Custom, and the end user can select it during installation by pressing the S key.

See Also
Setup Types View

664 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Renaming Setup Types

InstallShield 2020

Project • Setup types are available in the following project types:

• InstallScript
• InstallScript MSI

To create setup types for a Basic MSI project, use the feature’s Install Level setting.

Task To rename a setup type:

1. In the View List under Organization, click Setup Types.

2. In the Setup Types explorer, right-click the setup type that you want to edit and then click Rename.

3. Type a new name for your setup type.

This updates the Display Name setting for the selected setup type. The name is displayed in the SetupTypes dialog at run
time.

See Also
Setup Types View

Deleting Setup Types

InstallShield 2020

Project • Setup types are available in the following project types:

• InstallScript
• InstallScript MSI

To create setup types for a Basic MSI project, use the feature’s Install Level setting.

Task To delete a setup type:

1. In the View List under Organization, click Setup Types.

2. In the Setup Types explorer, right-click the setup type that you want to delete and then click Remove.

See Also
Setup Types View

InstallShield 2020 User Guide ISP-2600-UG00 665

Chapter 4
Organizing Files for Your Installation

Including Redistributables in Your Installation

InstallShield 2020

InstallShield includes many commonly used third-party redistributables, making it easy to add support for popular
technologies such as the .NET Framework to your installation. When you add redistributables to your project, the
redistributables, plus all of the associated dependencies, are added to your installation. This simplifies the process of
packaging redistributables and helps to facilitate consistency for internal or external use.

The Redistributables view (or in InstallScript and InstallScript Object projects, the Objects view) contains all of the
InstallShield objects and third-party merge modules that are included with InstallShield. In Basic MSI and InstallScript MSI
projects, this view also contains InstallShield prerequisites that you can add to your installation. In InstallScript projects,
you can use the Prerequisites view to add InstallShield prerequisites to your installation.

InstallShield Prerequisites
An InstallShield prerequisite is an installation for a product or technology framework that is required by your product. You
can add any of the existing InstallShield prerequisites to your installation projects and configure many of their settings. You
can also create your own InstallShield prerequisites, and add them to your projects.

InstallShield includes a base set of InstallShield prerequisites. You can also use the InstallShield Prerequisite Editor in
InstallShield to define custom InstallShield prerequisites or to edit settings for any existing InstallShield prerequisites.

InstallShield includes support for two types of InstallShield prerequisites:

• Setup prerequisite—The installation for this type of prerequisite runs before your installation runs.

• Feature prerequisite—This type of prerequisite is associated with one or more features. It is installed if the feature
that contains the prerequisite is installed and if the prerequisite is not already installed on the system. Thus, if a
feature has a condition that is not met on the target system, or if the end user chooses not to install the feature, the
feature is not installed. As a result, none of its associated feature prerequisites are installed, unless the feature
prerequisites are also associated with other features that are installed.

Project • Basic MSI projects include support for feature prerequisites.

InstallShield also includes support for including InstallShield prerequisites as packages in Advanced UI and Suite/Advanced UI
projects. For more information, see Including InstallShield Prerequisites (.prq) in an Advanced UI or Suite/Advanced UI Project.

Merge Modules
A merge module (or .msm file) contains all of the logic and files needed to install distinct pieces of functionality. For
example, some applications require Microsoft C++ run-time libraries. Instead of having to include the file in a feature and
figure out its installation requirements, you can simply attach the Microsoft C++ runtime library merge module to one of
your project’s features.

Note • Many of the merge modules included in the Redistributables view are authored by Microsoft or another third party.
InstallShield distributes these modules as a courtesy to assist you in creating your installation project. However, InstallShield
cannot modify or fix any problems that may exist within third party-authored modules. You are encouraged to contact the
vendor regarding issues with specific third party-authored modules.

666 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Objects
Like merge modules, objects contain logic and files needed to install distinct pieces of functionality. Some objects, such as
the DirectX object included with InstallShield, require customization through a wizard. As soon as you add such an object
to your installation, its customization wizard opens. You can either customize your object at the time you add it, or cancel
the wizard and customize your object later by right-clicking the object and selecting Change Objects Settings.

Redistributables Gallery
Because the file size of many of the redistributables is so large, some that are available for use in your projects are not
added to your computer when you install InstallShield. However, these redistributables are still available for download
from the Internet to your computer.

Configurable Merge Modules

A configurable redistributable is a merge module or an object that has at least one row in the ModuleConfiguration table
that is referenced by at least one row in the ModuleSubstitution table. This enables you to change a value in the
redistributable. When you select a configurable module in the Redistributables view, the Merge Module Configurable
Values dialog box is displayed to enable you to configure the module at the time you add it. To customize the merge
module later, right-click it and select Configure merge module.

See Also
Redistributables View
Prerequisites View
ModuleConfiguration Table (Windows Installer Help Library)
ModuleConfiguration Table (Windows Installer Help Library)
ModuleSubstitution Table (Windows Installer Help Library)
ModuleSubstitution Table (Windows Installer Help Library)
Designing InstallShield Prerequisites and Other Redistributables

Shipping Redistributable Files

InstallShield 2020

InstallShield provides third-party redistributables that you can incorporate into your installation projects. If you include
redistributable technology in your projects—for example, Crystal Reports—that redistributable must be licensed from the
vendor. You cannot legally redistribute these technologies without the appropriate licensing. For details, consult the
vendor’s documentation.

When you build releases in an InstallShield project, InstallShield includes various InstallShield redistributable files in the
build output. You may use these InstallShield redistributable files in the build output according to the InstallShield End-
User License Agreement. Most of these files are installed in the InstallShield Program Files Folder\Redist folder and
included in builds as needed. Following is a list of the InstallShield redistributable files.

• _isres_LanguageID.dll

• AppxStub.exe

• ClrSuitePSHelper.dll

• ClrWrap.dll

• CommonHelper.dll

• corecomp.ini

InstallShield 2020 User Guide ISP-2600-UG00 667

Chapter 4
Organizing Files for Your Installation

• default.pal

• DLLWrap.dll

• dotnetfx.exe

• DotNetInstaller.exe

• EulaScrollWatcher.dll

• FileBrowse.dll

• IISHelper.dll

• IISRT.dll

• InstallShield.ClrHelper.dll

• InstallShield.Interop.Msi.dll

• ISBEW64.exe

• ISChain.exe

• ISChainPackages.dll

• ISComSrv.dll

• ISExpHlp.dll

• isexternalui.dll

• IsLockPermissions.dll

• ISNetAPI.dll

• ISNetApiRT.dll

• ISNetworkShares.dll

• ISRegSvr.dll

• Isrt.dll

• ISScheduledTasks.dll

• IsSchRpl.dll

• ISSetup.dll

• ISSQLSrv.dll

• IsWebDeploy.dll

• ISWindowsFeaturesAction.dll

• ISWindowsFeaturesAction64.dll

• ISXmlCfg.dll

• Layout.bin

• PowerShellWrap.dll

• PrqLaunch.dll

668 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• QuickPatchHelper.dll

• SerialNumCAHelper.dll

• SetAllUsers.dll

• Setup.exe

• Setup.ini

• setup.inx

• setup.isn

• setup.ocx

• setup.skin

• Setup_UI.dll

• setupPreReq.exe

• SetupSuite.exe

• SetupSuite64.exe

• SFHelper.dll

• SQLRT.dll

• SuiteAppxHelper.exe

• SuiteSQLRT.dll

• XMLRT.dll

• Image files that are installed in the subfolders in the following folder:

InstallShield Program Files Folder\Support\Themes

• Image and icon files that are installed in the following folder, as well in this folder’s scale-150 and scale-200
subfolders:

InstallShield Program Files Folder\Redist\Language Independent\OS Independent

Managing the Redistributables Gallery

InstallShield 2020

Because the file size of many of the redistributables is so large, some that are available for use in your projects are not
added to your computer when you install InstallShield. However, these redistributables are still available for download
from the Internet to your computer.

InstallShield 2020 User Guide ISP-2600-UG00 669

Chapter 4
Organizing Files for Your Installation

You can identify the status of a redistributable by its icon. Following is a list of the possible icons in the Redistributables
view (or in InstallScript projects, the Objects view or the Prerequisites view) and a description of each:

Table 4-12 • Redistributable Icons

Icon Project Type Description

Basic MSI, This InstallShield prerequisite is installed on your computer.

InstallScript,
InstallScript MSI

Basic MSI, This InstallShield prerequisite is not installed on your computer but it is available
InstallScript, for download.
InstallScript MSI

Basic MSI, This InstallShield prerequisite is included in your project but its location is not
InstallScript, listed in one of the directories that is specified on the Prerequisites tab of the
InstallScript MSI Options dialog box.

Basic MSI, This merge module is installed on your computer.

InstallScript,
InstallScript MSI

Basic MSI, This merge module is stored in a repository and is available for inclusion in your
InstallScript MSI project. For more information about repositories, see Using a Repository to Share
Project Elements.

Basic MSI, This merge module is not installed on your computer but it is available for
InstallScript, download.
InstallScript MSI

Basic MSI, An old version of this merge module is installed on your computer. A new version
InstallScript MSI is available for download.

Basic MSI, This object is installed on your computer.

InstallScript,
InstallScript MSI

Basic MSI, This object is not installed on your computer but it is available for download.
InstallScript MSI

Basic MSI, An old version of this object is installed on your computer. A new version is
InstallScript MSI available for download.

Project • If you add to your project a redistributable that is not installed on your computer, one or more build errors are
generated when you build a release. To eliminate the build errors, either remove the redistributable from your project or
download it before rebuilding the release. If a redistributable is not installed on your computer, Needs to be downloaded is
specified in the Location column for that redistributable.

670 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

InstallShield does not permit you to add a redistributable in the Objects view to an InstallScript project if it is not installed on
your computer.

Working with the Redistributables Gallery

The Redistributables view in Basic MSI and InstallScript MSI projects displays the redistributables gallery, which consists of
InstallShield prerequisites, merge modules, and objects, that you can include with your installations. The Prerequisites
view in InstallScript projects also displays the gallery of InstallShield prerequisites that you can add to your project.

InstallShield Prerequisites
Many InstallShield prerequisites are available in InstallShield. In addition, the InstallShield Prerequisite Editor in
InstallShield enables you to modify these prerequisites and create your own. All InstallShield prerequisite (.prq) files are
stored in the following location:

InstallShield Program Files Folder\SetupPrerequisites

Merge Modules
Merge modules are available from a variety of sources. Although InstallShield includes many redistributable modules, new
versions may be available or other software developers may have released a module that you need. In addition,
InstallShield enables you to create your own merge modules and add them to your redistributables gallery.

The source of the merge module files listed in the Redistributables view is the folder or folders specified on the Merge
Modules tab of the Options dialog box. To access the Options dialog box, on the Tools menu, click Options.

The following directory is the default location for the modules that come with InstallShield:

InstallShield Program Files Folder\Modules\i386

Objects
InstallShield provides many redistributable objects and lets you create your own for inclusion in your installations.
Furthermore, you may want to add to your projects the objects that other developers created with InstallShield.

The default location for the objects that come with InstallShield is:

InstallShield Program Files Folder\Objects

The objects that are included in the above location are listed in the Redistributables view.

See Also
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Redistributables View
Creating InstallScript Objects

Downloading Redistributables to Your Computer

InstallShield 2020

The procedures for downloading redistributables to your computer differ, depending on what type of project you are
using.

InstallShield 2020 User Guide ISP-2600-UG00 671

Chapter 4
Organizing Files for Your Installation

For Basic MSI and InstallScript MSI Projects

The Redistributables view enables you to download the latest InstallShield prerequisites, merge modules, and objects
from the Revenera Web site to your computer. If a redistributable is not installed on your computer, Needs to be
downloaded is specified in the Location column for that redistributable.

Task To download a specific InstallShield prerequisite, merge module, or object:

1. In the View List under Application Data, click Redistributables.

2. Right-click the InstallShield prerequisite, merge module, or object that you would like to download and then click
Download Selected Item.

Task To download all of the InstallShield prerequisites, merge modules, and objects that are needed for your installation
project:

1. In the View List under Application Data, click Redistributables.

2. Right-click any InstallShield prerequisite, merge module, or object and then click Download All Required Items.

For InstallScript Projects

The Prerequisites view enables you to download the latest InstallShield prerequisites from the Revenera Web site to your
computer. If a redistributable is not installed on your computer, Needs to be downloaded is specified in the Location
column for that redistributable.

Task To download a specific InstallShield prerequisite:

1. In the View List under Application Data, click Prerequisites.

2. Right-click the InstallShield prerequisite that you would like to download and then click Download Selected Item.

Task To download all of the InstallShield prerequisites that are needed for your installation project:

1. In the View List under Application Data, click Prerequisites.

2. Right-click any InstallShield prerequisite and then click Download All Required Items.

The Objects view enables you to download the latest merge modules and objects from the Revenera Web site to your

computer. If a merge module is not installed on your computer, its icon ( ) indicates that it is not installed. InstallShield
does not permit you to add a merge module to your InstallScript project if the merge module is not installed on your
computer. If an object is not installed on your computer, it is not listed in the Objects view.

672 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Task To download a specific merge module:

1. In the View List under Application Data, click Objects.

2. In the InstallShield Objects/Merge Modules pane, right-click the merge module that you would like to download and
then click Download Selected Item.

Task To download objects:

1. In the View List under Application Data, click Objects.

2. In the InstallShield Objects/Merge Modules pane, right-click any object and click Check Web. The downloads page
at the Revenera Web site opens in an Internet browser.

3. Select the object that you would like to download and install. You are prompted during the installation to close
InstallShield in order to complete the object installation.

See Also
Obtaining Updates for InstallShield
Managing the Redistributables Gallery
Determining the Files in InstallShield Prerequisites, Merge Modules, and Objects

Adding InstallShield Prerequisites to the Redistributables Gallery

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Task To add an InstallShield prerequisite to the redistributables gallery:

1. Acquire the new or updated InstallShield prerequisite (.prq) file.

2. Using Windows Explorer, copy the new prerequisite to the following location:

InstallShield Program Files Folder\SetupPrerequisites

3. Close InstallShield if it is currently open.

4. Launch InstallShield.

The modifications that you made are reflected in the Redistributables view (in Basic MSI and InstallScript MSI projects) and
in the Prerequisites view (in InstallScript projects).

InstallShield 2020 User Guide ISP-2600-UG00 673

Chapter 4
Organizing Files for Your Installation

See Also
InstallShield Prerequisite Editor Reference
Designing InstallShield Prerequisites and Other Redistributables

Removing InstallShield Prerequisites from the Redistributables Gallery

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Task To remove an InstallShield prerequisite from the redistributables gallery:

1. Close InstallShield.

2. Using Windows Explorer, locate and delete the InstallShield prerequisite that you want to remove from the gallery.
InstallShield prerequisites are located in the following directory:

InstallShield Program Files Folder\SetupPrerequisites

3. Launch InstallShield.

The modifications that you made are reflected in the Redistributables view (in Basic MSI and InstallScript MSI projects) or
in the Prerequisites view (in InstallScript projects).

Browsing for Merge Modules

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

If a merge module that you would like to add to your project is not listed in the Redistributables view, you can browse to
find it and also add it to your project and this view.

Task To browse for a merge module:

1. In the View List under Application Data, click Redistributables.

2. Right-click an item and click Browse for Merge Module. The Open dialog box opens.

3. Browse to the merge module file.

4. Click OK.

674 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

See Also
What Happens When You Browse for a Merge Module
Redistributables View

What Happens When You Browse for a Merge Module

InstallShield 2020

InstallShield does not maintain references to merge modules as explicit paths. Instead, it generates a key for a merge
module based on the merge module GUID and the merge module locale. When InstallShield needs to access the merge
module, it looks in the folders specified in the Merge Module Locations box for a file that matches that key. The Merge
Module Locations box is on the Merge Modules tab of the Options dialog box.

When you browse for a merge module, the path to the folder containing the merge module is added to the list of paths in
the Merge Module Locations box. In addition, a GUID:Locale key is added to your installation project based on the selected
file.

Impact on Your Installation

If two merge modules in the Merge Module Locations box have the GUID:Locale key, only one is included into your
installation, even if they have different file names. Because of the way InstallShield uses the Merge Module Locations box to
search, it is not possible to predict which merge module will be included.

Limiting the Number of Directories in the Merge Module Locations Box

If you use a shared merge module gallery, there might be earlier or later versions of a merge module in the gallery than
what exists on the target machine. For this reason, it is sometimes prudent to try and limit the number of directories in your
Merge Module Locations box.

Task To limit the number of directories, do one of the following:

• Using Windows Explorer, copy the merge module that you want into one of the folders that is already listed in the
Merge Module Locations box.

• Remove the default folders from the search path so that you are referencing only the shared location.

See Also
Browsing for Merge Modules

Adding Merge Modules to the Redistributables Gallery

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 675

Chapter 4
Organizing Files for Your Installation

Task To add a merge module to the redistributables gallery:

1. Acquire the new or updated merge module.

2. Using Windows Explorer, copy the new module to one of the folders specified on the Merge Modules tab of the
Options dialog box.

The default location for the modules that come with InstallShield is:

InstallShield Program Files Folder\Modules\i386

3. Close InstallShield if it is currently open.

4. Launch InstallShield.

The modifications that you made are reflected in the Redistributables view (in Basic MSI and InstallScript MSI projects) and
in the Objects view (in InstallScript projects).

See Also
Downloading Redistributables to Your Computer

Removing Merge Modules from the Redistributables Gallery

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Task To remove a module from the redistributables gallery:

1. Close InstallShield.

2. Using Windows Explorer, locate and delete the merge module that you want to remove from the gallery. Ensure that
you search each directory specified on the Merge Modules tab of the Options dialog box.

3. Launch InstallShield.

The modifications that you made are reflected in the Redistributables view (in Basic MSI and InstallScript MSI projects) and
in the Objects view (in InstallScript projects).

Note • If you delete a merge module that is currently associated with your installation, the message [Merge Module Not
Found] is displayed to inform you that the module cannot be included in your installation.

See Also
Managing the Redistributables Gallery
Downloading Redistributables to Your Computer

676 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Registering Objects in InstallScript Projects

InstallShield 2020

Project • This information applies to InstallScript projects.

When you register an object from within an InstallScript project, InstallShield adds that object to the redistributables
gallery, which makes it available for inclusion in other projects.

Task To register an object:

1. In the View List under Application Data, click Objects.

2. Right-click an item, point to Advanced, and click Register new object. The Project Settings dialog box opens.

3. On the Language-Independent Object Properties tab, specify a media file (Data1.hdr file).

4. Specify any other desired settings, and click OK.

See Also
Distributing an Object

Incorporating InstallShield Prerequisites, Merge Modules, and Objects in

Projects
InstallShield 2020

InstallShield includes many third-party redistributables that are packaged as InstallShield prerequisites, merge modules,
and objects. You can add these built-in redistributables to your installation projects. To learn how, see this section of the
documentation.

Tip • For information on creating your own InstallShield prerequisites, merge modules, and objects, see Designing
InstallShield Prerequisites and Other Redistributables.

Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript
MSI Projects
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

For information on adding redistributables to InstallScript projects, see Adding InstallShield Prerequisites, Merge Modules,
and Objects to InstallScript Projects.

InstallShield 2020 User Guide ISP-2600-UG00 677

Chapter 4
Organizing Files for Your Installation

Two types of redistributables—merge modules and objects—must be associated with a feature in order to be installed. You
can associate a single merge module or object with as many features or subfeatures as needed. If no features exist in your
installation project when you attempt to add a merge module or object, the Create a New Feature dialog box opens,
enabling you to create a feature. If you do not create a feature, these two types of redistributables cannot be added to your
installation project.

When you add an InstallShield prerequisite to an InstallScript MSI project, you cannot associate it with one or more
features.

When you add an InstallShield prerequisite to a Basic MSI project, it is not associated with any feature by default, and it is
called a setup prerequisite, since it is run before your main installation runs. If appropriate, you can associate an
InstallShield prerequisite with one more features that are currently in your project.

Task To add an InstallShield prerequisite, merge module, or object to a Basic MSI or InstallScript MSI project:

1. In the View List under Application Data, click Redistributables.

2. If you want merge modules that have been published to a repository to be displayed, right-click a redistributable and
ensure that Show Merge Modules in Repository is enabled.

3. Select the check box in front of the redistributable that you want to add. If you select an object, the associated wizard
opens to guide you through the customization process.

4. For a merge module or an object: In the Conditional Installation pane, select the check box for each feature that
should contain this redistributable.

If you are working with a Basic MSI project and you want to associate a prerequisite with a feature: In the Conditional
Installation pane, select the check box for each feature that should contain this prerequisite. If you do not want to
associate the prerequisite with a feature, leave the Install before feature selection check box selected. This check
box is selected by default when you add an InstallShield prerequisite to a Basic MSI project.

Tip • The right pane in the Redistributables view shows details about the merge module, object, or InstallShield prerequisite
that is selected in the list of available redistributables. Review this details pane to find out information such as which files a
redistributable installs. You can hide or show the details pane by clicking the Show Details button in this view.

Note • If Needs to be downloaded is specified in the Location column for an InstallShield prerequisite that you added to your
project, that InstallShield prerequisite is not installed on your computer. You can download the InstallShield prerequisite from
the Internet to your computer if you would like to include it in your project. If you build a release without first downloading one
or more required InstallShield prerequisites, and if you specify that the InstallShield prerequisites should be extracted from
Setup.exe or copied from the source media (instead of being downloaded from the Web to the end user’s computer), one or
more build errors may be generated. To eliminate the build errors, remove the InstallShield prerequisite from your project,
download it to your computer, or change the InstallShield prerequisite location for the release to the download option; then
rebuild the release.

Obtaining InstallShield Prerequisites and Objects

Note that some of the InstallShield prerequisites and objects are not installed with InstallShield. You may need to
download them. For more information, see Obtaining Updates for InstallShield.

678 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Also note that if you have an installation (for example, a Setup.exe file or an .msi package) that you want to launch during
your installation, you can create your own custom InstallShield prerequisite, and then add that InstallShield prerequisite
to your projects as needed. To learn how to create your own InstallShield prerequisite, see Defining InstallShield
Prerequisites.

See Also
Downloading Redistributables to Your Computer
Managing the Redistributables Gallery
Working with InstallShield Prerequisites that Are Included in Installation Projects
Specifying the Installation Order of InstallShield Prerequisites
Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level
Using a Repository to Share Project Elements

Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects

InstallShield 2020

Project • This information applies to InstallScript projects.

For information on adding redistributables to Basic MSI and InstallScript MSI projects, see Adding InstallShield Prerequisites,
Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects.

Merge modules and objects must be associated with a feature in order to be installed during an InstallScript installation.
You can associate a single merge module or object with as many features or subfeatures as needed. If no features exist in
your installation project when you attempt to add a merge module or object, the Create a New Feature dialog box opens,
enabling you to create a feature. If you do not create a feature, these two types of redistributables cannot be added to your
installation project.

When you add an InstallShield prerequisite to an InstallScript project, you cannot associate it with one or more features.

Task To add an InstallShield prerequisite to an InstallScript project:

1. In the View List under Application Data, click Prerequisites.

2. Select the check box in front of the InstallShield prerequisite that you want to add.

Tip • The right pane in the Prerequisites view shows details about the InstallShield prerequisite that is selected in the list of
available redistributables. Review this details pane to find out information such as which files a redistributable installs. You
can hide or show the details pane by clicking the Show Details button in this view.

Note • If Needs to be downloaded is specified in the Location column for an InstallShield prerequisite that you added to your
project, that InstallShield prerequisite is not installed on your computer. You can download the InstallShield prerequisite from
the Internet to your computer if you would like to include it in your project. If you build a release without first downloading one
or more required InstallShield prerequisites, and if you specify that the InstallShield prerequisites should be included with the
media (instead of being downloaded from the Web to the end user’s computer), one or more build errors may be generated. To
eliminate the build errors, remove the InstallShield prerequisite from your project, download it to your computer, or change
the InstallShield prerequisite location for the release to the download option; then rebuild the release.

InstallShield 2020 User Guide ISP-2600-UG00 679

Chapter 4
Organizing Files for Your Installation

Task To add a merge module or object to an InstallScript project:

1. In the View List under Application Data, click Objects.

2. In the Features pane, select the feature to which you want to add an object or merge module.

3. Right-click the object or merge module that you want to add and select Add to selected feature. (You can instead
drag the object or merge module and drop it on the feature.) For some objects, an associated wizard appears to guide
you through the customization process.

Note • Merge modules that are added to a feature in an InstallScript project appear in the Features pane as subitems of the
Merge Module Holder object. This object requires the Windows Installer engine. For more information, see Adding Windows
Installer Redistributables to Projects.

Tip • To see information about an object or merge module, such as files it installs and other actions it performs, select the
object or merge module name. The information is displayed in the pane on the right.

Caution • You should not alter another company’s merge module.

Obtaining Objects
Note that some of the objects are not installed with InstallShield. You may need to download them. For more information,
see Obtaining Updates for InstallShield.

See Also
Managing the Redistributables Gallery
Downloading Redistributables to Your Computer
Working with InstallShield Prerequisites that Are Included in Installation Projects
Specifying the Installation Order of InstallShield Prerequisites
Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level

Removing InstallShield Prerequisites from a Project

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

680 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Task To remove an InstallShield prerequisite from your project:

1. In the View List under Application Data, click Redistributables (in Basic MSI and InstallScript MSI projects) or
Prerequisites (in InstallScript projects).

2. Clear the check box in front of the InstallShield prerequisite that you want to remove.

Tip • If an InstallShield prerequisite is included in your installation as a dependency of another InstallShield prerequisite but
you want to remove that dependency prerequisite from the installation, you must remove the corresponding dependency from
the InstallShield prerequisite. For more information, see Removing a Dependency from an InstallShield Prerequisite.

See Also
Specifying the Installation Order of InstallShield Prerequisites

Removing Merge Modules and Objects from a Project

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Task To remove a merge module or object from your project:

• In Basic MSI and InstallScript MSI projects: In the Redistributables view, clear the check box in front of the
redistributable.

• In InstallScript projects: In the Objects view, right-click the redistributable in the Features window and click Delete
from project.

InstallShield moves the merge module or object from your project. In addition, InstallShield automatically removes from
the project any dependencies that are associated with that redistributable.

Determining the Files in InstallShield Prerequisites, Merge Modules, and Objects

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 681

Chapter 4
Organizing Files for Your Installation

If you need to see a list of files in an InstallShield prerequisite, a merge module, or an object, you can do so from within the
Redistributables view in Basic MSI and InstallScript MSI projects. The right pane in this view shows details about the
InstallShield prerequisite, merge module, or object that is selected in the list of available redistributables. This details pane
provides information such as which files a redistributable installs. You can hide or show the details pane by clicking the
Show Details button in this view. Clicking the Show Details button in the Prerequisites view of an InstallScript project lets
you see the files in the selected InstallShield prerequisite.

If you are using an InstallScript project and you want to see details about a merge module or object that is listed in the
Objects view, select that object; InstallShield displays a list of the redistributable’s files, as well as additional information,
in the right pane.

Tip • For another way to see the files contained in a merge module or object, see Knowledge Base article Q106474. This article
contains a link to a downloadable Merge Module Dependency Viewer.

Working with InstallShield Prerequisites that Are Included in Installation

Projects
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

An InstallShield prerequisite is an installation for a product or technology framework that is required by your product.
Some examples of InstallShield prerequisites that are included with InstallShield are Java Runtime Environment (JRE) and
SQL Server Express Edition. You can add any of the existing InstallShield prerequisites to your installation projects and
configure many of their settings. You can also create your own InstallShield prerequisites, and add them to your projects.

Project • Including InstallShield prerequisites in Windows Installer–based projects enables you to chain multiple installations
together, bypassing the Windows Installer limitation that permits only one Execute sequence to be run at a time. The
Setup.exe setup launcher serves as a bootstrap application that manages the chaining.

Note • Unlike Windows Installer 4.5 chaining, the InstallShield prerequisite installations are not processed as a single
transaction; that is, successful installations are not rolled back after failures in later prerequisites. To learn more about
Windows Installer 4.5 chaining support, see Configuring Multiple Packages for Installation Using Transaction Processing.

The Redistributables view is where you add InstallShield prerequisites to Basic MSI and InstallScript MSI projects. The
Prerequisites view is where you add InstallShield prerequisites to InstallScript projects.

682 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

See Also
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects
Specifying the Installation Order of InstallShield Prerequisites
Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level
Defining InstallShield Prerequisites

Setup Prerequisites vs. Feature Prerequisites

InstallShield 2020

Project • Basic MSI projects include support for feature prerequisites.

The following project types include support for setup prerequisites but not feature prerequisites:

• InstallScript
• InstallScript MSI

An InstallShield prerequisite that is run before the main installation’s user interface sequence begins is called a setup
prerequisite. Setup prerequisites are useful for base applications and technology frameworks that must be installed for all
configurations of the installed product or that provide functionality that is used during the installation itself. When you add
an InstallShield prerequisite to a project, it is the setup prerequisite type of InstallShield prerequisite by default.

Basic MSI projects enable you to associate InstallShield prerequisites with features in your main installation. When an
InstallShield prerequisite is associated with one or more features, it is called a feature prerequisite. Feature prerequisites
are installed after an end user has chosen which features to install; like merge modules, a feature prerequisite is installed
only if one or more of the features that contain it are installed. Thus, feature prerequisites are useful for applications or
components that are used by only some configurations of the installed product and are not used during the installation
itself.

Review the following sections for more information that will help you determine which type of InstallShield prerequisite
will best fit your requirements.

Special Considerations for Setup Prerequisites

Following are some tips to consider if you are including one or more setup prerequisites in your project.

.NET Framework Requirements

If your product requires that the .NET Framework be installed on the target system, you may include the .NET Framework
redistributable to your project. If the target system does not have the .NET Framework, it is installed during your
installation. For more details, see Adding .NET Framework Redistributables to Projects.

If your installation includes the .NET Framework redistributable and a setup prerequisite that requires that the .NET
Framework be present on the target machine—for example, if it installs files to the GAC—you can specify that the .NET
Framework should be installed before the setup prerequisite is installed. To learn more, see Specifying Parameters for
Installing an InstallShield Prerequisite.

InstallShield 2020 User Guide ISP-2600-UG00 683

Chapter 4
Organizing Files for Your Installation

Displaying an Error If an End User Launches the .msi Package Instead of the Setup Launcher
If your Basic MSI or InstallScript MSI installation includes a setup prerequisite and end users launch the .msi package for
your product directly, rather than launch the Setup.exe setup launcher, the setup prerequisite installation will not run. If
the prerequisite is not already present on a target system, your product may not work as expected. This scenario may occur
if you build an uncompressed release, where the .msi package is not streamed into the Setup.exe file.

To prevent this issue from occurring, you may want to add a type 19 custom action to your Basic MSI or InstallScript MSI
project. This custom action would evaluate the same conditions that were configured for the prerequisite on the
Conditions tab in the InstallShield Prerequisite Editor. The custom action would verify whether the setup prerequisite is
still needed; if it is needed, the type 19 error custom action would display an error message and end the installation.

Special Considerations for Feature Prerequisites

Following are some tips to consider if you are including one or more feature prerequisites in a Basic MSI project.

Windows Installer Requirements

If your project includes a prerequisite that installs the Windows Installer, the prerequisite should be a setup prerequisite,
not a feature prerequisite. That is, this prerequisite should not be associated with a feature.

.NET Framework Requirements

If your project include a prerequisite that installs the .NET Framework and your installation requires that the .NET
Framework be present—for example, if your installation installs files to the GAC—the .NET Framework prerequisite should
be a setup prerequisite, not a feature prerequisite. That is, this prerequisite should not be associated with a feature.

Potential Restart Issues for Feature Prerequisites

If you add an InstallShield prerequisite to your project and it may require a restart, it is recommended that you avoid
associating the prerequisite with a feature. If a feature prerequisite does trigger a restart, the ReadyToInstall dialog is
displayed again after the restart, and the end user will need to click the Install button again to proceed with the rest of the
installation.

Calculations for Disk Space Requirements

When the Windows Installer performs the file costing–related actions, it does not automatically include the disk space that
is required by any feature prerequisites. Therefore, if the CustomSetup dialog is displayed at run time, the disk space
amounts that are listed for various features may be inaccurate, since they will not account for the disk space that is
required by feature prerequisites. In addition, it is possible that a target system may have sufficient disk space for the main
installation, but not for the feature prerequisites. In this scenario, the target system may run out of disk space midway
through the installation.

To prevent file-costing issues for a feature prerequisite in your project, you may want to add a custom action that evaluates
the same conditions that were configured for the feature prerequisite on the Conditions tab in the InstallShield
Prerequisite Editor. This custom action would detect whether the feature prerequisite needs to be run if its associated
feature is selected to be installed.

If the feature prerequisite would need to be run, the custom action would add a temporary row to the ReserveCost table.

See Also
Associating an InstallShield Prerequisite with a Feature in a Basic MSI Project
Disassociating an InstallShield Prerequisite from a Feature in a Basic MSI Project
Designing InstallShield Prerequisites and Other Redistributables

684 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Associating an InstallShield Prerequisite with a Feature in a Basic MSI Project

InstallShield 2020

Project • Basic MSI projects include support for associating prerequisites with features.

To learn about the differences between setup prerequisites and feature prerequisites (which are the two types of InstallShield
prerequisites), see Setup Prerequisites vs. Feature Prerequisites.

If an InstallShield prerequisite is associated with a feature in a project, it is considered to be a feature prerequisite. If it is not
associated with a feature, it is considered to be a setup prerequisite.

Whenever you add an InstallShield prerequisite to an installation project, it is automatically added as a setup prerequisite
by default. You can make it a feature prerequisite by associating it with one or more features that already exist in your
project.

Task To associate an InstallShield prerequisite with a feature:

1. In the View List under Application Data, click Redistributables.

2. In the list of redistributables, select the InstallShield prerequisite that you want to associate with a feature.

Note • The InstallShield prerequisite’s check box must already be selected; this indicates that it is being included in your
project. For more information, see Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and
InstallScript MSI Projects.

3. In the Conditional Installation pane, select the check box of each feature to which you want to add this InstallShield
prerequisite.

If you want to associate the prerequisite with a new feature, you must first create it. To learn how to create a new feature,
see Creating Features.

If you associate a prerequisite with all of the features in your project and then you later add a new feature, InstallShield
does not automatically associate the feature prerequisite with the new feature.

Note • Feature prerequisites have some limitations that setup prerequisites do not have. For more information, see Setup
Prerequisites vs. Feature Prerequisites.

Disassociating an InstallShield Prerequisite from a Feature in a Basic MSI Project

InstallShield 2020

Project • Basic MSI projects include support for associating prerequisites with features.

To learn about the differences between setup prerequisites and feature prerequisites (which are the two types of InstallShield
prerequisites), see Setup Prerequisites vs. Feature Prerequisites.

InstallShield 2020 User Guide ISP-2600-UG00 685

Chapter 4
Organizing Files for Your Installation

If an InstallShield prerequisite is associated with a feature in a project, it is considered to be a feature prerequisite. If it is not
associated with a feature, it is considered to be a setup prerequisite.

Task To remove an InstallShield prerequisite from a feature:

1. In the View List under Application Data, click Redistributables.

2. In the list of redistributables, select the InstallShield prerequisite that you want to disassociate from a feature.

3. In the Conditional Installation pane, select the Install before feature selection check box. This check box is selected
by default when you add an InstallShield prerequisite to a Basic MSI project.

Note • Setup prerequisites have some advantages over feature prerequisites. For more information, see Setup Prerequisites
vs. Feature Prerequisites.

Specifying the Installation Order of InstallShield Prerequisites

InstallShield 2020

Project • Basic MSI projects include support for feature prerequisites.

The following project types include support for setup prerequisites but not feature prerequisites:

• InstallScript
• InstallScript MSI

To learn about the differences between setup prerequisites and feature prerequisites (which are the two types of InstallShield
prerequisites), see Setup Prerequisites vs. Feature Prerequisites.

The Redistributables view is where you specify the order in which InstallShield prerequisites should be installed if you
include more than one in a Basic MSI project or an InstallScript MSI project. The Prerequisites view is where you specify the
order in which InstallShield prerequisites should be installed if you include more than one in an InstallScript project.

Task To specify the order in which the InstallShield prerequisites should be installed on the target machine:

1. In the View List under Application Data, click Redistributables (in a Basic MSI or InstallScript MSI project) or
Prerequisites (in an InstallScript project).

2. Add the necessary InstallShield prerequisites to your project if you have not already done so.

3. Right-click any redistributable and click Set InstallShield Prerequisite Order. The InstallShield Prerequisite
Installation Order dialog box opens.

4. Select a prerequisite in the list and then click the up or down arrow to move it up or down in the order for installation.

Project • Note that when you are specifying the order in a Basic MSI project, InstallShield does not distinguish between setup
prerequisites and feature prerequisites. Thus, if your project contains a mix of setup prerequisites and feature prerequisites,

686 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

they are all listed in one combined list on the InstallShield Prerequisite Installation Order dialog box. At run time, before the
main installation launches, the Setup.exe setup launcher evaluates only the setup prerequisites and—if appropriate—installs
them in the order that you specified on the InstallShield Prerequisite Installation Order dialog box. Then later during the
installation, the Windows Installer engine evaluates only the feature prerequisites and—if appropriate—installs them in the
order that you specified.

Tip • If the Windows Installer engine, the .NET Framework, or both must be installed before an InstallShield prerequisite is
installed, you can open the InstallShield prerequisite in the InstallShield Prerequisite Editor and specify this requirement. For
more information, see Specifying Parameters for Installing an InstallShield Prerequisite.

See Also
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects
Minimizing the Number of User Account Control Prompts During Installation

Configuring a Release that Includes InstallShield Prerequisites

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

When you package a Basic MSI or InstallScript MSI installation that includes InstallShield prerequisites, you can use any
one of the following methods for supplying the InstallShield prerequisite files to end users:

• Store the InstallShield prerequisite files on the source media.

• Compress the InstallShield prerequisite files into Setup.exe, to be extracted at run time, as needed.

• If necessary, your installation can download the InstallShield prerequisite files that are included in your project from
the URL that is specified in the InstallShield prerequisite file (.prq) for each prerequisite.

For InstallScript installations that include InstallShield prerequisites, the methods that are available are slightly different:

• Store the InstallShield prerequisite files on the source media or in Setup.exe, depending on how you configure the
settings for the release.

• If needed, your installation can download the InstallShield prerequisite files included in your project from the URL
specified in the InstallShield prerequisite (.prq) file for each prerequisite.

You can specify different methods for each InstallShield prerequisite in your project. To learn more, see Specifying a Run-
Time Location for a Specific InstallShield Prerequisite.

You can also override individual methods at the release level if you want all of the InstallShield prerequisites in a release to
be available through the same method. For more information, see Specifying the Run-Time Location for InstallShield
Prerequisites at the Release Level.

InstallShield 2020 User Guide ISP-2600-UG00 687

Chapter 4
Organizing Files for Your Installation

You can configure an InstallShield prerequisite so that it is installed either before or after any installation of the Windows
Installer engine and the .NET Framework. For more information, see Specifying Parameters for Installing an InstallShield
Prerequisite.

See Also
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects
Specifying the Installation Order of InstallShield Prerequisites
Defining InstallShield Prerequisites

Specifying the Directories that Contain InstallShield Prerequisites

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

The default location for InstallShield prerequisite files (.prq) is:

InstallShield Program Files Folder\SetupPrerequisites

InstallShield lets you specify additional or alternative locations on your local machine, or on a network. This flexibility
enables you to store InstallShield prerequisites in source code control and to share a common set of InstallShield
prerequisites with other team members.

InstallShield offers several ways for specifying the search paths for InstallShield prerequisite files (.prq):

• If you are editing or building from within InstallShield, use the Prerequisites tab on the Options dialog box—which is
displayed when you click Options on the Tools menu—to specify a comma-delimited list of machine-wide folders and
current-user folders.

InstallShield saves the paths that you specify on the Prerequisites tab in the registry on your machine. The paths that
you specify for the current user are stored in the following location:

HKEY_CURRENT_USER\Software\InstallShield\Version\Professional\Project Settings\PrerequisiteSearchPath

The paths that you specify for all users are stored in the following location:

HKEY_LOCAL_MACHINE\Software\InstallShield\Version\Professional\PrerequisiteSearchPath

The Options dialog box is not available if you are using the Standalone Build to build a release; however, if you want,
you can manually add the paths to the registry on a machine that has the Standalone Build.

• If you are building from the command line with ISCmdBld.exe, use the -prqpath parameter to specify a comma-
delimited list of folders.

If you use an .ini file to specify ISCmdBld.exe parameters, you can use the PrerequisitePath parameter in the [Mode]
section of your .ini file to specify a comma-delimited list of folders.

• If you are building through MSBuild or Team Foundation Server (TFS), use the PrerequisitePath parameter on the
InstallShield task. This parameter is exposed as the ItemGroup InstallShieldPrerequisitePath when the default targets
file is used. To specify multiple paths, use an ordered array of paths.

688 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Instead of using hard-coded paths, you can use path variables in paths, as in the following example:

<ISProductFolder>\SetupPrerequisites,<ISProjectFolder>\MyCustomPrerequisites

The Redistributables view and the Prerequisites view list the names of the InstallShield prerequisites that correspond with
the .prq files that are present in the various search paths that are specified on the Prerequisites tab of the Options dialog
box. If the same .prq file is in multiple search paths, InstallShield shows only the first instance that it encounters.
InstallShield first searches each path that is listed in the per-user setting on the Prerequisites tab. Then, InstallShield
checks each path that is listed in the machine-wide setting.

At build time, if your project includes one or more InstallShield prerequisites, InstallShield (or the Standalone Build)
searches the specified locations and includes the appropriate InstallShield prerequisites in your release as needed. If the
same .prq file is in multiple search paths, InstallShield includes in the build only the first instance that it encounters. It uses
the following order to search for .prq files:

1. InstallShield (or the Standalone Build) checks the paths that are specified through the -prqpath command-line
parameter, the PrerequisitePath .ini file parameter, or the PrerequisitePath parameter on the InstallShield task.

2. InstallShield checks each path that is listed in the per-user setting on the Prerequisites tab. The paths are saved in the
following location in the registry.

HKEY_CURRENT_USER\Software\InstallShield\Version\Professional\Project Settings\PrerequisiteSearchPath

Note that the Prerequisites tab is not applicable to the Standalone Build, but the registry path is applicable.

3. InstallShield checks each path that is listed in the machine-wide setting on the Prerequisites tab. The paths are saved
in the following location in the registry.

HKEY_LOCAL_MACHINE\Software\InstallShield\Version\Professional\PrerequisiteSearchPath

Note that the Prerequisites tab is not applicable to the Standalone Build, but the registry path is applicable.

4. If no paths are specified in any of the aforementioned locations, InstallShield checks the default location
(InstallShield (or Standalone Build) Program Files Folder\SetupPrerequisites).

Tip • If you are using the Standalone Build to build a release that includes InstallShield prerequisites but you do not specify
one or more search paths, the Standalone Build searches the default path (<ISProductFolder>\SetupPrerequisites) for
the InstallShield prerequisite files. However, if you specify one or more search paths and do not explicitly include the default
path, the Standalone Build does not search the default path.

See Also
Using Path Variables

Specifying a Run-Time Location for a Specific InstallShield Prerequisite

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 689

Chapter 4
Organizing Files for Your Installation

InstallShield enables you to specify a different run-time location for each InstallShield prerequisite in your project.

Task To specify a different run-time location for each InstallShield prerequisite in your installation:

1. In the View List under Application Data, click Redistributables (in a Basic MSI or InstallScript MSI project) or
Prerequisites (in an InstallScript project).

2. Select the check box for one of the InstallShield prerequisites that you want to include in your installation.

3. Right-click the InstallShield prerequisite and click Properties. The InstallShield Prerequisites Properties dialog box
opens.

4. In the Build Location list, click the appropriate option.

Note that the location that you specify can be overridden at the release level. To avoid overriding the value that you
selected for an individual InstallShield prerequisite, the InstallShield Prerequisites Location setting at the release level
must be set to Follow Individual Selections. For more information, see Specifying the Run-Time Location for InstallShield
Prerequisites at the Release Level.

Tip • If an InstallShield prerequisite is added to a project as a dependency of another prerequisite, the location for the
InstallShield prerequisite dependency follows the location setting of the InstallShield prerequisite that requires it.

See Also
Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level
InstallShield Prerequisite Properties Dialog Box

Assigning Release Flags to InstallShield Prerequisites

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

You can set release flags for InstallShield prerequisites that you want to exclude from certain builds. For example, if you
have an InstallShield prerequisite that should be included only in a special edition of your product that contains a special
add-on that requires the InstallShield prerequisite, you can flag that InstallShield prerequisite and include it only when it is
needed.

Task To add a release flag to an InstallShield prerequisite that you have added to your installation project:

1. In the View List under Application Data, click Redistributables.

2. Right-click the InstallShield prerequisite and click Properties. The InstallShield Prerequisites Properties dialog box
opens.

690 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

3. In the Release Flags box, type a string. The string can be any combination of letters or numbers. To have more than
one flag on a prerequisite, use a comma to separate the flags.

To learn more about filtering InstallShield prerequisites based on release flags, see Release Flags.

See Also
InstallShield Prerequisite Properties Dialog Box

Building a Release that Includes InstallShield Prerequisites

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

When InstallShield builds a Setup.exe file for a project that does not include any prerequisites, it starts with the base
Setup.exe file that is stored in the following location:

InstallShield Program Files Folder\redist\Language Independent\i386

However, when InstallShield builds a Setup.exe file for a project that includes prerequisites, the aforementioned files
cannot be used as the base because it does not have the capability of including prerequisites. A slightly larger file called
SetupPrereq.exe is used instead. The base SetupPrereq.exe file is located in the same directory as the base Setup.exe
file. Since different base files—Setup.exe and SetupPrereq.exe—are used, only installation authors who are actually
including prerequisites in their projects incur the additional size overhead in the final, built Setup.exe file that is
distributed to end users.

See Also
Creating a Setup Launcher

Run-Time Behavior for an Installation that Includes InstallShield Prerequisites

InstallShield 2020

Project • The following project types include support for both setup prerequisites and feature prerequisites:

• Basic MSI

The following project types include support for setup prerequisites but not feature prerequisites:

• InstallScript
• InstallScript MSI

To learn about the differences between setup prerequisites and feature prerequisites (which are the two types of InstallShield
prerequisites), see Setup Prerequisites vs. Feature Prerequisites.

InstallShield 2020 User Guide ISP-2600-UG00 691

Chapter 4
Organizing Files for Your Installation

Overview of an Installation that Includes InstallShield Prerequisites

The following procedure explains what typically occurs at run time when an end user launches an installation that includes
setup and feature prerequisites. Note that some of the steps apply to only certain project types.

1. The setup launcher (typically called Setup.exe) displays the language selection dialog if appropriate.

2. The setup launcher displays the setup prerequisite dialog and launches the setup prerequisite installations if
appropriate.

3. The installation displays the installation UI, which may allow the end user to select features or configure items. The
installation UI shows a progress dialog.

4. In Basic MSI installations, the setup launcher launches the feature prerequisite installations if appropriate:

a. The built-in InstallShield custom action ISInstallPrerequisites, which is scheduled between the SetupProgress
dialog and the ExecuteAction action, compares the features that were selected for installation against the list in
the Windows Installer property IsPrerequisiteFeatures. If there are no matches, no feature prerequisites are
installed.

b. The ISInstallPrerequisites action attempts to find and launch the setup launcher, and it provides the list of
features that are being installed. The path to the setup launcher is identified by the Windows Installer properties
SETUPEXEDIR and SETUPEXENAME:

[SETUPEXEDIR]\[SETUPEXENAME]

If ISInstallPrerequisites cannot find the setup launcher in that location, it searches elsewhere. For a first-time
installation, ISInstallPrerequisites checks SourceDir. For maintenance mode, ISInstallPrerequisites checks paths
that are related to the installation source path.

If ISInstallPrerequisites still cannot find the setup launcher, or if it finds multiple .exe files, the installation
prompts the end user to browse to the setup launcher file. If the end user identifies the file, the installation
continues. Otherwise, the installation ends.

c. The setup launcher evaluates the list of features to select which feature prerequisites to install, and it launches
their installations as appropriate.

5. The installation finishes making changes on the target system according to the end user’s selections.

6. The installation switches from the progress dialog to the SetupCompleteSuccess dialog.

The User Interface for an Installation that Includes InstallShield Prerequisites

If a target system needs one or more setup prerequisites to be installed, the setup launcher typically displays the setup
prerequisite dialog before the main installation starts. This setup prerequisite lists all of the nonhidden setup prerequisites
that are missing from the target system. When an end user clicks the Install button on this dialog, the setup launcher
launches the necessary setup prerequisite installations. If one or more of the setup prerequisites is marked as requiring
administrative privileges and the installation is run on a system on which User Account Control (UAC) is enabled, the Install
button on this dialog has the shield icon to alert the end user that elevated privileges are required.

692 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Figure 4-2: Sample Setup Prerequisite Dialog that Shows the List of Setup Prerequisites that Need to Be Installed

If a setup prerequisite is configured to be hidden, it is not listed in the setup prerequisite dialog, but it is still installed. If all
of the setup prerequisites in an installation are hidden, the installation displays the setup launcher’s standard initialization
dialog instead of the setup prerequisite dialog.

Tip • For instructions on how to show or hide the setup prerequisite in the setup prerequisite dialog, see Specifying Whether to
Include the Name of a Prerequisite in the List of Setup Prerequisites to Be Installed on the Target System.

If the file that a setup prerequisite installation launches is an .msi package and the prerequisite is marked to show
progress, the user interface shows a status bar, along with installation progress messages from Windows Installer, while
the prerequisite is being installed. This is applicable only if the main installation is a Basic MSI or InstallScript MSI
installation. For more details, see Specifying Whether to Show the Progress of an InstallShield Prerequisite Installation at
Run Time.

If a setup prerequisite is configured to be optionally installed by the end user, the setup launcher displays a message box
that enables end users to choose whether to install the setup prerequisite. For more information, see Allowing End Users to
Choose Whether to Install an InstallShield Prerequisite.

InstallShield 2020 User Guide ISP-2600-UG00 693

Chapter 4
Organizing Files for Your Installation

Figure 4-3: Message Box for an Optional Prerequisite

If an installation includes feature prerequisites, the setup launcher does not list them in any prerequisite dialog. However,
the user interface does show progress messages if appropriate. In addition, the setup launcher displays the optional
prerequisite message box if the feature prerequisite is marked as optional.

Silent Scenarios—Suppressed User Interface in Basic MSI Installations

The installation can install setup prerequisites and feature prerequisites even if the installation is run silently. That is,
InstallShield prerequisites are supported in any of the following scenarios:

• Silent setup launcher and visible .msi package—The user interface for the setup launcher is suppressed, but the
user interface for the .msi package is visible. For example, the end user might use the following command-line
statement:

Setup.exe /s

In this scenario, the language selection dialog and the setup prerequisite dialog are not displayed.

• Visible setup launcher and silent .msi package—The user interface for the setup launcher is displayed, but the user
interface for the .msi package is suppressed. For example, the end user might use the following command-line
statement:

Setup.exe /v“/qn”

In this scenario, the feature selection dialog and all of the other dialogs of the main installation are not displayed.
However, the end user can set Windows Installer properties such as ADDLOCAL, ADDSOURCE, ADDDEFAULT, and ADVERTISE
from the command line to indicate which features should be installed.

• Silent setup launcher and silent .msi package—The user interface for the setup launcher and the .msi package are
suppressed. For example, the end user might use the following command-line statement:

Setup.exe /s /v“/qn”

In this scenario, all of the setup launcher and .msi package dialogs are suppressed.

If the UI sequence of the main installation’s .msi package is skipped, the setup launcher evaluates Windows Installer
properties such as ADDLOCAL, ADDSOURCE, ADDDEFAULT, and ADVERTISE to determine if any feature prerequisites should be
installed, and it installs feature prerequisites accordingly.

694 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Silent Scenarios—Suppressed User Interface in InstallScript and InstallScript MSI

Installations
An InstallScript or InstallScript MSI installation can install setup prerequisites even if the installation is run silently. That is,
InstallShield prerequisites are supported if the end user launches the installation by entering the following command-line
statement:

Setup.exe /s

Note that a response file (Setup.iss) is required. To learn more, see Creating the Response File.

The language selection dialog and the setup prerequisite dialog are not displayed.

UAC Prompts
Depending on how it is configured, an installation that includes InstallShield prerequisites may prompt for elevated
privileges on Windows Vista and later systems at several different points during the installation:

1. When the end user launches the Setup.exe file

2. When the Setup.exe file launches a setup prerequisite that requires elevated privileges

3. When the Setup.exe file launches a feature prerequisite that requires elevated privileges

4. When the Windows Installer begins the Execute sequence of the .msi package

For more information, see Minimizing the Number of User Account Control Prompts During Installation.

Changing the Behavior of InstallShield Prerequisites

The InstallShield Prerequisite Editor enables you to modify an InstallShield prerequisite if you want to change its
installation’s behavior. For example, you can specify whether end users may skip the prerequisite installation, whether the
prerequisite requires administrative privileges, and how the prerequisite installation should proceed if it appears that the
target machine does or does not need to be restarted. To learn more, see Specifying Installation Behavior for an
InstallShield Prerequisite.

You can configure an InstallShield prerequisite so that it is installed either before or after any installation of the Windows
Installer engine and the .NET Framework. For more information, see Specifying Parameters for Installing an InstallShield
Prerequisite.

See Also
Restarting a Target Machine for InstallShield Prerequisite Installations
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects
Specifying the Installation Order of InstallShield Prerequisites
Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level

Uninstalling an Application Whose Installation Included InstallShield Prerequisites

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 695

Chapter 4
Organizing Files for Your Installation

• InstallScript
• InstallScript MSI

Your installation may consist of your application plus one or more InstallShield prerequisites. If end users uninstall your
application through Add or Remove Programs in the Control Panel, the InstallShield prerequisites are still installed on their
machines. If an InstallShield prerequisite installation added an entry to Add or Remove Programs, an end user would be
able to remove that InstallShield prerequisite through Add or Remove Programs.

See Also
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects
Specifying the Installation Order of InstallShield Prerequisites
Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level

Working with Merge Modules that Are Included in Installation Projects

InstallShield 2020

This section of the documentation offers guidance for working with merge modules from within installation projects.

For information on creating or modifying your own merge modules, see Designing Merge Modules.

See Also
Adding Dependencies to Merge Modules
Adding Exclusions to Merge Modules
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects
Determining the Files in InstallShield Prerequisites, Merge Modules, and Objects

Specifying the Directories that Contain Merge Modules

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

InstallShield lets you specify the locations on your local machine, or on a network, where you are storing merge modules
(.msm files). This flexibility enables you to store merge modules in source code control and to share a common set of
merge modules with other team members.

InstallShield offers several ways for specifying the search paths for merge modules:

• If you are editing or building from within InstallShield, use the Merge Modules tab on the Options dialog box—which is
displayed when you click Options on the Tools menu—to specify a comma-delimited list of machine-wide folders and
current-user folders.

InstallShield saves the paths that you specify on the Merge Modules tab in the registry on your machine. The paths
that you specify for the current user are stored in the following location:

696 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

HKEY_CURRENT_USER\Software\InstallShield\Version\Professional\Project Settings\MMSearchPath

The paths that you specify for all users are stored in the following location:

HKEY_LOCAL_MACHINE\Software\InstallShield\Version\Professional\MMSearchPath

The Options dialog box is not available if you are using the Standalone Build to build a release; however, if you want,
you can manually add the paths to the registry on a machine that has the Standalone Build.

• If you are building from the command line with ISCmdBld.exe, use the -o parameter to specify a comma-delimited list
of folders.

If you use an .ini file to specify ISCmdBld.exe parameters, you can use the MergeModulePath parameter in the [Mode]
section of your .ini file to specify a comma-delimited list of folders.

• If you are building through MSBuild or Team Foundation Server (TFS), use the MergeModulePath parameter on the
InstallShield task. This parameter is exposed as the ItemGroup InstallShieldMergeModulePath when the default
targets file is used. To specify multiple paths, use an ordered array of paths.

Instead of using hard-coded paths, you can use path variables in paths, as in the following example:

<ISProductFolder>\MergeModules,<ISProjectFolder>\MyCustomMergeModules

The Redistributables view and the Objects view list the names of the merge modules that correspond with the merge
modules that are present in the various search paths that are specified on the Merge Modules tab of the Options dialog box.
If the same merge module is in multiple search paths, InstallShield shows only the first instance that it encounters.
InstallShield first searches each path that is listed in the per-user setting on the Merge Modules tab. Then, InstallShield
checks each path that is listed in the machine-wide setting.

At build time, if your project includes one or more merge modules, InstallShield (or the Standalone Build) searches the
specified locations and includes the appropriate merge modules in your release as needed. If the same merge module is in
multiple search paths, InstallShield includes in the build only the first instance that it encounters. It uses the following
order to search for merge modules:

1. InstallShield (or the Standalone Build) checks the paths that are specified through the -o command-line parameter,
the MergeModulePath .ini file parameter, or the MergeModulePath parameter on the InstallShield task

2. InstallShield checks each path that is listed in the per-user setting on the Merge Modules tab. The paths are saved in
the following location in the registry.

HKEY_CURRENT_USER\Software\InstallShield\Version\Professional\Project Settings\MMSearchPath

Note that the Merge Module tab is not applicable to the Standalone Build, but the registry path is applicable.

3. InstallShield checks each path that is listed in the machine-wide setting on the Merge Modules tab. The paths are
saved in the following location in the registry.

HKEY_LOCAL_MACHINE\Software\InstallShield\Version\Professional\MMSearchPath

Note that the Merge Module tab is not applicable to the Standalone Build, but the registry path is applicable.

4. If no paths are specified in any of the aforementioned locations, InstallShield checks the following default directories,
in order:

a. InstallShield (or Standalone Build) Program Files Folder\System

b. InstallShield (or Standalone Build) Program Files Folder\Modules\i386

c. InstallShield (or Standalone Build) Program Files Folder\Objects

InstallShield 2020 User Guide ISP-2600-UG00 697

Chapter 4
Organizing Files for Your Installation

d. InstallShield (or Standalone Build) Program Files Folder\Modules\i386\Japanese

e. InstallShield (or Standalone Build) Program Files Folder\Modules\i386\German

f. Program Files Folder\Common Files\Merge Modules

Tip • If you are using the Standalone Build to build a release that includes merge modules but you do not specify one or more
search paths through any of the user-defined methods (that is, in the registry, through the command line or the .ini file, or
through the InstallShield task), the Standalone Build searches the aforementioned default directories for the merge modules.
However, if you specify one or more search paths and do not explicitly include the default directories, the Standalone Build
does not search the default directories.

See Also
Using Path Variables

Overriding a Merge Module’s Destination

InstallShield 2020

Although you should not alter a third-party merge module, you can override the destination for an InstallShield-created
merge module and some third-party merge modules.

Note • This procedure redirects only the TARGETDIR directory in the merge module, or directories that derive directly from
TARGETDIR. If the merge module is configured to send files to a predefined folder (for example, SystemFolder), you cannot
override the module’s destination.

Task To override a merge module’s destination:

1. In the View List under Application Data, click Redistributables.

2. Select the check box next to the merge module to add it to your installation.

3. Right-click the module and click Properties. The Merge Module Properties dialog box opens.

4. In the Destination box, type a destination or select one from the list of predefined destinations.

5. Click OK.

6. In the Conditional Installation pane, select the feature or features that should contain the merge module.

See Also
Redistributables View
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects

698 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Troubleshooting Merge Module Issues

InstallShield 2020

Deleting an Associated Merge Module

If you delete a merge module that is currently associated with your installation, the message [Merge Module Not Found] is
displayed, thereby making you aware that the module cannot be included in your installation.

Changing the Language Property of a Merge Module

If you change the language property of a user-defined merge module or another company’s merge module after it has been
added to the redistributables gallery, a build error occurs if you try to associate the changed merge module with your
project. This error occurs because InstallShield uses the language identifier—along with the module identifier— to identify
the module file.

If the language identifier of a merge module file is changed after the file is added to the redistributables gallery,
InstallShield cannot find the file.

To locate the correct merge module file, you can browse to it from within the Redistributables view. To learn how, see
Browsing for Merge Modules.

See Also
What Happens When You Browse for a Merge Module
Redistributables View
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects

Publishing a Merge Module to a Repository from Within an Installation Project

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

If you have an existing merge module that you would like to reuse in Windows Installer–based installation projects or share
with other users, you can publish it to a repository.

Task To publish a merge module to a repository when you are working on a Windows Installer–based installation project:

1. In the View List under Application Data, click Redistributables.

2. Right-click the merge module and then click Publish Wizard. The Publish Wizard opens.

3. Complete the panels in the Publish Wizard.

Merge modules are built into an installation at build time. If you make a change to a repository merge module and then
republish it to the repository, any project that has the old version of the repository merge module will be updated the next
time that a release of the project’s installation is rebuilt.

InstallShield 2020 User Guide ISP-2600-UG00 699

Chapter 4
Organizing Files for Your Installation

See Also
Publishing a Merge Module to a Repository from Within a Merge Module Project
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Using a Repository to Share Project Elements

Adding Windows Installer Redistributables to Projects

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Although the Windows Installer is built into most versions of Windows, a Windows Installer–based installation may depend
on certain functionality that is available in only the latest versions of Windows Installer. In addition, some InstallScript
installations may require a particular version of Windows Installer.

InstallShield enables you to include a redistributable for Windows Installer in your project. The method for adding a
Windows Installer redistributable to your project depends on the project type that you are using, as well as the version of
Windows Installer that your installation requires.

For a list of the minimum operating for each version of Windows Installer, see Target System Requirements.

For a list of which versions of Windows Installer were released with which versions of Windows, see Released Versions of
Windows Installer in the Windows Installer Help Library.

Note that Windows Installer 5 and Windows Installer 4 are not available as redistributables.

Basic MSI and InstallScript MSI Projects

InstallShield gives you the option of including with your installation a Windows Installer redistributable in a self-extracting
executable file called Setup.exe.

Windows Installer Distribution

By default, InstallShield creates a Setup.exe setup launcher along with your installation package. The setup launcher is
required if you want your installation to install the Windows Installer engine.

If you want to include the Windows Installer redistributable in a Basic MSI or InstallScript MSI project, do one of the
following:

• For Windows Installer 4.5—Add one or more Microsoft Windows Installer prerequisites to your project. InstallShield
includes several versions that target different versions of Windows. For more information, see Including Microsoft
Windows Installer Prerequisites.

• For Windows Installer 3.1, 3.0, or 2.0—The Setup.exe tab for a release in the Releases view is where you specify
information such as whether you want to use a Setup.exe launcher, whether you want to include one of these
versions of the Windows Installer redistributable, and which version of Windows Installer you want to include. To learn
more, see Setup.exe Tab for a Release.

700 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

As an alternative, you can add one or more Microsoft Windows Installer prerequisites to your project. For more
information, see Including Microsoft Windows Installer Prerequisites.

Tip • You can also specify setup launcher requirements in the Setup Launcher panel of the Release Wizard.

Overview of the Installation Process

At run time, Setup.exe determines if Windows Installer is already installed on the target system. If the Windows Installer is
found on the target system and it meets the minimum version requirement, it launches your installation package. If
Windows Installer is not installed, or a more recent version needs to be installed, Setup.exe installs Windows Installer and
then launches your installation package. Note that the system may need to be restarted for Windows Installer to be
updated.

InstallScript Projects
In some cases, you may want to add a Windows Installer redistributable to an InstallScript project. For example, you may
be using an InstallScript project to chain together multiple Windows Installer–based installations that require a particular
minimum version of Windows Installer. In addition, if you add a merge module to an InstallScript project, that merge
module must be added as a subitem of the Merge Module Holder object in the Objects view. This Merge Module Holder
object requires the Windows Installer engine, so if target systems may not have the Windows Installer present, you need to
add the Windows Installer redistributable to your InstallScript project.

If you want to include the Windows Installer redistributable in an InstallScript project, add one or more Microsoft Windows
Installer prerequisites to your project. InstallShield includes several versions that target different versions of Windows. For
more information, see Including Microsoft Windows Installer Prerequisites.

See Also
Creating a Setup Launcher
Setup.exe Return Values and Run-Time Errors (Basic MSI and InstallScript MSI Projects)
SETUPEXEDIR

Including Microsoft Windows Installer Prerequisites

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

InstallShield includes InstallShield prerequisites for several versions of Windows Installer. You can use the Redistributables
view (in Basic MSI and InstallScript MSI projects) or the Prerequisites view (in InstallScript projects) to add these
InstallShield prerequisites to your project.

InstallShield 2020 User Guide ISP-2600-UG00 701

Chapter 4
Organizing Files for Your Installation

Checking for the Presence of Windows Installer 4.5 During Basic MSI or InstallScript
MSI Installations
You may want your installation to check the target system to determine if Windows Installer 4.5 is installed; if it is not
installed, the installation would display an error message box and prevent the installation from continuing. This may be
helpful under the following conditions:

• Your installation depends on Windows Installer 4.5 features.

• It is possible that the .msi file might be used to install your product, rather than the Setup.exe setup launcher (which
would install Windows Installer 4.5 if appropriate).

For example, if you deploy your installation as an uncompressed release, end users would be able to launch the .msi
file directly rather than the Setup.exe file. In addition, if systems administrators want to customize your installation
for deploying your product throughout an enterprise environment, they might create an administrative installation
version and deploy that.

To determine whether Windows Installer 4.5 is installed and display an error message if it is not, create an error custom
action (a type 19 custom action). The following procedure explains how.

Task To determine whether Windows Installer 4.5 is installed and display an error message if it is not:

1. In the Custom Actions and Sequences view, right-click the Custom Actions explorer and click New Error.

2. Select the new custom action.

3. In the Error Message setting, type the error message text that should be displayed when an end user launches your
installation without Windows Installer 4.5 being already installed.

4. In the Install UI Sequence and Install Exec Sequence settings, select an option that would schedule the error
message somewhere before the LaunchConditions action. For example, a common sequence for this error action is
<First Action>.

5. In the Install UI Condition and Install Exec Condition settings, type the following condition:

VersionMsi < "4.05"

Locked File/Reboot Issues

When the InstallShield prerequisite installs the Windows Installer 4.5 engine, the existing engine files are often locked. If
your installation needs to use the updated engine before the target system is rebooted, be aware of the following behavior.

On Windows XP and Windows Server 2003 systems, the Windows Installer 4.5 engine files are updated immediately and the
requirement for a reboot is noted and delayed until the end of the main installation (or any reboot that precedes it). The
main installation uses the updated Windows Installer 4.5 engine, and it requests a reboot at the end of the installation.

On Windows Vista and Windows Server 2008 systems, the Windows Installer 4.5 engine files are not updated until after a
reboot, so a reboot is requested immediately. If the end user allows the machine to be rebooted, the installation continues
after the reboot. If the end user does not allow the machine to be rebooted, the installation ends. While the reboot is
pending, the Windows Installer 4.5 engine appears as not installed, and subsequent attempts to run the prerequisite would
result in a failure and would not allow installation to continue. Rebooting the machine completes the installation of
Windows Installer 4.5 and allows the installation to continue as planned.

702 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

See Also
Adding Windows Installer Redistributables to Projects
Modifying an Existing InstallShield Prerequisite
InstallShield Prerequisite Editor Reference

Adding .NET Framework Redistributables to Projects

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

If your product requires that the .NET Framework be installed on the target system, you can add the .NET Framework
redistributable to your project. If the target system does not have the .NET Framework, it is installed during your
installation.

You can also include redistributables for .NET Framework language packs in your project. The language packs contain
translated text, such as error messages, for languages other than English.

The method for adding the .NET Framework and .NET Framework language packs to your project depends on the project
type that you are using, as well as the version of .NET Framework that your product requires.

Note • Some .NET Framework versions include earlier .NET Framework versions:

• .NET Framework 3.5 includes .NET Framework 3.0 SP1 and .NET Framework 2.0 SP1.
• .NET 3.0 Framework SP1 includes .NET Framework 2.0 SP1.
• .NET 3.0 Framework RTM includes .NET Framework 2.0 RTM .

Basic MSI and InstallScript MSI Projects

If you want to include .NET support in a Basic MSI or InstallScript MSI project, add the appropriate Microsoft .NET
Framework prerequisite. For more information, see Including the Microsoft .NET Framework and Microsoft .NET
Framework Language Pack Prerequisites.

Note • This includes .NET Framework 4.5 Full, 4.5 Web, 4.0 Full, 4.0 Client, 3.5 SP1, 3.5, 3.0 SP1, 3.0, 2.0 SP2, 2.0 SP1, or 2.0 (only
x64, IA64) redistributables.

To test whether the .NET Framework is already installed on the target system, you can use the built-in
MsiNetAssemblySupport property. It is set to the version of a particular .NET DLL (fusion.dll) if the .NET Framework is
installed, and it is not set if the .NET Framework is not installed.

InstallScript Projects
InstallScript projects support two methods for adding the .NET Framework redistributables to your project:

• Use the Prerequisites view to add one or more .NET Framework prerequisites to your project.

InstallShield 2020 User Guide ISP-2600-UG00 703

Chapter 4
Organizing Files for Your Installation

• Use the Objects view to add the Microsoft .NET Framework object to your installation. This object also enables you to
add one or more language packs to an InstallScript project. To learn more, see Microsoft .NET Framework Object
Wizard.

To determine whether a particular version of the .NET Framework or a language pack is installed, use the Is function and
pass the DOTNETFRAMEWORKINSTALLED predefined constant.

Obtaining InstallShield Prerequisites and Objects

Note that some of the InstallShield prerequisites and objects are not installed with InstallShield. You may need to
download them. For more information, see Obtaining Updates for InstallShield.

See Also
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects

Including the Microsoft .NET Framework and Microsoft .NET Framework Language Pack
Prerequisites
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

InstallShield includes InstallShield prerequisites for some versions of the .NET Framework and the .NET Framework
language packs. You can include these InstallShield prerequisites in Basic MSI, InstallScript, and InstallScript MSI projects if
you want to redistribute these versions of the .NET Framework and the language packs.

Following is a list of the .NET Framework redistributables that are available as InstallShield prerequisites. The associated
language pack prerequisites are included if available.

• Microsoft .NET Framework 4.5. (One InstallShield prerequisite is for the full package, and one is for the Web package.
The Web package is smaller in size, but it requires an Internet connection on the target system at run time.)

• Microsoft .NET Framework 4 Full, which installs the .NET Framework runtime and associated files that are required to
run and develop applications that target the .NET Framework 4. (One InstallShield prerequisite is for the full package,
and one is for the Web Download package. The Web Download package is smaller in size, but it requires an Internet
connection on the target system at run time.)

• Microsoft .NET Framework 4 Client, which installs the .NET Framework runtime and associated files that are required
to run most client applications. (One InstallShield prerequisite is for the full package, and one is for the Web Download
package. The Web Download package is smaller in size, but it requires an Internet connection on the target system at
run time.)

• Microsoft .NET Framework 3.5 SP1 (One InstallShield prerequisite is for the full package, and one is for the Web
Download package. The Web Download package is smaller in size, but it requires an Internet connection on the target
system at run time.)

704 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• Microsoft .NET Framework 3.5 (One InstallShield prerequisite is for the full package, and one is for the Web Download
package. The Web Download package is smaller in size, but it requires an Internet connection on the target system at
run time.)

• Microsoft .NET Framework 3.0 SP1 (This is a Web Download package, which requires an Internet connection on the
target system at run time.)

• Microsoft .NET Framework 3.0

• Microsoft .NET Framework 3.0 (x64)

• Microsoft .NET Framework 2.0 SP2

• Microsoft .NET Framework 2.0 SP2 (x64)

• Microsoft .NET Framework 2.0 SP2 (IA64)

• Microsoft .NET Framework 2.0 SP1 (x86)

• Microsoft .NET Framework 2.0 SP1 (x64)

• Microsoft .NET Framework 2.0 SP1 (IA64)

• Microsoft .NET Framework 2.0 (x64)

• Microsoft .NET Framework 2.0 (IA64)

Tip • For information on other versions of the .NET Framework redistributables, see Adding .NET Framework Redistributables
to Projects.

These InstallShield prerequisite installations are run in silent mode. Therefore, the language in which the .NET Framework
installation runs is not an issue.

Since there currently is no way to install Windows Installer 3.x on 64-bit Itanium systems running Windows XP, and since
.NET Framework 2.0 and later require Windows Installer 3.x or later, the 64-bit .NET Framework 2.0 prerequisites cannot be
installed on 64-bit Itanium systems running Windows XP.

The InstallShield prerequisite installations determine if the corresponding version of the .NET Framework is already
installed on the target machine by checking the Install or InstallSuccess value data for a particular HKEY_LOCAL_MACHINE
key. For more details, you can open any InstallShield prerequisite in the InstallShield Prerequisite Editor and note the
conditions that are set.

See Also
Adding .NET Framework Redistributables to Projects
Modifying an Existing InstallShield Prerequisite
InstallShield Prerequisite Editor Reference

Including the MySQL Connector ODBC Prerequisite

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 705

Chapter 4
Organizing Files for Your Installation

• InstallScript
• InstallScript MSI

You can include in your installation an InstallShield prerequisite that installs MySQL Connector/ODBC 3.51. It enables end
users to connect to a MySQL database server that uses ODBC. Before you can add this InstallShield prerequisite to your
projects, you must download the MySQL Connector/ODBC driver and configure the InstallShield prerequisite on your
system.

Task To add the MySQL Connector ODBC 3.51 prerequisite to your system so that you can add it to your projects:

1. Open Windows Explorer and browse for the InstallShield prerequisite template folder. The default location is:

C:\Program Files\InstallShield\2020\SetupPrerequisites\Templates

2. Copy the MySQL Connector ODBC 3.51.prq file that is in the Templates folder, and paste it in the InstallShield
prerequisite folder. The default location is:

C:\Program Files\InstallShield\2020\SetupPrerequisites

3. Visit http://dev.mysql.com/downloads/connector/odbc/3.51.html and download the MSI installer for the MySQL
Connector/ODBC 3.51 driver for Windows.

4. Save the file in the following location:

InstallShield Program Files Folder\Objects\MySQL\Redist

The next time that you launch InstallShield, the MySQL Connector ODBC prerequisite is available in the Redistributables
view.

If you want to change the location on your machine where you store the installer for the MySQL Connector/ODBC 3.51
driver, you can do so by opening the MySQL Connector ODBC 3.51.prq file in the InstallShield Prerequisite Editor and
modifying the settings. To open the InstallShield Prerequisite Editor, click Prerequisite Editor on the Tools menu. For more
information, see Specifying Files for an InstallShield Prerequisite.

See Also
Installing the MySQL ODBC Driver

Including the InstallShield Prerequisite for the Oracle 11g Instant Client
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

If you want to install the Oracle 11g Instant Client before your installation is run, you can include the Oracle 11g Instant
Client prerequisite in your project. Before you can add this InstallShield prerequisite to your projects, you must download
Oracle Instant Client and create an .msi package on your system. For more information, see Connecting to an Instance of
Oracle and Running SQL Scripts.

706 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Note • If you want your installation to download the Oracle 11g Instant Client whenever it needs to be installed on a target
system, check with Oracle to ensure that it is allowed. If it is allowed, you must host the download on your own Web site and
add its download path to the InstallShield prerequisite. Revenera does not make this installation available for download.

See Also
Working with InstallShield Prerequisites that Are Included in Installation Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects

Including the DirectX 9.0 Object

InstallShield 2020

DirectX provides supporting API libraries for multimedia applications and hardware, including the latest graphics cards. If
your product requires DirectX to be installed on the target system, you can add the DirectX object—either the Windows
Installer–based object for Basic MSI and InstallScript MSI projects, or the InstallScript object for InstallScript projects—to
your project. If the target system does not have DirectX, it is installed during your installation.

After installation, the DirectX runtime cannot be uninstalled. DirectX is a system component; end users cannot uninstall it
without reinstalling the operating system.

Tip • The DirectX object is not installed with InstallShield; you need to download it. To include the DirectX object in Basic MSI
or InstallScript MSI projects, obtain the MSI object download. To include the DirectX object in InstallScript projects, obtain the
InstallScript object download. To learn more, see Obtaining Updates for InstallShield.

Redistributable Files
The DirectX objects install all DirectX 9.0c core and optional components, including 32-bit- and 64-bit-specific components.

Including the DirectX Object in Basic MSI and InstallScript MSI Projects
When you add the DirectX object to a Basic MSI or InstallScript MSI project, InstallShield launches the DirectX Object
Wizard.

You can use the DirectX object in compressed or uncompressed installations; the DirectX Object Wizard lets you specify
whether the DirectX files should be in a folder in the Disk1 folder, or they should be streamed into the .msi file:

• If you specify that the files should be in a folder in the Disk1 folder, InstallShield creates a DirectX folder for your
installation at build time and places it in the Disk1 folder of your release. InstallShield lists the DirectX folder in the
Disk1 area of the Support Files view (in Basic MSI projects) or the Support Files/Billboards view (in InstallScript MSI
projects).

• If you specify that the files should not be in the Disk1 folder, InstallShield embeds the files in your installation’s .msi
file. InstallShield lists these files in the Language Independent area of the Support Files view (in Basic MSI projects) or
the Support Files/Billboards view (in InstallScript MSI projects).

Note • The custom action that launches the DirectX installation is sequenced in the Execute sequence and run in deferred
system context so that it can be run with elevated privileges on Windows Vista and later systems.

InstallShield 2020 User Guide ISP-2600-UG00 707

Chapter 4
Organizing Files for Your Installation

Updating the DirectX Object Files for Basic MSI and InstallScript MSI Projects
If you obtain updates for any of the DirectX files and you want to include them in your DirectX object, place them in the
appropriate InstallShield Program Files subfolder with the other DirectX files. The location is:

InstallShield Program Files Folder\Objects\DirectX9c\Redist

You can also remove files from that folder if your product does not require them and you do not need to include them in
your installation. For more information about the DirectX redistributable files, including details about any updates that
Microsoft may have released since the current version of InstallShield was released, see the latest DirectX SDK or
Microsoft’s MSDN Web site.

At build time, InstallShield uses whatever redistributable files are in that DirectX folder to build your release.

See Also
DirectX Object Wizard

Identifying Application Dependencies

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

A file often relies on functions in other files to perform a task. However, you may not be aware of all these other files—
known as dependencies—when you include your application’s files in your installation project. InstallShield offers scanning
wizards to assist you in identifying and working with these files. You can access these scanners in the Dependency
Scanners view.

Table 4-13 • Available Scanning Wizards

Scanner Description

Static Scanning Wizard Looks at portable executable files (for example, .exe, .ocx, .com, .tlb, .hlp, and
.chm) in your project and checks for dependencies that they may require.

Dynamic Scanning Wizard Monitors your system while an executable file is running and checks for .dll or .ocx
files that may be required by the executable file.

Any files that are added to a Basic MSI or InstallScript MSI project through one of these scanners are added in accordance
with Setup Best Practices.

If you use the Static and Dynamic scanning wizards, you can specify files that you want to be included or excluded
automatically any time that you perform a static or dynamic scan through InstallShield. For more information, see Filtering
Files in Dependency Scanners.

708 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

See Also
Reviewing Dependency Scanner Results
Scanning for 64-Bit Dependencies
Dependency Scanners
Opening InstallShield Projects in Microsoft Visual Studio

Static Scanning
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

The Static Scanning Wizard enables you to scan the files already added to your project for any dependencies that they may
require. This wizard scans all portable executable files (.exe, .dll, .ocx, .sys, .com, .drv, .scr, and .cpl files) in your project and
checks for dependencies that they may require. The wizard displays a list of the dependencies that it finds, and it lets you
specify whether you want to include each one in your project.

The new files added to your project are added to the same feature as the file that depends upon them, thereby ensuring
that they are installed when needed.

How the .NET Scan at Build Setting Affects Static Scanning

In Basic MSI, InstallScript MSI, and Merge Module projects, the value that is selected for a component’s .NET Scan at Build
setting affects how the Static Scanning Wizard scans the files in that component:

Table 4-14 • Determining How the Static Scanning Wizard Scans Files in a Component

Value of a
Component’s .NET
Scan at Build Setting Description

None The Static Scanning Wizard does not scan the .NET portion of the component for
dependencies or properties. For example, if your component contains Notepad.exe and a
.NET assembly file, the Static Scanning Wizard scans Notepad.exe for dependencies and
does not scan the .NET assembly file for dependencies or properties.

Properties Only The Static Scanning Wizard scans the entire component—all files in the component,
including .NET assemblies—for properties, but it does not identify dependencies for the .NET
portion of the component. For example, if your component contains Notepad.exe and a .NET
assembly file, the Static Scanning Wizard scans both files for properties, but it does not
identify dependencies for the .NET assembly file.

InstallShield 2020 User Guide ISP-2600-UG00 709

Chapter 4
Organizing Files for Your Installation

Table 4-14 • Determining How the Static Scanning Wizard Scans Files in a Component (cont.)

Value of a
Component’s .NET
Scan at Build Setting Description

Dependencies and The Static Scanning Wizard scans the entire component—all files in the component,
Properties including .NET assemblies—for dependencies and properties. Any dependencies that are
found during the scan are presented in the File Selection panel. If any properties are found
for .NET files, InstallShield adds the properties to the .NET Assembly subnode under the
Assembly node in the Advanced Settings area of a component.

See Also
Static Scanning Wizard
Reviewing Dependency Scanner Results
Scanning for 64-Bit Dependencies

Dynamic Scanning
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

The Dynamic Scanning Wizard is an easy-to-use tool that monitors your system while an executable file runs. The wizard
displays a list of .dll and .ocx files that may be required by the executable file, and it lets you specify whether you want to
include each one in your project.

The executable file you want to scan can already be included to your project, or it can be added by the wizard.

To learn more about this wizard, see Dynamic Scanning Wizard.

See Also
Reviewing Dependency Scanner Results
Scanning for 64-Bit Dependencies

Scanning for 64-Bit Dependencies

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

710 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

If you use InstallShield on a 64-bit version of Windows Vista or later or a 64-bit version of Windows Server 2008 or later, the
Static Scanning Wizard and the Dynamic Scanning Wizard can scan for 64-bit dependencies of the 64-bit files in your
project. These wizards can also scan for 32-bit dependencies of the 32-bit files in your project.

Note that if you use InstallShield on a 32-bit version of Windows, these wizards can scan for only 32-bit dependencies of the
32-bit files in your project. If your project includes 64-bit files, you can manually add any dependencies to the project as
needed.

See Also
Reviewing Dependency Scanner Results
Dependency Scanners

Reviewing Dependency Scanner Results

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

The Static Scanning Wizard and the Dynamic Scanning Wizard scan your project to help you identify other files that your
product may require. Each of these wizards displays a list of possible files and merge modules that you may need to add to
your project. Review the scan results carefully, and determine whether it is appropriate to add each specified file and
merge module to your project.

Both of the scanners works differently to identify dependencies. In some cases, one of the scanners may identify a
dependency that the other does not identify. Therefore, you may want to try using both the static and dynamic scanning
wizards for a more complete list of potential dependencies. In some scenarios, a dependency scanner may identify as a
dependency a file or merge module that is not required by your product. If that occurs, you can exclude that file or merge
module, since the wizards let you include or exclude each identified dependency as needed. In addition, InstallShield
enables you to specify on a machine-wide basis any files that you want to be included or excluded automatically any time
that you perform a static or dynamic scan through InstallShield. For more information, see Filtering Files in Dependency
Scanners.

To obtain the best results when you are trying to identify dependencies, it is recommended that you thoroughly test your
product and its installation on a clean machine. If your product does not behave as expected, determine whether any
dependencies are missing from the machine, and if so, whether they should be included in the installation.

See Also
Scanning for 64-Bit Dependencies

Filtering Files in Dependency Scanners

InstallShield 2020

When you run the Static and Dynamic scanning wizards, you may find that they list as dependencies certain files that you
do not want added to your installation. To avoid having these files added every time you run the scanner, you can edit
Filters.xml. This file enables you to specify any files that you want the scanners to ignore or include.

InstallShield 2020 User Guide ISP-2600-UG00 711

Chapter 4
Organizing Files for Your Installation

Filters.xml is in the following location:

InstallShield Program Files Folder\Support

The file must remain in this location after you edit it; otherwise, the scanners will not work properly.

Tip • You can also use the Filters.xml file to control which registry items should be excluded during COM extraction. For
more information, see Filtering Registry Changes for COM Extraction.

The Filters.xml file also lets you control which IIS settings should be excluded when you are importing an IIS Web site. For
more information, see Filtering IIS Data When Importing a Web Site and Its Settings into an InstallShield Project.

Excluding Files
The <Exclude> element in the Filters.xml file is where you add subelements for each of the files that you want the
scanners to exclude. Any files that are listed here will not be added to your installation project by the scanners.

By default, the <Exclude> element has subelements for common system files that are present on all Windows–based
machines.

Including Files
The <Include> element in the Filters.xml file gives you the ability to override individual files that are subelements of the
<Exclude> element. Any files that are listed in subelements of the <Include> element will be added to your installation
project by the scanners, even if the files are also listed in subelements of the <Exclude> element.

Note • The following vital operating system files are never recognized by the scanner, even if you add them as subelements of
the <Include> element:

• kernel32.dll
• ntdll.dll
• user32.dll
• gdi32.dll
• advapi32.dll
• shell32.dll
• ole32.dll

Specifying Files in the <Exclude> and <Include> Elements

If you want to list a file under the <Exclude> or <Include> elements, you must add the file as a subelement. Following is a
sample of a properly formatted subelement:

712 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

<File name="myfile.dll" path="[SystemFolder]" We="needthis"/>

Table 4-15 • Recognized Attributes for the <File> Subelement

Attribute Description

name This attribute must be lowercase. The value of this attribute (for example, myfile.dll in the above
example) indicates the name of the file that you want to include or exclude.

path This attribute is optional. The value of this attribute (for example, [SystemFolder] in the above
example) indicates the path of the file.

Any other attributes are optional and are not recognized by the scanners. You may want to add additional attributes—such
as the We attribute in the example above and the corresponding "needthis" value—to identify why an item is being
excluded or included.

Important • Ensure that your XML code is well formed; if its not well formed, all of the filters fail. In most cases, you can
identify improperly formed XML code by opening the Filters.xml file in Internet Explorer. You should be able to expand and
contract the <Filters>, <Include>, and <Exclude> elements; if you cannot, check the code for errors.

If you add subelements to the <Exclude> or <Include> elements, be sure that you do not place them within the commented-out
section, since InstallShield ignores that area of the Filters.xml file.

The following sample XML code shows the format of the Filters.xml file:

<Filters>
<Include>
<!--Instructions on how to add files to this element.
-->
<File name="mfc42.dll" We="needthis"/>
</Include>
<Exclude>
<!--Instructions on how to add files to this element.
-->
<Registry key="HKEY_CLASSES_ROOT\Interface\{00020404-0000-0000-C000-000000000046}"/>
<File name="12520437.cpx" path="[SystemFolder]" wrp="4.0-10.0" />
<File name="12520850.cpx" path="[SystemFolder]" wrp="4.0-10.0" />
</Exclude>
</Filters>

See Also
Reviewing Dependency Scanner Results
Dependency Scanners
Static Scanning Wizard
Dynamic Scanning Wizard

InstallShield 2020 User Guide ISP-2600-UG00 713

Chapter 4
Organizing Files for Your Installation

Registering COM Servers

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

Most applications require certain COM servers in order to operate properly. In order for the operating system to recognize
these COM servers, you need to register them.

With traditional COM, COM data is written directly to the registry. Registry-free COM, or Reg-Free COM, offers a simple
alternative to the traditional method. With Reg-Free COM, COM data is written to an application manifest file.

Traditional COM Registration

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

InstallShield supports multiple methods for registering a COM server on a target machine. The following methods are the
ones used traditionally:

• The COM information can be extracted from the file at build time (or design time) and written to the COM-related
tables of your .msi database.

• The COM server’s self-registration function can be called at installation time.

The first method listed—extracting the COM information and writing it to the .msi database—is preferred over the self-
registration method. The first method writes the COM class information to the Class, ProgID, and Registry tables of the
.msi database.

714 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Determining Whether a COM Server Supports Self-Registration

InstallShield 2020

Not all COM servers support self-registration. Although it is likely that you will know which files in your installation are self-
registering, there may be times when you do not know. Because you must handle self-registering files differently than non-
self-registering files, you need to be able to determine if a file is self-registering.

In most cases, you can determine whether a file is self-registering if you add it to an InstallShield project. InstallShield tests
COM server files when they are added to a project to determine if they are self-registering files. If InstallShield determines
that a COM server added to your project is self-registering:

• For Windows Installer–based projects: InstallShield sets the COM Extract at Build property of the file’s component to
Yes (if you have specified on the Preferences tab of the Options dialog box that COM extraction should occur at build
time).

• For InstallScript-based projects: InstallShield marks the file as self-registering.

Extracting COM Information from a COM Server

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

Note that for MSI Database and MSM Database projects, COM information cannot be extracted at build time; it is extracted at
design time.

The recommended method for registering COM servers is to use Windows Installer tables in the .msi database to make the
necessary registry entries for your COM server. With this method, Windows Installer is capable of registering files when they
are advertised, and it can safely roll back the registration information in case of a failed installation.

Since each component should have only one portable executable file, the assumption is that all of the registration
information belongs to a single file, marked as the key file of its component.

InstallShield supports several methods for extracting COM information from a COM server:

• Use the Component Wizard. You can use this wizard to create a new COM server component. With this method, the
wizard performs a one-time scan of COM information from the component’s key file.

• For a component’s COM Extract at Build setting, select Yes. Since InstallShield extracts the COM data every time that
you build a release, this method is helpful if your COM server’s interfaces change frequently. The COM server must be
the key file of its component for this method.

• Extract the information by right-clicking the file in the Files and Folders view and then clicking Extract COM Data for
Key File. Use this method if you have already added the COM server file to a component.

InstallShield 2020 User Guide ISP-2600-UG00 715

Chapter 4
Organizing Files for Your Installation

As an alternative to having InstallShield extract the COM data, you can manually add COM information to a component in
the component’s Advanced Settings.

If you do not want InstallShield to extract COM information every time that you build a release, select No for the COM
Extract at Build setting of the component. Use this method if you want InstallShield to register the file according to the
information that is statically contained in the component’s COM Registration advanced setting. This advanced setting
stores information about the file’s COM classes, ProgIDs, and so on, that were either extracted in the Component Wizard or
entered manually in the Advanced Setting area.

When InstallShield extracts COM information from a COM server, the COM class information is written to the Class,
ProgId, and Registry tables of the .msi database.

If you are using InstallShield on a 64-bit operating system, InstallShield can extract COM data from a 64-bit COM server. In
order to install the data to the correct locations, the component must be marked as 64 bit. To learn more about 64-bit
support, see Targeting 64-Bit Operating Systems.

InstallShield employs a special technique to find all COM information on a COM server without actually registering it.
Therefore, COM extraction does not affect the system registry. However, some COM servers’ registration processes depend
on existing registry entry values. Although InstallShield has developed an algorithm to avoid this scenario, it may not be
foolproof in some extreme cases.

Caution • Some applications, like WinRunner, insert hook .dll files into the COM extraction engine. This causes COM
extraction to fail and displays the following message: "ISRegSpy detects following module %1 hooked into this process, which
causes ISRegSpy to malfunction. You need to shut the application down and restart COM extraction." If you encounter this
message, shut down the application and restart COM extraction, as the dialog box instructs.

Do not select the self-registering property for .exe files that are not self-registering. To self-register an .exe file, you need to
launch the .exe file with the /regserver command. However, if the .exe file does not support the command line switch, the .exe
file will be launched during extraction at build time.

Note • The definitions of the COM-related Windows Installer tables prevent a COM server from being placed in more than one
feature. If a COM server needs to be placed in more than one feature, the following are two available options:

• Make the second feature that requires the COM server a child of the first, and place the file in the parent feature.
• Use self-registration on the COM server instead of using the COM-related Windows Installer database tables.

See Also
Setup Best Practices
Setting Component Key Files

Filtering Registry Changes for COM Extraction

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI

716 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

• Merge Module
• MSI Database
• MSM Database

To prevent InstallShield from extracting undesired COM data from a COM server (either at build or design time), you can
edit the Filters.xml file and specify the registry keys to be excluded. Filters.xml is in the following location:

InstallShield Program Files Folder\Support

The file must remain in this location after you edit it; otherwise, COM extraction will not work properly.

Tip • You can also use the Filters.xml file to control which files should be included or excluded during dependency
scanning. For more information, see Filtering Files in Dependency Scanners.

The Filters.xml file also lets you control which IIS settings should be excluded when you are importing an IIS Web site. For
more information, see Filtering IIS Data When Importing a Web Site and Its Settings into an InstallShield Project.

Excluding Registry Keys from COM Extraction

The <Exclude> element in the Filters.xml file is where you add subelements for each of the registry keys that you want
the COM extraction process to exclude. Any keys that are listed here will not be uninstalled when your product is
uninstalled.

By default, the <Exclude> element has subelements for common system registry keys that are required.

Specifying Registry Keys in the <Exclude> Element

If you want to list a key under the <Exclude> element, you must add the key as a registry subelement.

Following is a sample of a properly formatted registry subelement that blocks changes to an InprocServer32 registry key,
all of its values, and all of its subkeys:

<Registry key="HKEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID\{00000231-0000-0010-8000-
00AA006D2EA4}\InprocServer32"/>

Following is a sample of a properly formatted registry subelement that blocks changes to only the default value of an
InprocServer32 registry key:

<Registry key="HKEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID\{00000231-0000-0010-8000-
00AA006D2EA4}\InprocServer32" value=""/>

Following is a sample of a properly formatted registry subelement that blocks changes to only the ThreadingModel value
name for an InprocServer32 registry key:

InstallShield 2020 User Guide ISP-2600-UG00 717

Chapter 4
Organizing Files for Your Installation

<Registry key="HKEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID\{00000231-0000-0010-8000-
00AA006D2EA4}\InprocServer32" value="ThreadingModel"/>

Table 4-16 • Recognized Attributes for the <Registry> Subelement

Attribute Description

key This attribute must be lowercase. The value of this attribute (for example,
HKEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID\{00000231-0000-0010-8000-
00AA006D2EA4}\InprocServer32 in the above examples) indicates the name of the registry key that
you want to filter.

value This attribute is optional:

• To block changes to an entire registry key, do not include the value attribute.

• To block changes to the default value of the specified key, set the value of this attribute to a null
value.

• To block changes to the name of a value of the specified key, set the value of this attribute to the
name of that registry value.

Any other attributes for the <Registry> subelement are optional and are not recognized by the COM extraction process. You
may want to add additional attributes to identify why an item is being excluded.

Important • Ensure that your XML code is well formed; if its not well formed, all of the filters fail. In most cases, you can
identify improperly formed XML code by opening the Filters.xml file in Internet Explorer. You should be able to expand and
contract the <Filters>, <Include>, and <Exclude> elements; if you cannot, check the code for errors.

If you add subelements to the <Exclude> or <Include> elements, be sure that you do not place them within the commented-out
section, since InstallShield ignores that area of the Filters.xml file.

The following sample XML code shows the format of the Filters.xml file:

<Filters>
<Include>
<!--Instructions on how to add files to this element.
-->
</Include>
<Exclude>
<!--Instructions on how to add files to this element.
-->
<Registry key="HKEY_CLASSES_ROOT\Interface\{00020404-0000-0000-C000-000000000046}"/>
<File name="12520437.cpx" path="[SystemFolder]" wrp="4.0-10.0" />
<File name="12520850.cpx" path="[SystemFolder]" wrp="4.0-10.0" />
</Exclude>
</Filters>

718 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Self-Registering COM Servers

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

If you have a COM server that is self-registering, you can call the COM server’s self-registration functions at installation time
to register the COM server on the target machine.

InstallShield supports different methods for indicating that a COM-related file (.ocx, .dll, .exe, .tlb, or .olb) is self-registering:

• You can specify that a particular file is self-registering. For more information, see File Properties Dialog Box.

• You can specify that a dynamic link is self-registering. For more information, see Dynamic File Link Settings Dialog
Box.

Tip • If the self-registering file is part of a 64-bit component, 64-bit self-registration occurs on the target machine. For more
information, see Targeting 64-Bit Operating Systems.

When you mark a COM server .dll or .ocx file as self-registering, the file’s own registration function (DllRegisterServer) is
called during installation to register it with the target system, and its unregistration function (DllUnregisterServer) is
called during uninstallation to unregister the file.

Registering a file with DllRegisterServer has several limitations:

• COM information registered with DllRegisterServer cannot be advertised.

• Because DllRegisterServer is .dll code, its effects cannot reliably be rolled back during a failed installation.

• DllRegisterServer cannot distinguish between per-user and per-machine COM information.

• Self-registration may require COM servers to be registered in a particular order. InstallShield self-registration
(ISSelfReg) enables you to overcome this limitation.

• DllRegisterServer generally does not register a file with a relative path, as needed by systems that support side-by-
side sharing.

In addition, if you use any type of self-registration in a patch, the patch will not be uninstallable.

When you mark one or more files as self-registering, InstallShield adds data to a table of your .msi database, and adds
some custom actions related to self-registration to your installation Execute sequence. For details, see Self-Registration
Methods and InstallShield Self-Registration (ISSelfReg).

Per-machine self-registration information is stored in the registry key HKLM\SOFTWARE\Classes\CLSID, and per-user self-
registration information is stored in HKCU\SOFTWARE\Classes\CLSID; a merged view of the data is available under
HKCR\CLSID.

InstallShield 2020 User Guide ISP-2600-UG00 719

Chapter 4
Organizing Files for Your Installation

See Also
Determining Whether a COM Server Supports Self-Registration

Self-Registration Methods

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

On the Preferences tab of the Options dialog box, you can select whether you want to use the InstallShield self-registration
method (ISSelfReg) or the Windows Installer self-registration method (SelfReg).

Note • If you use any type of self-registration in a patch, the patch will not be uninstallable.

Windows Installer Self-Registration

Windows Installer self-registration does the following:

• Registers only .dll and .ocx files.

• Registers files in arbitrary order.

• Can register 64-bit files if the self-registering file is part of a 64-bit component.

InstallShield Self-Registration
InstallShield self-registration does the following:

• Can register .exe, .tlb, .dll, and .ocx files.

• Uses batch mode registration to handle any registration dependencies at run time.

• Requires the inclusion of a self-registration engine that is 70 KB in overhead.

• Can register 64-bit files if the self-registering file is part of a 64-bit component.

Note • With InstallShield self-registration, you can specify the order in which the files are registered at run time. You can set
the order in the ISSelfReg table (Order column) in the Direct Editor.

See Also
Direct Editor

720 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

InstallShield Self-Registration (ISSelfReg)

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

If you have selected ISSelfReg as the self-registration method for COM servers, and if your project contains any files (or
dynamic links) marked as self-registered, InstallShield adds information about those files to the ISSelfReg table of your
.msi database. You can view and edit the ISSelfReg table in the Direct Editor. To learn about the fields in this table, see
ISSelfReg Table.

In addition, if your project contains any files (or dynamic links) marked as self-registered, InstallShield adds the following
custom actions to the Execute sequence of your installation.

Table 4-17 • Custom Actions Added to Projects that Have Self-Registering COM Servers

Action Description

ISSelfRegisterCosting Immediate-execution action that reads the ISSelfReg table and determines which
files need to be registered or unregistered. A file will be registered when its
component is scheduled to be installed, and unregistered when its component is
scheduled to be uninstalled.

ISUnSelfRegisterFiles Deferred-execution custom action that unregisters each file whose component is
scheduled to be removed.

ISSelfRegisterFiles Deferred-execution custom action that registers each file whose component is
scheduled to be installed.

ISSelfRegisterFinalize Displays error information for files that failed to self-register.

See Also
Direct Editor

Registry-Free COM Registration

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 721

Chapter 4
Organizing Files for Your Installation

• DIM
• InstallScript MSI
• Merge Module

With Reg-Free COM, COM data is written to an application manifest file that is stored in the application folder. The manifest
file is an XML file that contains information about an application and the libraries that are associated with it. Note that the
Reg-Free COM manifest file, the executable file, and the COM libraries should all be installed to the same folder on the
target machine.

Benefits of Reg-Free COM

Reg-Free COM has several advantages over traditional COM. For example, with Reg-Free COM, the component is defined
within the scope of the application itself. Even if other applications that use the same COM component or a different
version of it require that it be registered, it will not interfere with this application.

Problems may occur with traditional COM registration if multiple versions of shared libraries exist on a target system. For
example, an installation may overwrite a new version of a shared library with an older version, or a new version might not
be backwardly compatible with older versions. This may cause applications that require features of a specific version to
crash. These types of situations are commonly known as DLL Hell. With Reg-Free COM, you can avoid these problems
because other applications cannot access your application’s COM component.

In addition, Reg-Free COM streamlines the upgrade and uninstallation processes. For an upgrade, simply replace the
application folder. For an uninstallation, simply remove that folder.

Limitations of Reg-Free COM

Reg-Free COM is not appropriate for some solutions. Several limitations exist:

• Reg-Free COM works on only Windows XP or later.

• A component is not suitable for Reg-Free COM if it is a system component or part of the operating system. In addition,
it is not suitable if it is a data access component such as Microsoft Data Access Components (MDAC). These types of
components should not be isolated.

• A COM component can be isolated only once per application. Consider grouping COM components in a single class
library as a workaround to this limitation.

See Also
Reg-Free COM Wizard

Creating and Modifying Reg-Free COM Files for Your Installation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

722 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Use the Reg-Free COM Wizard to create and modify Reg-Free COM manifest files to be included in your installation. Before
you use the Reg-Free COM Wizard, you should add the COM libraries (.dll and .ocx files) and the executable file that uses
them to your InstallShield project.

The wizard extracts COM information from the libraries that you specify and adds them to the application manifest files. It
also creates a new component with the manifest file set as the key file. The manifest component has the same destination
and condition as the associated executable-file component.

Sample Manifest File for a Reg-Free COM File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

The contents of the manifest file include the name of the executable file, the file names of the libraries that are associated
with the executable files, and the COM information. For the following sample manifest file, the name of the executable file
is Sample.exe, and the name of the library is SampleCircle.dll.

<?xml version="1.0" encoding="utf-8"?>

<assembly xsi:schemaLocation="urn:schemas-microsoft-com:asm.v1 assembly.adaptive.xsd"
manifestVersion="1.0" xmlns:asmv1="urn:schemas-microsoft-com:asm.v1" xmlns:asmv2="urn:schemas-
microsoft-com:asm.v2" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#" xmlns="urn:schemas-microsoft-
com:asm.v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<assemblyIdentity type="win32" name="Sample.exe" version="1.0.0.10"/>
<file asmv2:size="24576" name="SampleCircle.dll">
<hash xmlns="urn:schemas-microsoft-com:asm.v2"> ... </hash>
<typelib flags="HASDISKIMAGE" helpdir="" resourceid="0" tlbid="{6A2304BC-F200-49B8-955E-
0ACDE272B6E0}" version="1.0"/>
<comClass clsid="{C621F4D3-8463-4B0C-9BEC-84D979C41385}" description="SampleCircle.Server"
progid="SampleCircle.Server" threadingModel="Apartment" tlbid="{6A2304BC-F200-49B8-955E-0ACDE272B6E0}"/
>
</file>
</assembly>

On a Windows XP system, the presence of the manifest file enables the application to use methods from the COM library
without the libraries having been registered in the target system’s registry. Windows XP uses the COM libraries in the
current directory before using any other versions of the libraries that may be registered on the target system.

Including DIMs in a Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

InstallShield 2020 User Guide ISP-2600-UG00 723

Chapter 4
Organizing Files for Your Installation

A developer installation manifest (DIM) is a feature-sized collection of related items such as product files, shortcuts,
registry entries, text file changes, IIS Web sites, and other elements that together make up a discrete portion of a product
installation. DIM projects enables release engineers to efficiently reuse functional portions of an installation.

Working with DIMs also enables multiple developers to contribute to the development of the installation simultaneously.
Each software developer can work on a separate DIM that the release engineer can reference in one or more installation
projects.

This section of the documentation explains how to include a DIM project in a Basic MSI installation project. It also offers
guidance on how to work with a Basic MSI project that includes one or more DIMs.

Tip • To learn how to create a DIM project, see Modularizing Installation Projects to Distribute Development Work and Enable
Reuse.

Determining the Appropriate Method for Incorporating DIMs in Installation

Projects
InstallShield 2020

Project • This information applies to Basic MSI projects.

A developer installation manifest (DIM) is a feature-sized collection of related items such as product files, shortcuts,
registry entries, text file changes, IIS Web sites, and other elements that together make up a discrete portion of a product
installation. Once you have created a DIM, you can add it to a Basic MSI project in one of two ways:

• By reference—You can add a reference for a DIM project to your Basic MSI project. With this method, the DIM elements
are merged into the Basic MSI project at build time. Each time that you build the Basic MSI installation, InstallShield
references the latest version of the DIM project and includes it in the installation that it generates.

Using DIM references in Basic MSI projects enables multiple software developers to contribute to the development of
the installation simultaneously. Each software developer can work on a separate DIM that the release engineer can
reference in one or more installation projects.

If you want to modify any portion of a DIM project, open the DIM project in InstallShield, make the required changes,
and then rebuild any Basic MSI projects that reference that DIM.

This method is the more commonly performed method.

To learn more, see Referencing a DIM in a Project.

• By import—You can import a DIM project into your Basic MSI project. This method is a one-time, irreversible import
that merges the DIM data into the Basic MSI project at design time.

Any further changes that need to be made to the DIM data are made from within the Basic MSI project. Modifying the
original DIM project does not modify the corresponding data in the Basic MSI project.

You may want to import a DIM project to troubleshoot problems with a product or its installation. When you are
importing a DIM project, you have the option to back up your Basic MSI project (.ism) before the import; this option
enables you to revert back to the base Basic MSI project without the imported DIM project.

To learn more, see Importing a DIM into a Project.

724 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

DIM projects enables developers and release engineers to reuse functional portions of an installation efficiently.

See Also
Modularizing Installation Projects to Distribute Development Work and Enable Reuse

Referencing a DIM in a Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

When you add a reference for a DIM project to your Basic MSI project, the DIM elements are merged into the Basic MSI
project at build time. Each time that you build the Basic MSI installation, InstallShield references the latest version of the
DIM project and includes it in the installation that it generates.

Task To add a reference for a DIM to a specific feature in a Basic MSI project:

1. In the View List under Organization, click Setup Design.

2. In the Setup Design explorer, right-click the feature that you want to contain the DIM reference, and then click Add
DIM Reference. The Open dialog box opens.

3. Browse to the DIM project file (.dim) that you want to reference, and then select that file.

4. Click the Open button.

InstallShield adds to the appropriate feature a component node for each component in the DIM project.

Tip • You can also use the DIM References view to add a reference for a DIM to your Basic MSI project. In this view, right-click
the DIMs explorer and then click Add DIM Reference. When you add a reference through this method, the DIM is not associated
with any features in the Basic MSI project. To learn how to set up the association, see Associating a DIM Reference with a
Feature. Each referenced DIM must be associated with a feature in the Basic MSI project; otherwise, InstallShield does not
include it in the Basic MSI installation that it generates at build time.

See Also
Importing a DIM into a Project

Associating a DIM Reference with a Feature

InstallShield 2020

Project • This information applies to Basic MSI projects.

When you are including a DIM reference in a Basic MSI project, the DIM reference must be associated with at least one
feature; otherwise, InstallShield does not include it in the Basic MSI installation that it generates at build time.

InstallShield 2020 User Guide ISP-2600-UG00 725

Chapter 4
Organizing Files for Your Installation

You can associate a DIM reference with one or more features through the DIM References view or the Setup Design view of
the Basic MSI project.

Task To use the DIM References view of a Basic MSI project to associate a DIM reference with a feature:

1. In the View List under Organization, click DIM References.

2. In the DIMs explorer, select the DIM that you want to configure.

3. Click the Features tab.

4. Select the check box of each feature that you want to contain the selected DIM. Clear the check box of each feature
that should not contain the selected DIM.

Task To use the Setup Design view of a Basic MSI project to associate a DIM reference with a feature:

1. In the View List under Organization, click Setup Design.

2. In the Setup Design explorer, right-click the feature that you want to contain the DIM reference, and then click
Associate DIM References. The Associate DIM References dialog box opens; it lists all of the DIM references that are
not associated with a feature in the Basic MSI project.

3. Select each DIM that you want to associate with the selected feature, and then click OK.

See Also
Referencing a DIM in a Project

Resolving Build-Time Conflicts Between a Basic MSI Project and a DIM Reference
InstallShield 2020

Project • This information applies to Basic MSI projects.

When you build a Basic MSI release that contains a DIM reference, InstallShield merges the DIM data into the Basic MSI
release that it generates. If data conflicts exist, InstallShield needs to determine which data takes precedence: the values in
the DIM project or those in the Basic MSI project.

InstallShield lets you specify how you want to resolve conflicts between settings in a DIM project with those in a Basic MSI
project that contains a reference to that DIM. Following are examples of different types of conflicts that may occur:

• Both projects contain a property that has the same name but different values.

• Both projects contain a string entry that has the same string identifier but different values for a particular language.

• Both projects contain a path variable that contains the same name but different values.

• Both projects contain a component that has the same name but different values for one or more of its settings.

In most cases, conflicts do not occur, since InstallShield automatically includes a DIM project–specific GUID in the names of
items such as properties, string entries, path variables, and components when you create these in a DIM project, but not in
a Basic MSI project. If you create a property called MYPROPERTY in a Basic MSI project, the property is called MYPROPERTY. If
you create a property called MYPROPERTY in a DIM project, InstallShield internally calls the property MYPROPERTY.DIM_GUID,

726 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

where DIM_GUID is the identifier that is defined in the DIM GUID setting of the General Information view of the DIM project.
Thus, the name of the property in the DIM becomes, for example,
MYPROPERTY.8356F8B7_8DE5_4E04_A77A_6FA722CBE1CC. For this particular example, you can use the Direct Editor to
see the internal name of the property in the Property table of the DIM project.

Task To indicate how you want InstallShield to resolve conflicts between a Basic MSI project and one of its DIM references:

1. In the View List under Organization, click DIM References.

2. In the DIMs explorer, select the DIM that you want to configure.

3. Click the Build Options tab.

4. For the Conflict Resolution setting, select the appropriate value. Available options are:

• Use Base Project Value—If InstallShield encounters a conflict when merging the DIM data into the Basic MSI
installation at build time, InstallShield uses the value that is in the Basic MSI project instead of the value that is in
the DIM project.

• Use DIM Project Value—If InstallShield encounters a conflict when merging the DIM data into the Basic MSI
installation at build time, InstallShield uses the value that is in the DIM project instead of the value that is in the
Basic MSI project.

One possible but unlikely scenario for encountering conflicts is if you import a DIM into a Basic MSI project, modify an item
in the DIM project, and then try to add a reference to the same DIM in the Basic MSI project. In this scenario, InstallShield
overrides the value of the DIM setting or the value of the Basic MSI setting, depending on how you have the Conflict
Resolution setting configured, to avoid a conflict.

See Also
Referencing a DIM in a Project
Identifying DIM Elements in an Installation Project

Viewing Build Instructions for a DIM Reference

InstallShield 2020

Project • This information applies to Basic MSI projects.

If you add a DIM reference to a Basic MSI project, it is recommended that you check to see whether the author of the DIM
included any build instructions that indicate guidance, tips, or other comments that may help you determine whether
additional steps may be required for the specific DIM.

Task To view build instructions for a DIM reference in a Basic MSI project:

1. Open the Basic MSI project that contains the DIM reference.

2. In the View List under Organization, click DIM References.

3. In the DIMs explorer, select the DIM that you want to configure.

4. Click the Instructions tab.

InstallShield 2020 User Guide ISP-2600-UG00 727

Chapter 4
Organizing Files for Your Installation

On the Instructions tab, InstallShield displays any comments that the author of the DIM project entered when creating or
editing it.

Overriding the Destination for a DIM Reference

InstallShield 2020

Project • This information applies to Basic MSI projects.

If you create a DIM project, you have the ability to specify the default location on target systems for the files in the DIM
project. The location is typically the value of the property INSTALLDIR or a subfolder of that folder. When you add a DIM
reference to a Basic MSI project, you can choose to use the destination location that the author of the DIM project
configured, or you can override the location and specify a different location.

Task To view the default destination that is specified for a DIM reference’s files and override it if appropriate in a Basic MSI
project:

1. Open the Basic MSI project that contains the DIM reference.

2. In the View List under Organization, click DIM References.

3. In the DIMs explorer, select the DIM that you want to configure.

4. Click the Build Options tab. The Destination setting shows the value that author of the DIM project configured.

5. To override the default value, specify the appropriate value.

Instead of hard-coding a path, you can enter a directory property as part of the path. To select a directory property,
click the ellipsis button (...) in this setting. This enables you to select the appropriate directory from a list, or to create
a new directory within a predefined directory. Separate further levels of subdirectories with a backslash—for example,
[ProgramFilesFolder]MyApp\Bin.

Note that it is also possible to override destinations at the feature and component levels. For more information, see Setting
the Default Product Destination Folder (INSTALLDIR).

See Also
Viewing Build Instructions for a DIM Reference

Scheduling Custom Actions and Dialogs from a DIM Reference

InstallShield 2020

Project • This information applies to Basic MSI projects.

If you create a DIM project, you have the ability to create custom actions and dialogs. When you add a DIM reference to a
Basic MSI project, you can schedule when you want the custom actions in that DIM to be run during the Basic MSI
installation. You can also specify when during the Basic MSI installation the dialogs in that DIM should be run.

728 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

Task To insert custom actions and dialogs from a DIM reference into a Basic MSI project:

1. Open the Basic MSI project that contains the DIM reference.

2. In the View List under Organization, click DIM References.

3. In the DIMs explorer, select the DIM that you want to configure.

4. Click the Sequences tab.

5. In the Sequences explorer, right-click the action or dialog that you want your action to follow and click Insert. The
Insert Action dialog box opens, providing a list of all the actions and dialogs that can be added to the sequence.

6. In the list at the top of the dialog box, select the type of action that you want to insert.

7. In the box that shows a list of actions, select the action that you want to insert.

8. Click OK.

See Also
Viewing Build Instructions for a DIM Reference

Opening a Referenced DIM Project from Within an Installation Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

If you are modifying a Basic MSI project that contains one or more DIM references and you want to edit the DIM project or
see detailed information about it, you can open that project with the click of a link. Note that you must be able to access
the DIM project from the machine on which you are modifying the Basic MSI project.

Task To open a referenced DIM project from within a Basic MSI project:

1. In the View List under Organization, click DIM References.

2. In the DIMs explorer, select the DIM that you want to open.

3. On the General tab, click the Launch DIM Project link.

A new instance of InstallShield launches, and the DIM project opens within InstallShield.

See Also
Viewing Build Instructions for a DIM Reference

InstallShield 2020 User Guide ISP-2600-UG00 729

Chapter 4
Organizing Files for Your Installation

Importing a DIM into a Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

When you import a DIM project into a Basic MSI project, InstallShield merges the DIM data into the Basic MSI project. The
import is a one-time, irreversible action.

You may want to import a DIM project to troubleshoot problems with a product or its installation. When you are importing
a DIM project, you have the option to back up your Basic MSI project (.ism) before the import; this option enables you to
revert back to the base Basic MSI project without the imported DIM project.

Task To import a DIM into a specific feature in a Basic MSI project:

1. In the View List under Organization, click Setup Design.

2. In the Setup Design explorer, right-click the feature that you want to contain the DIM, and then click Import DIM
Wizard. The Import DIM Wizard dialog box opens.

3. Complete each panel of the wizard.

See Also
Import DIM Wizard

Resolving Design-Time Conflicts While Importing a DIM Into a Basic MSI Project
InstallShield 2020

Project • This information applies to Basic MSI projects.

When you import a DIM project into an installation project, InstallShield merges the DIM data into the installation project. If
data conflicts exist, InstallShield needs to determine which data takes precedence: the values in the DIM project or those in
the Basic MSI project.

InstallShield lets you specify how you want to resolve conflicts between settings in the two projects when you are
importing. Following are examples of different types of conflicts that may occur:

• Both projects contain a property that has the same name but different values.

• Both projects contain a string entry that has the same string identifier but different values for a particular language.

• Both projects contain a path variable that contains the same name but different values.

• Both projects contain a component that has the same name but different values for one or more of its settings.

If InstallShield encounters a conflict when importing a DIM project, the Resolve Conflict dialog box opens. This dialog box is
where you specify how you want to proceed. To learn more, see Resolve Conflict Dialog Box.

In most cases, conflicts do not occur, since InstallShield automatically includes a DIM project–specific GUID in the names of
items such as properties, string entries, path variables, and components when you create these in a DIM project, but not in
a Basic MSI project. If you create a property called MYPROPERTY in a Basic MSI project, the property is called MYPROPERTY. If

730 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Organizing Files for Your Installation

you create a property called MYPROPERTY in a DIM project, InstallShield internally calls the property MYPROPERTY.DIM_GUID,
where DIM_GUID is the identifier that is defined in the DIM GUID setting of the General Information view of the DIM project.
Thus, the name of the property in the DIM becomes, for example,
MYPROPERTY.8356F8B7_8DE5_4E04_A77A_6FA722CBE1CC. For this particular example, you can use the Direct Editor to
see the internal name of the property in the Property table of the DIM project.

See Also
Importing a DIM into a Project
Import DIM Wizard

Identifying DIM Elements in an Installation Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

When you create a DIM project in InstallShield, InstallShield assigns the project a GUID. This GUID helps to differentiate
separate DIM projects. InstallShield also includes this GUID throughout various areas of the DIM project and any Basic MSI
project that contains the DIM to identify the data as originating in the DIM.

For example, if you include a file called MyFile.exe in a DIM project that has a GUID of
8356F8B7_8DE5_4E04_A77A_6FA722CBE1CC, InstallShield writes the following value for this file in the File table of the
DIM project:

MyFile.exe.8356F8B7_8DE5_4E04_A77A_6FA722CBE1CC

If you include that same MyFile.exe source file in a different DIM project, InstallShield would append a different GUID to
the end of the file’s File table entry. If you import the DIM project into a Basic MSI project, InstallShield also imports this
file-GUID entry into the File table of a Basic MSI project. If you add MyFile.exe directly to a Basic MSI project, InstallShield
does not append a GUID to the end of the file name. If you import the DIM that contains MyFile.exe into a Basic MSI project,
you will see the

InstallShield uses the DIM GUID for files, components, path variables, and other types of installation data. This helps to
make it easy to identify which parts of a Basic MSI project are included directly in the Basic MSI project, and which originate
from various DIM projects that are referenced in or imported into the Basic MSI project.

The use of GUIDs also helps prevent conflicts. For example, if you use different values for a specific path variable in multiple
DIM projects, import those DIMs into a Basic MSI project that uses another different value for the path variable, you will not
encounter any conflicts. InstallShield uses the appropriate values for each path variable instance when building your Basic
MSI installation.

See Also
Resolving Build-Time Conflicts Between a Basic MSI Project and a DIM Reference
Resolving Design-Time Conflicts While Importing a DIM Into a Basic MSI Project

InstallShield 2020 User Guide ISP-2600-UG00 731

Chapter 4
Organizing Files for Your Installation

Overriding Path Variables in a DIM Project for Use in an Installation Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

Depending on how the author of a DIM project defined the project’s path variables, it may be necessary for you to override
their values when you build a Basic MSI release that includes that DIM. Otherwise, when you build the installation, you may
encounter errors because of missing files, or the wrong files may be included in your build.

InstallShield offers several ways for overriding the path variables in a DIM project:

• If you are building a Basic MSI release and you want to override a path variable for a DIM that was imported into the
Basic MSI project, you can use the Path Variable Overrides setting on the Build tab in the Releases view.

• If you are building from the command line with ISCmdBld.exe, use the -l parameter to specify a path variable name
and new value. Use this method if you are building an installation for a Basic MSI project that contains one or more
DIMs.

• If you are building through MSBuild or Team Foundation Server (TFS), use the PathVariables parameter on the
InstallShield task. This parameter is exposed as the ItemGroup InstallShieldPathVariableOverrides when the default
targets file is used.

• You can open the DIM project and update values of path variables as needed. To learn how to open the DIM project
from within an open Basic MSI project, see Opening a Referenced DIM Project from Within an Installation Project.

At build time, InstallShield (or the Standalone Build) uses the path variable overrides that you set when obtaining the
source files for your project and building the release.

For more information as well as tips on using path variables in DIM projects, see Using Path Variables in a DIM.

See Also
Using Path Variables

732 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Configuring the Target System

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

In addition, certain portions do not apply to certain types of project, as noted.

Every installation changes the target system in some way. The simplest installations might only copy files. More in-depth
installations make registry changes, edit .ini files, create shortcuts, configure ODBC resources, use environment variables,
modify XML files, modify text files, schedule tasks, and install and control Windows services. For more information on how
to configure the target system, refer to this section of the documentation.

See Also
Shortcuts View
Registry View
INI File Changes View
ODBC Resources View
Environment Variables View
XML File Changes View
Text File Changes View
Scheduled Tasks View
Services View

Creating Shortcuts and Program Folders

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database

InstallShield 2020 User Guide ISP-2600-UG00 733

Chapter 4
Configuring the Target System

• MSM Database
• Transform

You can create shortcuts and program folders on the Windows desktop and on the Start menu by using the Shortcuts
explorer in the Shortcuts view. Like files, shortcuts are associated with components. In installation projects, they are
created on the target system only if the feature to which the component belongs is selected for installation.

See Also
Shortcuts View

Types of Shortcuts
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield offers several types of shortcuts:

Table 4-1 • Types of Shortcuts

Shortcut Type Project Type Description

New Shortcut Basic MSI, DIM, Creates a new shortcut to a file that exists in your project.
InstallScript,
InstallScript MSI,
Merge Module, MSI Note • This option is disabled when there is no file specified for a
Database, MSM component.
Database,
Transform

New Advertised Shortcut Basic MSI, DIM, Creates an advertised shortcut. The component’s files are not
InstallScript MSI, installed to the target system until the end user launches the
Merge Module, MSI shortcut.
Database, MSM
Database,
Transform

734 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Table 4-1 • Types of Shortcuts (cont.)

Shortcut Type Project Type Description

New Internet Shortcut InstallScript Creates an Internet shortcut (one whose Internet Shortcut setting is
set to Yes) with a default value of http://
www.YourCompanyName.com for the Target setting; change this
value to the desired URL.

New Shortcut to Basic MSI, DIM, Creates a shortcut to a file that already exists on the target system.
Preexisting File InstallScript,
InstallScript MSI,
Merge Module, MSI
Database, MSM
Database,
Transform

New Folder Basic MSI, DIM, Creates a program folder. You can create a program folder if you
InstallScript, want your shortcut to appear under your company name, for
InstallScript MSI, example.
Merge Module, MSI
Database, MSM
Database,
Transform

Creating Shortcuts
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

Before you create a shortcut, you should create at least one feature and component. If you have not created a component
when you create your first shortcut, InstallShield creates a component for you. You can change the component to which
the shortcut belongs by configuring the shortcut’s Component setting.

InstallShield 2020 User Guide ISP-2600-UG00 735

Chapter 4
Configuring the Target System

Task To create a shortcut:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, right-click one of the destination directories and then click the appropriate command. For a
list of available commands, see Types of Shortcuts.

InstallShield adds a new shortcut with the default name NewShortcutN (where N is a successive number).

3. Enter a new name, or right-click it later and click Rename to give it a new name.

4. Configure the shortcut’s settings.

For details about each of the settings that you can configure for shortcuts and folders, see:

• Shortcut Settings

• Folder Settings

Note • You can create a program folder if you want your shortcut to appear under your company name, for example. When
you have created a folder for your shortcut, you can create the shortcut by right-clicking your new folder and then clicking New
Shortcut.

You cannot create shortcuts to a dynamically linked file. For more information, see Limitations of Dynamic File Linking.

Tip • You can also use the Components view or—in installation projects only—the Setup Design view to create a shortcut. If
you use either the Components view or the Setup Design view, click the Shortcuts item in the explorer; a separate Shortcuts
explorer opens in a new pane.

See Also
Shortcuts View
Specifying the Icon for a Shortcut
Creating Shortcuts and Program Folders

Configuring Shortcut Settings

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database

736 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• MSM Database
• Transform

When you have created a shortcut, you need to configure its settings. Shortcut settings enable you to link your shortcut to
a file, provide a description of the shortcut, or pass arguments.

Task To configure the settings for a shortcut:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, click the shortcut. The shortcut’s settings are displayed in the right pane.

3. Configure the settings as needed.

For details about each of the settings that you can configure for shortcuts and folders, see:

• Shortcut Settings

• Folder Settings

Specifying the Icon for a Shortcut

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield enables you to specify the icon that should be used for a shortcut that is created on the target system at run
time.

Task To specify the icon for a shortcut:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, click the shortcut whose icon you want to specify. The shortcut’s settings are displayed in
the right pane.

3. In the Icon File setting, specify the file that contains the icon for the shortcut that you are creating. You must specify
an .ico file or the executable file (.dll or .exe) that contains the icon resource.

InstallShield 2020 User Guide ISP-2600-UG00 737

Chapter 4
Configuring the Target System

For Basic MSI, InstallScript MSI, or Merge Module projects: You can either type the fully qualified path to the file
that contains the icon, or click the ellipsis (...) button to browse to it.

For InstallScript projects: Type the fully qualified path to the file on the target system that contains the icon.

4. If the icon file that you specify contains more than one icon resource, enter the index in the Icon Index setting.

A nonnegative integer refers to the order of the icon resources in the executable file. For example, 0 refers to the first
icon in the file, 1 refers to the second icon, and 2 refers to the third icon.

InstallShield changes the icon that is displayed for the shortcut in the Shortcuts explorer to the one that you specified,
unless either of the following conditions is true:

• The project type is InstallScript.

• The shortcut is for a pre-existing file on the target system.

For both of the aforementioned conditions, the icon file is not known until run time. Therefore, InstallShield shows the
following icon for each shortcut in the Shortcuts explorer, instead of displaying the icon that is used at run time on target
systems.

InstallShield also uses this icon for a shortcut in the Shortcuts explorer if the file that is selected in the Icon File setting does
not contain an icon.

Project • For Basic MSI, InstallScript MSI, and Merge Module projects: Since Windows Installer requires a separate icon when
the component is advertised, InstallShield extracts the icon from any executable file that you specify.

Tip • For Basic MSI, InstallScript MSI, and merge module projects: You can also right-click the icon in the Shortcuts view and
then click Change Shortcut icon to specify a different shortcut icon. InstallShield updates the value in the Icon settings with the
values that you specify using this method.

See Also
Shortcuts View

Creating Internet Shortcuts

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

738 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• MSI Database
• MSM Database
• Transform

An Internet shortcut is a text file with the .url extension.

Task To create an Internet shortcut that opens your Web site:

1. Create a text file called MySite.url with the following contents:

[InternetShortcut]

URL=http://www.MySite.com

2. Add this file to a component.

Otherwise, if you simply right-click and click Add, you will add what the shortcut points to and not the shortcut itself.

When the end user launches the shortcut, the specified Web site (www.MySite.com) opens in the default browser.

Creating Shortcuts to Folders

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield lets you create a shortcut to a folder. The method that you use to create a shortcut to a folder depends on the
project type that you are using.

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and
Transform Projects
The Target setting of a shortcut can contain a directory identifier inside square brackets. For example, to create a shortcut
to INSTALLDIR, create a shortcut with the following settings:

• Display Name: Shortcut to INSTALLDIR

• Advertised: No

• Target: [INSTALLDIR]

InstallShield 2020 User Guide ISP-2600-UG00 739

Chapter 4
Configuring the Target System

InstallScript and InstallScript Object Projects

The AddFolderIcon function creates a shortcut to a folder if you pass the path to the folder in the third (szCommandLine)
parameter.

For example, this code creates a shortcut to the Common Files folder in the end user’s Program Files folder:

ProgDefGroupType(COMMON)

szFolder = TARGETDIR;
LongPathToQuote(szFolder, TRUE);

AddFolderIcon(
ProgramMenuFolder, // where shortcut will appear
"Shortcut to TARGETDIR", // shortcut display name
szFolder, // what shortcut launches
""// working directory
TARGETDIR ^ "Sample.exe", 0, // icon file, index
"", // shortcut key
NULL); // special settings

InstallScript MSI Project

Use the same basic procedure as in the preceding InstallScript section, changing all occurrences of TARGETDIR to
INSTALLDIR in the example code.

Specifying a Keyboard Shortcut for Accessing a Shortcut

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

Keyboard shortcuts—also sometimes called hot keys—enable you to perform tasks quickly by pressing a combination of
keys, such as CTRL+ALT+A, instead of using the mouse. You can assign a keyboard shortcut to your product’s shortcut so
that end users can press the appropriate hot keys to launch the shortcut.

Caution • It is recommended that you avoid configuring keyboard shortcuts for your shortcuts because they may conflict with
existing keyboard shortcuts on the target system.

740 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Task To assign a keyboard shortcut to a shortcut in your project:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, select the shortcut for which you are specifying a hot key.

3. In the Hot Key setting, click the ellipsis button (...). The Hot Key dialog box opens.

4. Press the keyboard shortcut that you want to use for this shortcut.

5. Click OK.

In the Hot Key setting, InstallShield displays the appropriate decimal value that represents the combination of keys that
you pressed.

For example, if your key combination is CTRL+ALT+A, InstallShield displays 1601 in this setting. This number is obtained by
combining the hex value of CTRL (200) and the hex value of ALT (400) with the logical Or operator. Then, that number (600)
is added to the hex value for the A key (41) and converted to a decimal value. In this example, the number that is converted
to decimal is 641. After the conversion, it is 1601.

Renaming Shortcuts
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

When you create a shortcut, your shortcut appears with a default internal name. This name is not displayed to end users,
but you can change it to something that is relevant to your project.

Task To rename a shortcut:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, right-click the shortcut that you want to rename and click Rename.

3. Type the new name.

See Also
Shortcuts View

InstallShield 2020 User Guide ISP-2600-UG00 741

Chapter 4
Configuring the Target System

Setting Shell Properties for a Shortcut

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield lets you specify one or more shortcut properties that you want the Windows Shell to set at installation run
time. For example, InstallShield has built-in support for enabling you to set Shell properties that control the following
behavior:

• Suppressing Initial Pinning of a Shortcut to the Windows 8 Start Screen

• Specifying Whether End Users Should Be Able to Pin a Shortcut to the Taskbar or Start Menu

• Preventing a Shortcut on the Start Menu from Being Highlighted as Newly Installed

InstallShield also lets you set additional properties that the Windows Shell supports. To learn more, see Setting Custom
Shell Properties.

See Also
Shortcuts View

Suppressing Initial Pinning of a Shortcut to the Windows 8 Start Screen

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Project-specific differences are noted where applicable.

742 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

InstallShield lets you specify whether you want to suppress the initial pinning of a shortcut to the Start screen on Windows
8 target systems.

Note • Windows 8.1 disabled automatic pinning of freshly installed applications/shortcuts.

If you specify that you want shortcut pinning to be suppressed, the installation sets a Windows Shell property that was
introduced in Windows 8. You may want to disable pinning for shortcuts that are for tools and secondary products that are
part of your installation.

Earlier versions of Windows ignore this shortcut property.

Task To specify whether pinning a shortcut to the Windows 8 Start screen should be suppressed by default:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, select the shortcut that you want to configure. The shortcut’s settings are displayed in the
right pane.

3. In the Shell Properties setting, click the Add New Shell Shortcut Property button, and then click Suppress Initial
Pin to Windows 8 Start Screen. InstallShield adds a new Key Name setting, plus additional rows of related settings
under it, and configures them as needed.

Windows Installer 5 introduced support for shortcut properties. Earlier versions of Windows Installer ignore these setting.

Note that Windows 8 maintains information about shortcut pinning to the Start screen after a shortcut is removed by
uninstalling the application. Therefore, this setting has no effect on the target system if the shortcut has already been
installed on it. Thus, when you are testing this functionality, ensure that you test on a clean machine—one on which this
shortcut and its target have never been installed.

For Windows Installer–based projects (Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database,
Transform), some end users have reported run-time warnings or errors with a message such as the following one when
Windows Installer is installing a shortcut that configures Shell properties:

Property [1] for shortcut ’[2].lnk’ could not be set.

In the aforementioned message, [1] is the name of the Shell property that Windows Installer is attempting to set, and
[2].lnk is the name of the shortcut file. In such cases, it appears that the .lnk file could be locked by a different process.

InstallScript Language Support

The following InstallScript functions enable you to prevent the pinning of a shortcut to the Start screen:

• CreateShortcut

• SetShortcutProperty

See Also
Shortcuts View
Setting Shell Properties for a Shortcut

InstallShield 2020 User Guide ISP-2600-UG00 743

Chapter 4
Configuring the Target System

Specifying Whether End Users Should Be Able to Pin a Shortcut to the Taskbar or Start Menu
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Project-specific differences are noted where applicable.

InstallShield lets you specify whether you want the context menu commands for pinning a shortcut to the taskbar and to
the Start menu are to be displayed after end users install your product. You may want to disable pinning for shortcuts that
are for tools and secondary products that are part of your installation. Note that if you configure the shortcut to prevent
this pinning, the target of the shortcut is ineligible for inclusion in the most frequently used list on the Start menu.

If you configure a shortcut to prevent this pinning functionality, the installation sets a Windows Shell property. By default,
the property is not set for new shortcuts, so end users are able to pin the shortcut to the taskbar and to the Start menu.

Note that shortcuts that contain certain strings cannot be pinned to the taskbar or the Start menu, and they cannot be
displayed in the most frequently used list. Examples are:

• Documentation

• Help

• Install

• Remove

• Setup

• Support

Note that the method for hiding the context menu commands varies, depending on the project type that you are using.

Instructions for Windows Installer–Based Projects

For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects, use the Shell
Properties setting to hide the context menu commands.

Task To hide the context menu commands for pinning a shortcut to the taskbar or Start menu:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, select the shortcut that you want to configure. The shortcut’s settings are displayed in the
right pane.

744 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

3. In the Shell Properties setting, click the Add New Shell Shortcut Property button, and then click Prevent Pinning.
InstallShield adds a new Key Name setting, plus additional rows of related settings under it, and configures them as
needed.

To allow the context menu commands to be displayed, find the Key Name setting that has a Property subsetting with either
of the following, and click the Delete this shortcut shell property button in the Key Name setting:

• System.AppUserModel.PreventPinning

• {9F4C2855-9F79-4B39-A8D0-E1D42DE1D5F3}, 9

Windows Installer 5 introduced support for this shortcut property. Earlier versions of Windows Installer ignore this setting.

Note that for Windows Installer–based installations, some end users have reported run-time warnings or errors with a
message such as the following one when Windows Installer is installing a shortcut that configures Shell properties:

Property [1] for shortcut ’[2].lnk’ could not be set.

In the aforementioned message, [1] is the name of the Shell property that Windows Installer is attempting to set, and
[2].lnk is the name of the shortcut file. In such cases, it appears that the .lnk file could be locked by a different process.

Instructions for InstallScript Projects

For InstallScript projects, use the Prevent Pinning setting.

Task To hide the context menu commands for pinning a shortcut to the taskbar or Start menu:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, select the shortcut that you want to configure. The shortcut’s settings are displayed in the
right pane.

3. In the Prevent Pinning setting, select Yes.

Windows 7 introduced support for this setting. Earlier versions of Windows ignore this setting.

InstallScript Language Support

The following InstallScript functions enable you to hide the context menu commands for pinning a shortcut to the taskbar
or the Start menu:

• CreateShortcut

• SetShortcutProperty

See Also
Shortcuts View
Setting Shell Properties for a Shortcut

Preventing a Shortcut on the Start Menu from Being Highlighted as Newly Installed
InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 745

Chapter 4
Configuring the Target System

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Project-specific differences are noted where applicable.

InstallShield lets you optionally prevent a shortcut on the Start menu from being highlighted as newly installed after end
users install your product. This has the same effect as clearing the Highlight newly installed programs check box in the
Customize Start Menu dialog box for an individual item on a target system. You may want to set this property for shortcuts
that are for tools and secondary products that are part of your installation.

If you specify that you want to prevent the highlight functionality for a shortcut, the installation sets a Windows Shell
property. By default, the property is not set for new shortcuts.

Note that the method for preventing the highlight behavior varies, depending on the project type that you are using.

Instructions for Windows Installer–Based Projects

For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects, use the Shell
Properties setting to prevent the highlight behavior.

Task To prevent the Start menu entry for a shortcut from being highlighted as newly installed:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, select the shortcut that you want to configure. The shortcut’s settings are displayed in the
right pane.

3. In the Shell Properties setting, click the Add New Shell Shortcut Property button, and then click Do Not Highlight
as New. InstallShield adds a new Key Name setting, plus additional rows of related settings under it, and configures
them as needed.

To enable the Start menu entry to be highlighted, find the Key Name setting that has a Property subsetting with either of
the following, and click the Delete this shortcut shell property button in the Key Name setting:

• System.AppUserModel.ExcludeFromShowInNewInstall

• {9F4C2855-9F79-4B39-A8D0-E1D42DE1D5F3}, 8

Windows Installer 5 introduced support for this shortcut property. Earlier versions of Windows Installer ignore this
property.

Note that for Windows Installer–based installations, some end users have reported run-time warnings or errors with a
message such as the following one when Windows Installer is installing a shortcut that configures Shell properties:

Property [1] for shortcut ’[2].lnk’ could not be set.

In the aforementioned message, [1] is the name of the Shell property that Windows Installer is attempting to set, and
[2].lnk is the name of the shortcut file. In such cases, it appears that the .lnk file could be locked by a different process.

746 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Instructions for InstallScript Projects

For InstallScript projects, use the Do Not Highlight as New setting.

Task To prevent the Start menu entry for a shortcut from being highlighted as newly installed:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, select the shortcut that you want to configure. The shortcut’s settings are displayed in the
right pane.

3. In the Do Not Highlight as New setting, select Yes.

Windows 7 introduced support for this setting. Earlier versions of Windows ignore this setting.

InstallScript Language Support

The following InstallScript functions enable you to prevent the highlight behavior:

• CreateShortcut

• SetShortcutProperty

See Also
Shortcuts View
Setting Shell Properties for a Shortcut

Setting Custom Shell Properties

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Project-specific differences are noted where applicable.

InstallShield lets you specify one or more shortcut properties that need to be set by the Windows Shell at run time. The
properties that the Shell can set are defined in propkey.h, which is part of the Windows SDK.

Note that the method for preventing the highlight behavior varies, depending on the project type that you are using.

InstallShield 2020 User Guide ISP-2600-UG00 747

Chapter 4
Configuring the Target System

Instructions for Windows Installer–Based Projects

For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects, use the Shell
Properties setting to set one or more Shell properties.

Task To set a Shell property for a shortcut that is in your project:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, select the shortcut that you want to configure. The shortcut’s settings are displayed in the
right pane.

3. In the Shell Properties setting, click the Add New Shell Shortcut Property button, and then click Custom Property.
InstallShield adds a new Key Name setting, plus additional rows of related settings under it, with placeholder text.

4. Configure each of the settings as needed.

You can add multiple properties for the shortcut if necessary.

Windows Installer 5 introduced support for the Shell shortcut properties. Earlier versions of Windows Installer ignore these
properties.

For more information about configuring shortcut properties, see MsiShortcutProperty Table in the Windows Installer Help
Library.

Note that for Windows Installer–based installations, some end users have reported run-time warnings or errors with a
message such as the following one when Windows Installer is installing a shortcut that configures Shell properties:

Property [1] for shortcut ’[2].lnk’ could not be set.

In the aforementioned message, [1] is the name of the Shell property that Windows Installer is attempting to set, and
[2].lnk is the name of the shortcut file. In such cases, it appears that the .lnk file could be locked by a different process.

InstallScript Language Support

The following InstallScript functions enable you to configure Shell properties in InstallScript projects and in other project
types:

• CreateShortcut

• SetShortcutProperty

See Also
Shortcuts View
Setting Shell Properties for a Shortcut

Creating Uninstallation Shortcuts for Basic MSI Projects

InstallShield 2020

Project • This information applies to Basic MSI projects.

748 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Windows Logo • According to current Windows logo guidelines, best practice is to not place shortcuts to remove the
application in the Start menu. An uninstallation shortcut is unnecessary because your application’s uninstaller is in Add or
Remove Programs.

You can create an uninstallation shortcut to make it easier for end users to uninstall your product from their systems. When
launched, the shortcut automatically starts the uninstallation process.

Task To create an uninstallation shortcut:

1. In the View List under System Configuration, click Shortcuts.

2. In the Shortcuts explorer, right-click the destination directory that should contain the uninstallation shortcut, and
then click New Shortcut to Preexisting file. InstallShield adds a new shortcut with the default name NewShortcutN
(where N is a successive number).

3. Enter a new name, or right-click it later and click Rename to give it a new name.

4. In the Arguments field, type /x [ProductCode]. Separate the two arguments with a space.

Msiexec.exe is the command-line engine for the Windows Installer service. The /x argument instructs the Windows
Installer service to uninstall the product referenced by the product code.

5. Set the Advertised field to No.

6. In the Target field, select [SystemFolder], and then append msiexec.exe to this location.

7. In the Component field, select the component with which you want this shortcut associated. If the shortcut should
always be installed, associate it with the component containing your application’s main executable file.

See Also
Creating Shortcuts and Program Folders
Files and Folders View
Creating Uninstallation Shortcuts for InstallScript and InstallScript MSI Projects

Creating Uninstallation Shortcuts for InstallScript and InstallScript MSI

Projects
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Note • You may not want to create an uninstallation shortcut. An uninstallation shortcut is unnecessary because your
application’s uninstaller is in Add or Remove Programs.

InstallShield 2020 User Guide ISP-2600-UG00 749

Chapter 4
Configuring the Target System

You can create an uninstallation shortcut to make it easier for end users to uninstall your product from their systems. When
end users launch the shortcut, the uninstallation process automatically starts.

The following InstallScript code creates a shortcut called Uninstall Application on the desktop after file transfer.
Launching this shortcut runs your installation in maintenance mode. This code works for both InstallScript and
InstallScript MSI projects.

function OnMoved()
begin
if( !REMOVEALLMODE ) then
AddFolderIcon( FOLDER_DESKTOP, "Uninstall Application", UNINSTALL_STRING +
ADDREMOVE_STRING_REMOVEONLY, "", "", 0, "", REPLACE );
endif;
end;

Tip • If you include ADDREMOVE_STRING_REMOVEONLY, -removeonly is added to the command line. As a result,
REMOVEONLY is set, and the OnMaintUIBefore event handler shows only the uninstallation option. To display the standard
maintenance user interface, do not include ADDREMOVE_STRING_REMOVEONLY.

See Also
Using InstallScript
AddFolderIcon
ADDREMOVE_STRING_REMOVEONLY
OnMaintUIBefore
OnMaintUIBefore
Files and Folders View
Creating Uninstallation Shortcuts for Basic MSI Projects

Configuring the Appearance of a Desktop App’s Tile on the Start Screen

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

Windows 8 introduced a grid of application tiles to the Start screen, replacing the usual list of shortcuts, and also presented
tiles in place of shortcuts. InstallShield supports customizing the appearance of a desktop app's tile on the Start screen.
The following tile configuration settings are available:

• A toggle between light or dark text when including the app name on medium-sized (150x150) tiles

• Choice of tile background color

• Option to use custom tile images (small: 70x70 and medium:150x150)

750 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• Preference to show or hide the app name on medium-sized tiles

The Tile Configurations node appears in the main Shortcuts view and in each component’s Shortcuts subview. Any
applicable tile configurations are listed. For a component, Tile Configurations only applies if it is a configuration for an
.exe file in that component. For the main view, it only applies if the filtering includes the component targeting the
configured .exe file.

Note • While there is a relation between shortcuts and tiles, they are different. You can configure shortcuts individually, and
even create multiple shortcuts to the same .exe file that use different icons; however, you can only create one tile configuration
per .exe file.

Task To configure the appearance of a desktop app's tile on the Start screen:

1. In the Shortcuts view, or in the Shortcuts node of the Setup Design or Components view, click Shortcuts.

2. Right-click Tile Configurations and choose the Add Tile Configuration context menu option.

Note • This step assumes an .exe file has been added to the project. If an .exe file does not exist in the project, the Add
Tile Configuration context menu option is disabled.

Tip • Alternatively, you can right-click the shortcut that targets the .exe file for which you want to configure a Start
screen tile and then choose the Configure Tile context menu option. A new tile configuration is added (and selected). If a
configuration has already been added for the shortcut, the Configure Tile option is disabled.

3. In the resulting Browse for Tile Target dialog box, navigate to and select the .exe file for the app whose tile appearance
you want to configure. A new tile configuration is added.

4. Use any of the settings available for Tile Configurations to customize the appearance of a desktop app's tile on the
Start screen. For additional information regarding available settings, refer to Tile Configuration Settings.

See Also
Shortcuts View
Tile Configuration Settings

Editing the Registry

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object

InstallShield 2020 User Guide ISP-2600-UG00 751

Chapter 4
Configuring the Target System

• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

The Windows registry is a system-wide database that contains configuration information used by applications and the
operating system. The registry stores all kinds of information, including the following:

• Application information such as company name, product name, and version number

• Path information that enables your application to run

• Uninstallation information that enables end users to uninstall the application easily without interfering with other
applications on the system

• System-wide file associations for documents created by an application

• License information

• Default settings for application options such as window positions

Keys, Value Names, and Values

The registry consists of a set of keys arranged hierarchically under the My Computer explorer. Just under My Computer are
several root keys. An installation can add keys and values to any root key of the registry. The root keys that are typically
affected by installations are:

• HKEY_LOCAL_MACHINE

• HKEY_USERS

• HKEY_CURRENT_USER

• HKEY_CLASSES_ROOT

A key is a named location in the registry. A key can contain a subkey, a value name and value pair, and a default (unnamed)
value. A value name and value pair is a two-part data structure under a key. The value name identifies a value for storage
under a key, and the value is the actual data associated with a value name. When a value name is unspecified for a value,
that value is the default value for that key. Each key can have only one default (unnamed) value.

Note that the terms key and subkey are relative. In the registry, a key that is below another key can be referred to as a
subkey or as a key, depending on how you want to refer to it relative to another key in the registry hierarchy.

InstallShield Projects and the Registry

InstallShield includes the Registry view to help you with the task of modifying the end user’s registry. Use this view to
create keys and values in much the same way that you use the Windows Registry Editor.

All registry data (except the <Default> registry set in a InstallScript project) must be associated with a component. In
installation projects, if the component’s feature is selected for installation, the component’s registry data are set up on the
target system.

Caution • It is important not to modify or delete registry keys indiscriminately because the registry is a vital part of the
Windows operating system, and the system may fail to function if vital registry keys are altered.

752 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Note • The installer automatically creates certain registry entries based on values that you provide in the General
Information view.

Windows Logo • These “informational keys” are required if you want to meet the requirements for the Windows logo
program.

Also, all of a component’s advanced settings are used to register files on the target system.

See Also
Registry View
Special Considerations for Searching the Registry at Run Time

Filtering Registry Entries by Component or Feature

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Several project types (DIM, Merge Module, and MSM Database) do not include support for features; these project types have
support for by filtering by component, but not by feature.

The Registry view includes a View Filter. This filter enables you to select a component or feature whose registry data you
want to display in the view.

The View Filter lists your project’s hierarchy of features, subfeatures, and components. Selecting a feature shows the
registry data for all of the components in that feature, but it allows you only to modify and delete existing entries. You need
to select a component in order to add a new registry key.

If the feature hierarchy contains a subfeature, selecting a parent feature displays only the registry entries in that feature. It
does not display the registry entries in the subfeature.

Browsing for Components

You can browse for components from within the registry explorer. Click the ellipsis button to the right of the View Filter to
launch the Browse for Component dialog box. From that dialog box, you can select a feature in the Feature list and then
select an existing component or click the new component button to create a new component.

If the View Filter is set to All Application Data, you can right-click a registry hive in the Destination computer’s registry view
pane and click Browse for Component to display the dialog box.

InstallShield 2020 User Guide ISP-2600-UG00 753

Chapter 4
Configuring the Target System

Viewing All Registry Entries in Your Project

To view all of the registry entries in your installation, select the All Application Data option in the View Filter. You can export
registry data by selecting Export All or Export Selected Branch from the context menu after right-clicking a registry key.

Note • You can modify, rename, or delete registry keys and values while filtering the view by All Application Data.

When you click a registry key in the Destination computer’s Registry view pane of the Registry view, InstallShield displays
all of the registry data for that key in the lower-right pane of the Registry view. The Component column shows the
component with which the registry data is associated. If the same value exists for more than one component, the last
component that was associated with the registry data is displayed.

If you have not set a value for a key, no registry data is displayed for that key when you select All Application Data in the
View Filter.

See Also
Registry View
Special Considerations for Searching the Registry at Run Time

Refreshing the Registry View

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

Task To refresh the Registry view:

Press F12.

See Also
Registry View

754 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Creating Registry Keys

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

Task To specify a registry key to be created on the target system when a component is installed:

1. In the View List under System Configuration, click Registry.

2. In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform, and QuickPatch projects—
In the View Filter list, click the component with which you want to associate the registry data.

Note • If All Application Data is selected, the Registry view is read-only.

In InstallScript and InstallScript Object projects—In the Destination computer’s Registry view pane, open an existing
registry set or create one by right-clicking the Destination Computer folder. Associate the registry set with one or
more components by clicking the registry set and selecting the desired components in the Registry Set Install
Conditions pane.

3. In the Destination computer’s Registry view pane, right-click a registry hive or key, point to New, and then click Key.
InstallShield adds a new key with the name New Key-n (where n is a successive number).

4. Enter a meaningful name to rename the key, or right-click the key and click Rename to give it a new name later.

InstallShield adds your new key with an empty default string value.

By default, all keys that you create are set for automatic installation and uninstallation. This means that they are installed if
the component they belong to is installed, and they are uninstalled when that component in uninstalled. For more
information on registry key flags, see Registry Flags.

Tip • You can create multiple nested keys at one time by creating a new key and typing, for example, Key 1\Key 2\Key 3 in
the key’s name. InstallShield creates a nested key structure where Key 3 is a subkey of Key 2, which is a subkey of Key 1.

InstallShield 2020 User Guide ISP-2600-UG00 755

Chapter 4
Configuring the Target System

See Also
Writing Property Values to the Registry
Special Considerations for Searching the Registry at Run Time

Dragging and Dropping Registry Entries to Create Registry Keys

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

The quickest way to add registry entries to your installation project is to drag them from one of the source panes in the
Registry view and drop them into one of the destination panes. When you drop an entire key onto the Destination
computer’s Registry view pane, all of that key’s subkeys and values are added to the selected component or, in a
InstallScript project, to the registry set on which you drop the entry.

Using the Context Menu to Drag and Drop Keys

You can use the context menu to move multiple keys and values at one time. Right-click a registry entry, drag it to a
destination, and click a command on the context menu.

Table 4-2 • Commands Available from the Registry Entry Context Menu

Option Description

All keys & values Adds all selected keys, subkeys, and values.

Key and its values only Adds only the selected key and the key’s values. No subkeys are added.

Only this key Adds only the selected key, not any of its subkeys or values.

Cancel Ends the drag and drop operation without making any changes.

Viewing Both the 32- and 64-Bit Areas of the Source Machine’s Registry on 64-Bit
Development Systems
If you are using InstallShield on a 64-bit development system, the Registry view in InstallShield displays both the 32-bit and
64-bit areas of your machine’s registry:

756 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• HKEY_LOCAL_MACHINE\Software

• HKEY_LOCAL_MACHINE\Software\Wow6432Node

This support enables you to drag and drop entries from those source areas to the appropriate areas in the destination pane
of this view when you are configuring registry data changes for your project.

Note that if you want your installation to install registry data to a 64-bit area of the registry on 64-bit target systems without
having it redirected to a 32-bit area, you must place the registry data in a component that is marked as 64 bit. Simply
dragging 64-bit data from the source panes in the Registry view to a location in one of the destination panes of the view
does not mark the component as 64 bit. For more information, see Targeting 64-Bit Operating Systems.

Importing Data From Another Machine

A limitation of the drag-and-drop procedure is that it works only if the registry entries exist on your installation
development system. If you have registry data from another machine, you can import that data with the Import REG File
Wizard.

Removing Registry Keys

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

Task To remove a registry key:

1. In the View List under System Configuration, click Registry.

2. In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform, and QuickPatch projects—
In the View Filter list, click the component that contains the registry key, or select All Application Data to view all of
the registry keys for your product.

In InstallScript and InstallScript Object projects—In the Destination computer’s Registry view pane, open the existing
registry set that contains the registry key.

3. In the Destination computer’s Registry view pane, right-click the registry key that you want to remove and then click
Delete.

InstallShield 2020 User Guide ISP-2600-UG00 757

Chapter 4
Configuring the Target System

Creating Registry Values

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

Task To specify a registry value to be created on the target system:

1. In the View List under System Configuration, click Registry.

2. In the Destination computer’s Registry view pane, click the key to which you want to add a value. All existing
registry values for that key are listed in the Destination computer’s registry data pane.

3. Right-click in the list of values and then click the type of data you want to register. Available options are as follows:

Table 4-3 • Types of Registry Values

Option Description

Default Value The key’s default value.

String Value A fixed-length text string.

Binary Value The value is interpreted and stored as a hexadecimal value.

DWORD Value Data represented by a number that is four bytes (32 bits) long.

Multi-String Value Multiple text strings formatted as an array of null-terminated strings, and terminated
by two null characters. Selecting this command launches the Multi-Line String Value
dialog box.

Expandable String Value The value is interpreted and stored as an expandable string. According to the
Microsoft Developer Network (MSDN), an expandable string registry value is a null-
terminated string that contains unexpanded references to environment variables (for
example, %PATH%).

InstallShield adds a new value with the name New Value n (where n is a successive number). Enter a meaningful name now
to rename the value, or right-click the value name and then click Rename to give it a new name later.

758 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Project • In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform, and QuickPatch
projects, any registry value can serve as the component’s key path.

See Also
Setting Key Paths for Components
Entering Multi-Line String Values for Registry Keys
Special Considerations for Searching the Registry at Run Time

Modifying Registry Value Data

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

Task To modify the data for a registry value to be created on the target system:

1. In the View List under System Configuration, click Registry.

2. In the Destination computer’s Registry view pane, click the registry key that has the value that you want to modify.
All registry values are listed in the Destination computer’s registry data pane.

3. Double-click the value that you want to modify. The Edit Registry Data dialog box or the Multi-Line String Value dialog
box opens.

4. Complete the information in the dialog box, and then click OK.

Project • In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform, and QuickPatch
projects—To add value data that contains square brackets ([]), you must precede each bracket with a backslash (\) and
surround it with an opening and closing bracket. Otherwise, Windows Installer treats the value as a property. For example, if
you wanted to write [stuff] to the registry, you would use [\[]stuff[\]] as the value data.

See Also
Entering Multi-Line String Values for Registry Keys

InstallShield 2020 User Guide ISP-2600-UG00 759

Chapter 4
Configuring the Target System

Removing Registry Values

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

Task To remove a registry value from your project:

1. In the View List under System Configuration, click Registry.

2. In the Destination computer’s Registry view pane, click the registry key that has the value that you want to delete.
All registry values are listed in the Destination computer’s registry data pane.

3. In the Destination computer’s Registry data pane, right-click the registry value that you want to remove and then
click Delete.

Registry Flags
InstallShield 2020

Project • Support for registry flags differs, depending on what project type you are using.

Registry flags enable you to control the installation of your registry entries.

Registry Flags in Windows Installer–Based Projects

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

760 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• Transform

By default, your registry entries are created on the target system if the component to which they belong is installed. They
are then removed from the target system when that component is removed. If you would like your registry entries to
remain on the target system even after the product has been uninstalled, or if you want to create registry entries only if
they do not already exist, you need to set the installation flag for that key.

In InstallShield, installation behavior is set at the subkey level. All values beneath the key must have the same installation
and uninstallation behavior.

To change the registry flag of a key, right-click one of your project’s keys in the Registry view, and then click any of the
commands that are listed in the following table.

Table 4-4 • Types of Registry Flags in Windows Installer–Based Projects

Icon Command Description

Automatic This is the default option for all registry keys. If the key is not already present, the installation
creates it. During an uninstallation, if the key is empty, it is removed.

Install only (+) If the key does not already exist, it is created. The key is left on the target system when the
component to which this key belongs is uninstalled.

This option is available only for keys that do not contain subkeys or values.

Uninstall entire If this flag applies to an empty key, the key is not created at installation. If this flag applies to
key (–) a key that contains values and the key does not exist on the target system, the key and values
are created at installation. In both cases, the key, all subkeys, and values are removed at
uninstallation—even if the subkeys and values were added after the installation.

Install if absent, This option is similar to the default behavior (the Automatic registry flag), with one exception.
Uninstall if For the Automatic registry flag, if the key is not empty during uninstallation, it is not removed.
present (*) For the Install if absent, Uninstall if present (*) flag, if the registry key is present during
uninstallation, the key is removed, regardless of whether its subkeys or values remain.

Registry Flags in InstallScript-Based Projects

Project • This information applies to the following project types:

• InstallScript
• InstallScript Object

InstallShield 2020 User Guide ISP-2600-UG00 761

Chapter 4
Configuring the Target System

After your installation has created registry keys on the target system by installing a registry set, subkeys or values may be
created under those keys by other installations or applications (or directly by the end user). You can prevent a registry key
that your installation installed from being uninstalled if it has any subkeys or values that were not created by the
installation. To accomplish this, you can change the registry flag of the key. To do so, right-click one of your project’s keys
in the Registry view and then click the following command.

Table 4-5 • Registry Flag in InstallScript-Based Projects

Icon Command Description

Shared among When the component to which this key belongs is uninstalled, the key is not removed from
several the target system if the key has any subkeys or values. (Note that a value that was created by
applications your installation will have already been uninstalled unless you unset its Remove during
Uninstall flag.) If the key does not have any subkeys or values, the key is removed from the
target system regardless of whether it was created by the installation—that is, whether it
already existed at the time of installation.

You may want your uninstallation to leave some of your product’s registry values on the end user’s system—for example,
registry values that are used by the operating system and are modified by your installation. To do this, right-click the key
that contains the registry value that you do not want to be uninstalled. Select the Shared among several applications flag
for that key. Then right-click the value of the key and ensure that the Remove during Uninstall command is not selected.

See Also
Registry View
Special Considerations for Searching the Registry at Run Time

Searching for Registry Entries in a Project

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

762 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Task To search for a registry entry within a certain component (in Windows Installer projects) or registry set (in InstallScript
projects):

1. In the View List under System Configuration, click Registry.

2. In Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform, and QuickPatch projects—
In the View Filter list, select the component that you would like to search. Note that if View All Entries is selected, the
Registry view is read only.

In InstallScript and InstallScript Object projects—Open the registry set that you would like to search.

3. Right-click a registry entry and click Find. The Find dialog box opens.

4. Enter the string that you are searching for.

5. Click Find to start the search.

In a Windows Installer project, InstallShield searches only the registry entries for the current component, not all the
registry data for the project.

The search starts from the top item and works its way down, regardless of which item is selected. It stops at the first match,
highlighting this key. To continue the search, right-click and select Find Next, or press F3. The Find Next feature finds the
next match, moving down the explorer.

See Also
Special Considerations for Searching the Registry at Run Time

Setting Uninstall Behavior for Registry Keys

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

In InstallShield, uninstall behavior for registry entries is set at the key level.

Task To set the uninstall behavior for a registry key:

1. In the View List under System Configuration, click Registry.

2. In the Destination computer’s Registry view pane, right-click a key and click the appropriate uninstall behavior.

InstallShield 2020 User Guide ISP-2600-UG00 763

Chapter 4
Configuring the Target System

Uninstall Behavior Options

In InstallShield, installation behavior is set at the subkey level. All values beneath the key must have the same installation
and uninstallation behavior. For a list of available options, see Registry Flags.

Using Environment Variables in Registry Values

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

With REG_EXPAND_SZ string values, you can use environment variables for paths that are stored in the registry. These
entries require special formatting in order to be recognized by the operating system as environment variables. The format
for a REG_EXPAND_SZ value as it appears in the registry is %TEMP%. TEMP is the standard environment variable for the
TEMP directory.

Syntax
When creating registry entries of this type, you need to begin the entry with a pound sign followed by a percent sign (#%).
Then, you can enter your environment variable, complete with the beginning and ending percent sign. Therefore, if you
enter #%%TEMP% in the Registry view in InstallShield, it appears as %TEMP% when written to the registry.

The Type field for this entry appears as REG_EXPAND_SZ, and the Data field is %TEMP%.

See Also
Registry View
Special Considerations for Searching the Registry at Run Time

Writing Property Values to the Registry

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

764 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• MSI Database
• MSM Database
• Transform
• QuickPatch

For Windows Installer–based projects, you can use Windows Installer properties in registry values to store information for
later use by your product. At run time, Windows Installer automatically expands expressions of the form [PropertyName]
in registry data to the value of the property called PropertyName. Any property defined in the Property Manager view can
be used in this way.

For example, if you would like to store the destination location of your software, create a registry value whose data is
[INSTALLDIR]. At run time, when your installation creates the registry value, the data for that registry value is set to the
location where your application is installed.

You can use the same format for registry key names and value names. For example, if you want a key name to be the name
of your company, enter [Manufacturer] for the name of the key. When the registry key is created on the target system, the
name of this key will be the value of the Publisher setting, as entered in the General Information view.

See Also
Special Considerations for Searching the Registry at Run Time
Registry View
Property Manager View
RegDBSetKeyValueEx

Importing Registry Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield enables you to import any existing registry (.reg) files that you may have from other installation projects or
that you have created outside InstallShield

Task To import a .reg file:

1. Launch the Import REG File Wizard.

2. Follow the instructions in the wizard panels to import your .reg file.

InstallShield 2020 User Guide ISP-2600-UG00 765

Chapter 4
Configuring the Target System

When you import a .reg file into a component or registry set, that registry data is added to the component’s or registry set’s
registry data and written to the end user’s system if the component or registry set is installed.

Exporting Registry Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform

When you export a registry (.reg) file, you are copying a portion of your program’s registry data to a registry file.

Task To export a registry file:

1. In the View List under System Configuration, click Registry.

2. In the Destination computer’s Registry view pane, right-click the registry entry that you want to export and click
either Export REG File or Export Selected Branch.

• Export REG File exports the entire component’s registry data.

• Export Selected Branch exports only the current registry key and any subkeys.

Setting Key Paths for Components

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

766 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

A key path is a unique registry value for each component that the Windows Installer uses to detect the component’s
presence. This value must contain a file or a folder.

Task To set a component’s key path:

1. In the View List under System Configuration, click Registry.

2. In the Destination computer’s Registry view pane, click the registry entry that contains the registry data that you
want to use for the key path.

3. In the Destination computer’s registry data pane, right-click the registry key’s value name and then click Set Key
Path.

The value’s string, binary, or DWORD icon is replaced with a key icon.

Task To remove a component’s key path:

Right-click the key path and click Clear Key path.

Note • A component can have either one key path or one key file. If you have already set a key file or a key path for a
component, you will get a warning prompt if you try to set another key path. Click Yes in the dialog box to replace the existing
key file or key path with the new key path.

See Also
Setting Component Key Files
Overwriting Files and Components on the Target System

Configuring Permissions for Registry Keys

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield lets you configure settings for securing registry keys for end users who run your product in a locked-down
environment. You can assign permissions for a registry key to specific groups and users. For example, you may assign Read,
Write, and Delete permissions for a particular registry key to the Administrators group, but only Read permissions for all of
the users in a different group.

InstallShield 2020 User Guide ISP-2600-UG00 767

Chapter 4
Configuring the Target System

Task To configure the permissions for a registry key:

1. In the View List under System Configuration, click Registry.

2. In the Destination computer’s Registry view pane, right-click the registry key and then click Permissions button.
The Permissions dialog box opens.

3. Add, modify, and remove permissions entries as needed. For more information, see Permissions Dialog Boxes for
Registry Keys.

Depending on what is selected for the Locked-Down Permissions setting in the General Information view of your project,
InstallShield adds permissions data to either the ISLockPermissions table or the LockPermissions table. To learn more,
see Securing Files, Folders, Registry Keys, and Windows Services in a Locked-Down Environment.

See Also
Configuring Permissions for Files and Folders

Primary Keys for the Registry Table

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Windows Installer requires a unique primary key for each registry key and value that you add to the Registry table. To
enable you to create registry entries in a completely visual environment, InstallShield assigns a unique name to every entry
in the database’s Registry table at build time.

You may need to know the entry’s primary key when authoring a custom action. InstallShield supports specifying a primary
key on a registry key or value in the Registry Data explorer in the Setup Design view or the Components view. Note that it is
not possible to assign the key or value a primary key in the Registry view.

Specifying a Primary Key for the Registry Table

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM

768 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Task To specify a primary key for a registry key or value:

1. Right-click the key or value and click MSI Value. The MSI Value dialog box opens.

2. Enter the name of the key. Since the primary key must be a Windows Installer identifier, the name may contain only
letters, numbers, underscores (_) and periods (.), and it must begin with a letter or underscore.

To view or modify the primary key, right-click the registry key or value and click MSI Value again.

If you do not specify a value, InstallShield generates a unique primary key for this entry in the Registry table.

Entering Multi-Line String Values for Registry Keys

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

The Registry view provides multi-line string support when you want to add a value to a particular registry key.

Task To add a multi-line string value:

1. Right-click the registry key to which you want to add the multi-line value, point to New, and click Multi-String Value.
The Multi-Line String Value dialog box opens.

2. Select how you want to modify the registry value, and then enter a line for each null-delimited string.

3. Click OK.

Note • Strings can contain just spaces, but they cannot be empty or [~], which is the delimiter for the strings.

InstallShield 2020 User Guide ISP-2600-UG00 769

Chapter 4
Configuring the Target System

Writing Entries Under HKCU for a Per-User Installation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform
• QuickPatch

Since the current user may not have sufficient privileges for modifying keys under HKEY_LOCAL_MACHINE, you may need
to write the entries under HKEY_CURRENT_USER.

When you select HKEY_USER_SELECTABLE in the Registry view, the entries are created under the appropriate registry hive,
according to the type of installation and the end user’s access rights. In a per-user installation, which means that the
ALLUSERS property is set to 2 or that the installation is being run by someone with user-level access privileges, these entries
would be made under HKEY_CURRENT_USER. In a per-machine installation, which means that ALLUSERS is not null and
that the end user is an administrator, the entries would be written under HKEY_LOCAL_MACHINE.

Note • Windows does not allow a new key to be created directly under HKEY_LOCAL_MACHINE. For this reason, any
information that you create under HKEY_USER_SELECTABLE must be placed under the SOFTWARE subkey, which is the only
subkey common to HKEY_LOCAL_MACHINE and HKEY_CURRENT_USER.

For example, creating the key HKEY_USER_SELECTABLE\SOFTWARE\MyCompany is valid, but creating

HKEY_USER_SELECTABLE\MyCompany is not.

Setting or Getting Multi-Line Strings in the Registry

InstallShield 2020

Project • This information applies to InstallScript projects.

Setting Multi-Line Strings

To set multi-line strings, call the RegDBSetKeyValueEx function. The szValue parameter should contain the substrings to
be added, separated by null characters. You must add two null characters to the end of the main string to denote its end.
To create such a string, follow these steps:

1. Initialize the string to contain each of the substrings, separated by space characters.

2. Assign the ASCII value for a null string to the string positions after each line.

3. Assign an additional null character (ASCII value 0) to the end of the string.

770 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

For example:

svValue = "This is line one. This is line two. This is line three. ";
svValue[17] = 0;
svValue[35] = 0;
svValue[55] = 0;
svValue[56] = 0;

Retrieving Multi-Line Strings

To get multi-line strings, call the RegDBGetKeyValueEx function. The substrings will be returned in a main string,
separated by null characters. To extract them, use the following code to read the strings into a string list and display them
in an SdShowInfoList dialog:

// svValue is the string read in by RegDBGetKeyValueEx

listID = ListCreate( STRINGLIST );
if (listID != LIST_NULL) then
StrGetTokens( listID, svValue, "" );
SdShowInfoList( szTitle, szMsg, listID );
endif;

See Also
Using Null-Delimited Strings
RegDBSetKeyValueEx
RegDBGetKeyValueEx
SdShowInfoList

Working with Registry Functions

InstallShield 2020

Project • For InstallScript MSI and Basic MSI projects, it is recommended that you use the Registry view in InstallShield instead
of creating registry keys and values through InstallScript code. Handling all of your registry changes in this way allows for a
clean uninstallation through the Windows Installer service.

The InstallScript language includes many built-in functions that help you configure an installation so that it accesses the
registry; reads, creates, and deletes registry keys; and establishes registry-related parameters for uninstallation.

For example, you can sometimes determine if an application is present on the target system by detecting registry keys used
by the application. Many applications store data in the registry key
HKLM\SOFTWARE\CompanyName\ProductName\ProductVersion. To detect if a registry key exists, you can call the
RegDBKeyExist function in your InstallScript code as follows:

// always set root key before calling other RegDB functions

RegDBSetDefaultRoot(HKEY_LOCAL_MACHINE);

if (RegDBKeyExist("Software\\ThisCo\\ThisApp") = 1) then
MessageBox("ThisApp is on the system.", INFORMATION);
endif;

To learn more about the built-in registry functions available with InstallScript, see the following:

• Registry Functions

InstallShield 2020 User Guide ISP-2600-UG00 771

Chapter 4
Configuring the Target System

• Special Registry-Related Functions

See Also
RegDBKeyExist
RegDBSetDefaultRoot

Reading Data from the Registry

InstallShield 2020

Basic MSI Project

The AppSearch and RegLocator tables can read a value from the registry. To read the RegisteredOwner value mentioned
above, add the following record to the AppSearch table, using the Direct Editor:

Table 4-6 • Values for the AppSearch Table

Field Value Comments

Property REGISTERED_OWNER Must be a public property

Signature_ registry_sig

Next, add the following record to the RegLocator table:

Table 4-7 • Values for the RegLocator Table

Field Value Comments

Signature_ registry_sig Same signature as above

Root 2 HKEY_LOCAL_MACHINE

Key Software\Microsoft\Windows
NT\CurrentVersion

Name RegisteredOwner

Type 2 Registry data

After the AppSearch action runs, the REGISTERED_OWNER property will contain the data read from the registry. If the value is
not found, the property will be undefined (empty).

For more information regarding the AppSearch and RegLocator tables, see the Windows Installer Help Library.

For Windows Installer-based projects, you can use the System Search Wizard to find data.

772 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

InstallScript MSI Project

With InstallScript, you can use the RegDBGetKeyValueEx function. For example, to read the RegisteredOwner value from
the key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion, you can use code similar to the
following:

function readRegisteredOwner( )
STRING svRegisteredOwner;
NUMBER nvType, nvSize;
begin
RegDBSetDefaultRoot(HKEY_LOCAL_MACHINE);

RegDBGetKeyValueEx(
"Software\\Microsoft\\Windows NT\\CurrentVersion",
"RegisteredOwner",
nvType,
svRegisteredOwner,
nvSize);

MessageBox(
"Registered owner is: " + svRegisteredOwner,
INFORMATION);
end;

You can set a Windows Installer property equal to the value you read using the MsiSetProperty function.

See Also
Special Considerations for Searching the Registry at Run Time
RegDBGetKeyValueEx

Changing .ini File Data

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes .ini file functions for
modifying .ini file data. You can use these functions in InstallScript projects.

Initialization (.ini) files serve as a database in which you can store and retrieve information between the uses of your
applications. Some .ini files, such as Boot.ini and Wininit.ini, are used by the operating system. The INI File Changes
view enables you to specify changes that should be made to .ini files on the target system. Although you can edit any .ini
file found on the target system, editing system .ini files is not recommended.

InstallShield 2020 User Guide ISP-2600-UG00 773

Chapter 4
Configuring the Target System

Task To edit an .ini file:

1. Create an .ini file reference.

2. Add a section to the .ini file.

3. Add a keyword to the .ini file.

Before you can create an .ini file reference, you must have at least one component created. If no components exist when
your .ini file reference is created, the Create a New Component dialog box is displayed, enabling you to create a
component.

Creating .ini File References

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes .ini file functions for
modifying .ini file data. You can use these functions in InstallScript projects.

The first step in creating an .ini file change is to create a reference to the file that you would like to edit. In order to do this,
you need to know the name and location of the file on the target system that you would like to edit. If the file is not in the
location that you specify, the installation cannot make changes to this file.

Task To create a reference to an .ini file:

1. In the View List under System Configuration, click INI File Changes.

2. Right-click the INI Files explorer and then click Add INI File.

InstallShield adds a new reference for the .ini file to the INI Files explorer. Configure the .ini file’s settings in the right pane.
For details about each setting, see .ini File Settings.

After you have created a reference to an .ini file, you can move on to the next step, which is to add a section to your .ini file.

See Also
INI File Changes View

774 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Importing an Existing .ini File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes .ini file functions for
modifying .ini file data. You can use these functions in InstallScript projects.

InstallShield lets you import an existing .ini file into your project. Once you have imported the .ini file, you can use the INI
File Changes view to configure the changes that you want to be made on the target system as needed.

Task To import an existing .ini file:

1. In the View List under System Configuration, click INI File Changes.

2. Right-click the INI Files explorer and then click Import INI File. The Open dialog box opens.

3. Select the .ini file that you want to import, and then click Open.

InstallShield imports the .ini file, along with all of its sections, keywords, and values, into your project.

See Also
INI File Changes View

Specifying a Section in an .ini File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield 2020 User Guide ISP-2600-UG00 775

Chapter 4
Configuring the Target System

This information does not apply to InstallScript projects; however, the InstallScript language includes .ini file functions for
modifying .ini file data. You can use these functions in InstallScript projects.

Once you have specified the .ini file that you would like to edit, you can move onto the second step: specifying which
section of that file you want to change. The .ini files are divided into sections, with each section containing keywords.
Sections are identified by the square brackets surrounding them—for example, [SectionName].

Task To specify an .ini file section:

1. In the View List under System Configuration, click INI File Changes.

2. Create a reference to an .ini file if it does not exist.

3. In the INI Files explorer, right-click the .ini file that should contain the section and click Add Section.

InstallShield adds a section to the INI Files explorer. Configure the section’s settings in the right pane. For details about
each setting, see Section Settings for an .ini File.

After you have specified a section in your .ini file, you can add a keyword.

See Also
INI File Changes View
Using String Entries in InstallShield

Specifying a Keyword in an .ini File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes .ini file functions for
modifying .ini file data. You can use these functions in InstallScript projects.

The keywords in an .ini file are the lowest level of organization in the .ini file. Keywords store data that must persist
between uses of an application.

Once you have added an .ini file to your project and set up one or more sections, you can add keywords to the sections and
then configure the keyword’s properties. The properties of a keyword include the value for the keyword, as well as the
action that should be performed (such as replace a data value or append to an existing data value).

776 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Task To specify a keyword for an .ini file:

1. In the View List under System Configuration, click INI File Changes.

2. In the INI Files explorer, right-click a section and click Add Keyword.

InstallShield adds a keyword to the INI Files explorer. Configure the keyword’s settings in the right pane. For details about
each setting, see Keyword Settings for an .ini File.

See Also
INI File Changes View

Reading Data from .ini Files

InstallShield 2020

You can use the GetProfString function to read data (such as key names) from an .ini file, regardless of where the .ini file is
located (for example, on a network). The following example script provides a guide:

/*

Assuming the .ini file is called Test.ini, and contains the following:

[ProductSettings]
Key1=One
Key2=2
Key3=III
Key4=....

[OtherSettings]
Key1=Value1
Key2=Value2

*/

function OnBegin( )
STRING svKey1Value; // filled in by GetProfString
begin

// read a single value

GetProfString(
"\\\\Server\\Config\\Test.ini", // file name; note the double
backslash for each "real" backslash
"ProductSettings", // section name without square brackets
"Key1", // key name
svKey1Value); // STRING variable to capture key value

MessageBox("Key1's value is: " + svKey1Value, INFORMATION);

end;

See Also
GetProfString

InstallShield 2020 User Guide ISP-2600-UG00 777

Chapter 4
Configuring the Target System

Reading All Key Names from .ini Files

InstallShield 2020

To read all of the key names from a section in an .ini file, use the following script:

function OnBegin( )
STRING svAllKeyNames; // filled in by GetProfString
LIST listKeyNames; // string list containing key names
begin

// read a single value

GetProfString(
"\\\\Server\\Config\\Test.ini", // file name; note the double
backslash for each "real" backslash
"ProductSettings", // section name without square brackets
"", // key name; null string "" means to get all key names
svAllKeyNames); // STRING variable to store key names

listKeyNames = ListCreate(STRINGLIST);

// take apart string containing key names

StrGetTokens(listKeyNames, svAllKeyNames, "");

SdShowInfoList("Key names", "Here they are:", listKeyNames);

// if desired, you can loop over the key names in the list and read each
key's value...

ListDestroy(listKeyNames);

end;

Configuring ODBC Resources

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

One of the more complex areas of system configuration involves setting up ODBC drivers, data source names (DSNs), and
translators. The ODBC resource must be properly registered on the system with all of the required attributes and, in the
case of drivers and translators, install the necessary files, including any installation .dll files. This process is simplified in the
ODBC Resources view, in which you can select the drivers, data sources, and translators installed on your development
system.

778 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

See Also
ODBC Resources View

Installing ODBC Resources

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

All of the ODBC drivers, data source names (DSNs), and translators registered on your system are displayed in the ODBC
Resources view. DSNs are shown as children of their associated driver. Expand the explorer to view all of the existing ODBC
resources.

To include an ODBC resource in your installation, select the check box next to its name in the ODBC Resources pane in the
upper-left corner of the view. In installation projects, the resource must then be associated with at least one feature so that
it can be installed. Then, you can set the attributes for the selected resource.

Including Additional ODBC Resources

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

You can also install ODBC resources not listed in the explorer. Where you add them depends on the type of resource.

Task To add a driver that is not listed in the ODBC Resources explorer in the ODBC Resources view:

1. In the ODBC Resources explorer, right-click Drivers and DSNs and click New Driver.

2. Enter a new name for the driver, or press the F2 key later to rename it.

InstallShield 2020 User Guide ISP-2600-UG00 779

Chapter 4
Configuring the Target System

3. Select the check box next to the new driver to include it in your installation.

Task To add a data source that is not listed in the ODBC Resources explorer in the ODBC Resources view:

1. In the ODBC Resources explorer, right-click a driver and click New DSN.

2. Enter a new name for the DSN, or press the F2 key later to rename it.

3. Select the check box next to the new DSN to include it in your installation.

Note • You cannot add a translator to the list. Instead, you must install it on the development system and then select it.

See Also
ODBC Resources View

Associating ODBC Resources with Features

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Like most of the data in your project, ODBC resources must be associated with a feature. When the feature is installed to
the target system, the ODBC resource is installed as a part of the feature.

After you choose to install a driver, DSN, or translator for installation, the Features list is enabled on the right side of the
ODBC Resources explorer. Select all of the features to which the ODBC resource belongs. InstallShield creates a new
component and associates it with each selected feature. The resource will be installed only once even if it is associated
with multiple features, but the resource cannot be installed if none of its features is installed.

In an InstallScript MSI project, if no other feature exists, the resource is added to the DefaultFeature. In a Basic MSI project,
if a feature does not exist when you add an ODBC resource to your installation, the Create a New Feature dialog box is
displayed. This dialog box prompts you to create a feature. If only one feature is associated with an ODBC resource, it
cannot be deselected until you select at least one additional feature.

780 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Setting ODBC Resource Attributes

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

When an ODBC resource is registered on the development system, its current attributes are displayed in the Properties list
of the ODBC Resources view. You can edit the attributes in the Properties pane after you have selected the driver, data
source name (DSN), or translator.

Adding and Deleting New Attribute Entries

Note that adding attributes to a translator is not supported.

Task To add a new attribute to a driver or DSN:

1. Open the ODBC Resources view.

2. In the ODBC Resources explorer, click the driver or DSN that should contain the new attribute entry.

3. Click in the last row of the property sheet, and add the appropriate information for the Property and Value columns.

Task To delete an attribute from a driver or DSN:

1. Open the ODBC Resources view.

2. In the ODBC Resources explorer, click the driver or DSN that should contains the attribute entry that you want to
delete.

3. In the property sheet, right-click the row that you want to delete and then click Delete.

See Also
ODBC Resource Settings

Using Environment Variables

InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 781

Chapter 4
Configuring the Target System

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The InstallScript language includes the GetEnvVar function for retrieving the current value of an environment variable, and it
enables you to create an environment variable.

Environment variables are name and value pairs that can be set on the target system with your installation and can be
accessed by your application and by other running programs. Environment variables are stored in the registry.

In the Environment Variables view, you can create, set (or modify), and remove environment variables on the target system
through your installation. You can also specify environment variable properties in this view.

See Also
Environment Variables View

Setting Environment Variables

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The InstallScript language includes the GetEnvVar function for retrieving the current value of an environment variable, and it
enables you to create an environment variable.

Task To create a new environment variable or modify the value of an existing environment variable:

1. In the View List under System Configuration, click Environment Variables.

2. Right-click the Environment Variables explorer and click Add Environment Variable.

3. InstallShield adds a new environment variable with the default name NewEnvironmentVariableX (where X is a
number). Type the name of the variable that you want to modify, remove, or create.

4. In the pane on the right, configure the environment variable’s settings. For details about each setting, see
Environment Variable Settings.

782 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

See Also
Environment Variables View

Environment Variables Example

InstallShield 2020

/********************************************************************\
* The following code creates an environment variable under Windows
* for an entire system. You can modify the OnEnd event handler
* function block (or any other function block) to include this example
* code.
*
* NOTE: The current user must have administrator privileges for this
* code to work.
\********************************************************************/

#define WM_WININICHANGE 0x001A

#define HWND_BROADCAST 0xffff
NUMBER nResult;
STRING szKey, szEnv;
WPOINTER pEnv;

begin

szKey = "SYSTEM\\CurrentControlSet\\Control\\Session Manager\\Environment";

RegDBSetDefaultRoot(HKEY_LOCAL_MACHINE);
nResult = RegDBSetKeyValueEx(szKey, "Fame", REGDB_STRING, "C:\\Test", -1);
if (nResult < 0) then
MessageBox("Failed to Set Environment Variable", WARNING);
else
MessageBox("Successfully Set Environment Variable", INFORMATION);
// Flush the registry to all applications.
szEnv = "Environment";
pEnv = &szEnv;
SendMessage (HWND_BROADCAST, WM_WININICHANGE, 0, pEnv );
endif;
// RebootDialog("", "", SYS_BOOTMACHINE);
end;

/********************************************************************\
* The following code creates an environment variable under Windows
* for the current user. You can modify the OnEnd event handler
* function block (or any other function block) to include this example
* code.
*
* NOTE: The current user must have administrator privileges for this
* code to work.
\********************************************************************/

#define WM_WININICHANGE 0x001A

#define HWND_BROADCAST 0xffff

NUMBER nResult;

InstallShield 2020 User Guide ISP-2600-UG00 783

Chapter 4
Configuring the Target System

STRING szKey, szEnv;

WPOINTER pEnv;

begin
szKey="Environment";
RegDBSetDefaultRoot(HKEY_CURRENT_USER);
nResult=RegDBSetKeyValueEx(szKey,"Fame",REGDB_STRING,"C:\\test",-1);
if (nResult < 0) then
MessageBox("Failed to Set Environment Variable",WARNING);
else
MessageBox("Successfully Set Environment Variable",INFORMATION);
// Flush the registry to all applications.
szEnv = "Environment";
pEnv = &szEnv;
SendMessage (HWND_BROADCAST, WM_WININICHANGE, 0, pEnv );
endif;
//RebootDialog("","",SYS_BOOTMACHINE);
end;

Modifying XML Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

You may need to modify .xml files that store settings related to your product, or you may need to modify standard
configuration files such as web.config and machine.config. InstallShield includes support for modifying XML files on the
target system at run time. The XML files can be part of your installation, or they can be files that are already present on
target systems.

For instructions on how to modify an XML file during installation, consult this section of the documentation.

For background information about XML, see the following Web sites:

• World Wide Web Consortium (http://www.w3.org)

• W3 Schools (http://w3schools.com)

Tip • Support for XML files extends into other areas of InstallShield product functionality. The System Search feature in
InstallShield enables you to search for an attribute value, contents, or existence of the element in the XML file that you specify.
For more information, see Searching for XML Data.

784 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

See Also
XML File Changes View
Import XML Settings Wizard

Overview of XML File Changes

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

Design-Time Tasks
The XML File Changes view enables you to define modifications that should be made to an XML file at run time. The typical
process for defining those modifications is as follows:

1. If the XML file that you are modifying is part of your installation, add the base XML file to a component in your project
through the Files and Folders view.

2. In the XML File Changes view, create an XML file reference for the file that you want to modify.

3. Specify the location for the XML file on the target machine.

4. Specify which feature or features should contain the XML file changes. This may be the same feature that contains the
component in step 1, or it may be a different feature.

5. Configure the changes that you want to occur at run time.

You may need to add an MSXML redistributable to your project. For more information, see Run-Time Requirements for XML
File Changes.

Run-Time Behavior
The XML File Changes view enables you to configure run-time behavior such as the following:

• Add a namespace mapping to an XML file, and add namespace prefixes to elements and attributes.

• Create a specified element if it does not already exist.

• Modify an element if it exists, but do not create it if it does not exist.

• Modify only the first element in the XML file that matches the specified XPath expression, or modify all matching
instances.

• Remove an element during uninstallation.

• Set content for an element.

InstallShield 2020 User Guide ISP-2600-UG00 785

Chapter 4
Configuring the Target System

• Create a new attribute during installation, during uninstallation, or both.

• Remove an existing attribute during installation, during uninstallation, or both.

• Append a string to an existing attribute value during installation, during uninstallation, or both.

• For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, and Transform projects: Replace Windows Installer
properties in elements, attributes, attribute values, and element content with the appropriate values at run time.

• For InstallScript projects: Substitute InstallScript string variables for elements, attributes, attribute values, and
element content with the appropriate values at run time.

When an installation that contains XML file changes runs on a target system, MSXML parses the XML file and executes the
XPath expressions that are associated with the changes that you configured. The Advanced tab in the XML File Changes
view for an XML file shows the XPath expressions that are executed on target systems.

When MSXML finds an area of the XML file that matches the XPath expression, the changes that were configured in the XML
File Changes view are made.

For examples of how to create some basic XPath expressions, see Using XPath Expressions to Find XML Data in an XML File.

Note • If the XML file does not exist on the target system at run time and the Always create XML file if it does not already
exist check box is selected on the Advanced tab for the XML file, the XML file is created with the XML data that is configured in
the XML File Changes view.

Run-Time Requirements for XML File Changes

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

The run-time functionality for XML file changes requires the presence of Microsoft XML Core Services (MSXML) 3.0 or later
on the target system.

When an installation that contains XML file changes runs on a target system, MSXML parses the XML file and executes the
XPath expressions that are associated with the changes that you configured. When MSXML finds an area of the XML file that
matches the XPath expression, the changes that were configured in the XML File Changes view are made.

InstallShield includes redistributables for different versions of MSXML. If it is possible that target systems may not have
MSXML, or they may not have the appropriate version of MSXML, you can add the appropriate MSXML redistributable to
your project in either the Redistributables view (for Basic MSI and InstallScript MSI projects) or the Prerequisites view (for
InstallScript projects).

786 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

For detailed information about MSXML, see the MSDN Library.

See Also
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects

Creating an XML File Reference

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

The recommended way to add an XML file that you want to modify at run time is to add the base XML file to a component in
your project through the Files and Folders view. Then add an XML file reference to the XML File Changes view, where you
can specify the changes that should be made to that file at run time. The easiest way to add the XML file reference is to
import the file into the XML File Changes view.

Important • The XML File Changes view is not designed to list a node for every node in an XML file. To improve performance,
the XML File Changes view should show only the settings that differ from the base XML file:

• If the XML file that you are modifying is part of your installation, the XML File Changes view should list only the nodes and
node sets that should be added, changed, or deleted after the XML file is installed at run time.
• If the XML file that you are modifying is a file that is already present on the target system, the XML File Changes view
should list only the nodes and node sets that need to be added, changed, or deleted at run time.

Therefore, when you are importing a file, import only the nodes in the XML file that you want to modify at run time.

Note that the XML File Changes view does not enable you to specify the order in which new elements should be listed in the XML
file. Therefore, importing only the nodes that you want to modify at run time helps to avoid issues that may occur if your
product requires that the elements be listed in a particular order.

Task To import an XML file into the XML File Changes view:

1. In the View List under System Configuration, click XML File Changes.

2. Right-click the XML Files explorer and then click Import. The Import XML Settings Wizard opens.

3. Complete the panels in the wizard, selecting only the XML file nodes that you want to change.

4. Click Import.

InstallShield 2020 User Guide ISP-2600-UG00 787

Chapter 4
Configuring the Target System

InstallShield adds a new node for the XML file that you imported. The XML file node contains each of the nodes that you
selected in the wizard. Each node represents an XPath query that occurs at run time. InstallShield also adds a new
component for the XML file that you have imported through the XML File Changes view.

Now you can configure the XML file’s settings and specify any element, attribute, and content changes for it.

Tip • You can also add an XML file by right-clicking the XML Files explorer and then clicking New File. However, in most cases,
you may want to create your XML file in a third-party XML editor or text editor. Next, add this file to your project through the
Files and Folders view. Then, import the file, as described in the aforementioned procedure, and configure the changes that
should be made to the file at run time.

See Also
Import XML Settings Wizard
XML File Changes View

Specifying the Location of the XML File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

When you add an XML file reference in the XML File Changes view, you need to specify the location of the XML file. If the XML
file is part of your installation, the location should match the destination that you specified for the base XML file when you
added it to your project through the Files and Folders view.

Task To specify the location of the XML file on the target system:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, click the XML file whose location you want to specify.

3. Click the General tab.

4. In the XML File Destination area, click the Browse button. The Browse for Directory dialog box opens.

5. In the Destination Directories box, select the location.

6. Click OK.

InstallShield adds the destination that you specified to the Specify the location of the XML file on the target machine
box.

788 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

See Also
XML File Changes View

Associating an XML File Change Reference with a Feature

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

When you add an XML file reference in the XML File Changes view, InstallShield automatically creates a new component for
it. In addition, InstallShield associates the component with the feature that is at the top of your feature list by default. To
change this association, you can use the XML File Changes view.

Note • If your project does not contain any features when you add an XML file reference, InstallShield displays the Create a
New Feature dialog box, which lets you to create a new feature.

Task To associate an XML file change reference with a feature in your project:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, click the file whose component you want to associate with a feature.

3. Click the General tab.

4. In the Select Features the XML file belongs to box, select the check box of any feature that should contain the
selected XML file change reference. This may be the same feature that contains the base XML file that you added to
your project through the Files and Folders view, or it may be a different feature.

If an end user chooses to install the feature that contains the XML file changes, the XML file changes are performed at run
time.

See Also
XML File Changes View

InstallShield 2020 User Guide ISP-2600-UG00 789

Chapter 4
Configuring the Target System

Adding a Root Element

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

If you are adding an XML file reference in the XML File Changes view, you can add a root element. Note that an XML file can
contain only one root element.

Task To add a root element to an XML file:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, right-click the XML file to which you want to add a new root element and click New Root
Element.

InstallShield adds the new root element. Use the tabs that are displayed in the right pane to configure its settings.

Tip • To add a root element and one or more levels of subelements in one step, type the name of the root element plus the
subelements, with each separated by a slash. For example, to add a root element called Root, a Sub element under the Root
element, and a Sub2 element under the Sub element, type the following:

Root/Sub/Sub2

InstallShield automatically expands it in the explorer.

See Also
XML File Changes View

Adding a New Element

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

790 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• Merge Module
• MSI Database
• Transform

You can add a new element to the root element or any element in your XML file.

Task To add a new element:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, right-click the XML file to which you want to add a new element and click New Element.

InstallShield adds the new element. Rename it as appropriate, and use the tabs that are displayed in the right pane to
configure its settings.

Tip • When you are adding elements and subelements under the root element in the XML File Changes view, you can type the
full XPath expression for the name of the element, and it will automatically expand in the explorer.

To add a root element and one or more levels of subelements in one step, type the name of the root element plus the
subelements, with each separated by a slash. For example, to add a root element called Root, a Sub element under the Root
element, and a Sub2 element under the Sub element, type the following:

Root/Sub/Sub2

InstallShield automatically expands it in the explorer so that each element has its own node.

See Also
XML File Changes View

Adding an Element for a .NET Configuration File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

If you define .NET configuration settings for your product in a web.config file, you can specify those settings through the
XML File Changes view.

InstallShield 2020 User Guide ISP-2600-UG00 791

Chapter 4
Configuring the Target System

Task To add an element for a .NET configuration file:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, right-click the XML file to which you want to add a configuration element, click Add
Predefined Element, point to .NET Configuration Files, point to Web Configuration File, point to a given set of
settings, and click the appropriate command.

InstallShield adds the new element in the explorer.

For detailed reference information about the different elements and attributes in .NET configuration files, see
Configuration File Schema on the MSDN Web site (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/
cpgenref/html/gngrfnetframeworkconfigurationfileschema.asp).

See Also
XML File Changes View

Adding an Attribute to an Element

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

You can add attributes to an element in your XML file and then specify whether the attribute should be created at run time,
the attribute should be removed at run time, or the attribute value should be appended to the existing value at run time.
You can also schedule whether the task should occur during installation, uninstallation, or both.

If an attribute that you add already exists in the XML file on the target machine but the attribute has a different value than
the one that you specified in the XML File Changes view, the installation updates the value at run time.

Task To add an attribute to an XML element:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, click the XML file to which you want to add an attribute.

3. Click the General tab.

4. Click the Add button.

792 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

InstallShield adds a new row—with default values for the Attribute, Value, Operation, and Scheduling columns—to the
attribute table. Change any of the settings as needed. To learn more about each of the columns, see General Tab for an XML
Element.

Tip • If you configure your installation so that the XML file remains on the target system when its component is uninstalled,
you may want to create installation/uninstallation attribute pairs in the attribute table.

For example, to add a key attribute during installation and remove that same key attribute during uninstallation, add two
rows with the key attribute to the attribute table; schedule one row for installation, and the other for uninstallation.

See Also
Using Reserved Characters (<, >, &, ', and ") Inside Elements
XML File Changes View

Editing an Attribute’s Value

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

InstallShield enables you to edit the value of an attribute if it is already present on the target machine at run time. To do so,
add the attribute to the element in the XML File Changes view, and configure the value for the attribute as needed. The
procedure for editing an attribute value is the same as adding an attribute value. To learn more, see Adding an Attribute to
an Element.

At run time, if a different value exists for the attribute, the installation replaces the value with the one that you configured
in the XML File Changes view.

See Also
XML File Changes View

Adding Content to an Element

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 793

Chapter 4
Configuring the Target System

• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

XML elements can contain text content. For example, in the following XML code, feature is the content for the element
product:

<product>feature</product>

Task To add content to one of the elements listed in the XML File Changes view:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, select the element to which you want to add content.

3. Select the Advanced tab.

4. Select the Set element content check box.

5. In the Content box, type the text content.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages
that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) next to
this setting to select an existing string. For more information, see Using String Entries in InstallShield.

See Also
General Tab for an XML Element
Advanced Tab for an XML Element
Using Reserved Characters (<, >, &, ', and ") Inside Elements
XML File Changes View

Using XPath Expressions to Find XML Data in an XML File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

794 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

In order for your installation to add a new element or attribute to an XML file, or to perform some other change to an XML
file at run time, MSXML must use the XPath expressions that are defined in the XML File Changes view to navigate through
the XML file and locate the areas that need to be modified.

For detailed information about writing XPath expressions, see the following Web sites:

• World Wide Web Consortium (http://www.w3.org)

• W3 Schools (http://w3schools.com)

The following sections show examples of how to create some basic XPath expressions.

Example 1: Adding Two Elements

In example 1, the installation adds the bold lines in the following XML document:

<?xml version="1.0" encoding="UTF-8"?>

<Books>
<Biographies>
<Book Author="Bill Smith" Copyright="2007">Bill's Great Biography</Book>
<Book Author="John Smith" Copyright="2006">John's Great Biography</Book>
</Biographies>
</Books>

To add those elements, the following XPath expressions are added under the Biographies node in the XML File Changes
view:

Book[@Author="John Smith"]
Book[@Author="Bill Smith"]

The following screen shots show the settings in the XML File Changes view.

Figure 4-1: Settings for the Sample.xml File

InstallShield 2020 User Guide ISP-2600-UG00 795

Chapter 4
Configuring the Target System

Figure 4-2: Settings for the Biographies Node, which Contains the Child Nodes to Be Added

Figure 4-3: General Settings for One of the Child Nodes to Be Added

Figure 4-4: Advanced Settings for One of the Child Nodes to Be Added

796 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Figure 4-5: General Settings for One of the Child Nodes to Be Added

Figure 4-6: Advanced Settings for One of the Child Nodes to Be Added

Example 2: Adding Attributes to Elements

In example 2, the installation adds the bold attributes and values in the following XML document:

<?xml version="1.0" encoding="UTF-8"?>

<Books>
<Biographies>
<Book Author="Bill Smith" Copyright="2007" Publisher="Bill & John's Publish Co.">Bill's Great
Biography</Book>
<Book Author="John Smith" Copyright="2006" Publisher="Bill & John's Publish Co.">John's Great
Biography</Book>
</Biographies>
</Books>

The following screen shot shows the settings in the XML File Changes view.

InstallShield 2020 User Guide ISP-2600-UG00 797

Chapter 4
Configuring the Target System

Figure 4-7: Settings for the Book Node

Example 3: Updating an Attribute’s Value

In example 3, the installation searches for the attribute that has the 2006 Copyright value (as shown in bold in the following
XML document) and replaces its value with a 2007 Copyright value:

<?xml version="1.0" encoding="UTF-8"?>

<Books>
<Biographies>
<Book Author="Bill Smith" Copyright="2007" Publisher="Bill & John's Publish Co.">Bill's Great
Biography</Book>
<Book Author="John Smith" Copyright="2006" Publisher="Bill & John's Publish Co.">John's Great
Biography</Book>
</Biographies>
</Books>

To update the value, the following XPath expression is added under the Biographies node in the XML File Changes view:

Book[@Copyright="2006"]

The following screen shot shows the settings in the XML File Changes view.

Figure 4-8: General Settings for the Attribute to Be Updated

798 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

See Also
Searching for XML Data
XML File Changes View

Using Windows Installer Properties to Dynamically Modify XML Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, and Transform projects, you can use a Windows Installer
property to specify an XML element, an attribute, an attribute value, or an element’s content. At run time, Windows
Installer uses MsiFormatRecord to resolve the property value, and it uses that value as the data in your XML file. This
enables you to use data that end users enter in dialogs, or other configuration information that is determined during the
installation, in your product’s XML files.

For example, your installation may include the SQL Login dialog, which lets end users select a SQL Server. The name of the
server that they select is typically stored in the IS_SQLSERVER_SERVER property. If you want an XML file to contain the name
of the SQL server that an end user selects, you can use this property, surrounded by brackets (that is,
[IS_SQLSERVER_SERVER]), when you configure your XML file changes in the XML File Changes view. Then at run time,
Windows Installer automatically replaces the property with its associated value.

Tip • Use a Windows Installer property for an element, an attribute, or element content only if the value of the property would
make a well-formed XML document. If a property value would lead to syntax errors in the XML document, your product or
installation may not behave as expected.

For example, if you set the name of an element to [INSTALLDIR]—a Windows Installer property whose value is a path on the
target system—the result at run time is an element name that contains backslashes. Element names cannot contain
backslashes, and XML documents that contain element names with backslashes are not valid.

Note • If test your XML file from within the XML File Changes view, any Windows Installer properties that are used for XML data
are not replaced with the appropriate values during testing. For more information about testing, see Testing Installation
Changes to an XML File or Testing Uninstallation Changes to an XML File.

InstallShield 2020 User Guide ISP-2600-UG00 799

Chapter 4
Configuring the Target System

Example
The following procedure demonstrates how to use the name of the SQL Server that an end user selects in the SQL Login
dialog as the content for one of the elements in your XML file. Note that you can substitute a hard-coded value with a
property for any of the elements, attributes, attribute values, or element content in the XML File Changes view. The
property that you specify in this view must be enclosed within square brackets, and the property name must be in all
uppercase letters; for example, [MYPROPERTY].

Task To use the name of the SQL Server that end users select as the content for an XML element:

1. Configure the SQL connection and any associated SQL scripts if you have not already done so, and determine the
name of the server property name:

a. In the View List under Server Configuration, click SQL Scripts.

b. Add a SQL connection and SQL scripts as needed. For instructions, see Configuring SQL Support.

c. In the SQL Scripts explorer, click the SQL connection.

d. Click the Advanced tab.

e. Note the name that is selected for the Target Server Property Name setting. The default value is typically
IS_SQLSERVER_SERVER.

2. In the View List under System Configuration, click XML File Changes.

3. In the XML Files explorer, select the element to which you want to add content.

4. Select the Advanced tab.

5. Select the Set element content check box.

6. In the Content box, type the name that is selected in step 1e, and enclose it within brackets. For example:

[IS_SQLSERVER_SERVER]

7. Build your release.

See Also
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties

Using InstallScript Text Substitution to Dynamically Modify XML Files

InstallShield 2020

Project • This information applies to InstallScript projects.

For InstallScript projects, you can use a text substitution string variable for an XML element, an attribute, an attribute
value, or an element’s content. When the XML file changes occur at run time, the InstallScript run-time code uses the
TextSubSubstitute function to replace the string variable with the appropriate value. This enables you to use data that
end users enter in dialogs, or other configuration information that is determined during the installation, in your product’s
XML files.

800 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Tip • Use text substitution for an element, an attribute, or element content only if the value of the property would make a
well-formed XML document. If a property value would lead to syntax errors in the XML document, your product or installation
may not behave as expected.

For example, if you set the name of an element to a text substitution string variable that will be replaced with text that
includes one or more spaces, end users may have problems with your product or your installation. Element names cannot
contain spaces, and XML documents that contain element names with spaces are not valid.

Note • If test your XML file from within the XML File Changes view, any text substitution string variables that are used for XML
data are not replaced with the appropriate values during testing. For more information about testing, see Testing Installation
Changes to an XML File or Testing Uninstallation Changes to an XML File.

Example
The following procedure demonstrates how to use the name of the SQL Server that an end user selects in the SQL Login
dialog as the content for one of the elements in your XML file. Note that you can substitute a hard-coded value with a text
substitution string variable for any of the elements, attributes, attribute values, or element content in the XML File Changes
view. The string variable that you specify in this view must be enclosed within angle brackets; for example,
<MYPROPERTY>. The string variable that you specify is case-sensitive.

Task To use the name of the SQL Server that end users select as the content for an XML element:

1. Configure the SQL connection and any associated SQL scripts if you have not already done so:

a. In the View List under Server Configuration, click SQL Scripts.

b. Add a SQL connection and SQL scripts as needed. For instructions, see Configuring SQL Support.

2. In the View List under System Configuration, click XML File Changes.

3. In the XML Files explorer, select the element to which you want to add content.

4. Select the Advanced tab.

5. Select the Set element content check box.

6. In the Content box, type the following:

<MYPROPERTY>

7. In the View List under Behavior and Logic, click InstallScript.

8. Find the dialog code in the OnSQLLogin event for the SQL Login dialog that contains the SQL Server control, and add a
call to the InstallScript function TextSubSetValue. For example:

// Display login dialog (without connection name)

// COMMENT OUT TO SWAP DIALOGS
nResult = SQLServerSelectLogin2( szConnection, szServer, szUser, szPassword, bWinLogin, szDB, FALSE,
TRUE );
TextSubSetValue("<MYPROPERTY>", szServer, TRUE);

9. Build your release.

InstallShield 2020 User Guide ISP-2600-UG00 801

Chapter 4
Configuring the Target System

See Also
Text Substitutions

Using Reserved Characters (<, >, &, ', and ") Inside Elements
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

If you use a reserved character such as a less than symbol (<) inside an XML element, the MSXML parser converts it at run
time on target systems to its predefined entity (&lt;). Using the less than symbol instead of its entity would generate an
error because XML parsers would interpret it as the start of a new element, and it would result in invalid XML code. Note
that if you open the resulting XML file in a browser such as Internet Explorer, the character—not its entity—is displayed
inside the XML element.

The following table lists the reserved XML characters and their entity equivalents. The table also indicates whether each
reserved character is replaced by its entity at run time.

Table 4-8 • Reserved Characters and Their Predefined Entities

Character Entity Description Notes

< &lt; Less than This character cannot be used as content in an XML element
because it is reserved to be used to indicate the start of an XML
element.

This character is automatically replaced by its entity at run time.

> &gt; Greater than This character is automatically replaced by its entity at run time.

& &amp; And This character cannot be used as content in an XML element
unless it indicates the start of an entity.

If this character is used as content in an XML element but it does

not indicate the start of an entity, it is automatically replaced by
its entity at run time.

’ &apos; Apostrophe This character is not automatically replaced by its entity at run
time.

" &quot; Quotation mark This character is not automatically replaced by its entity at run
time.

802 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

See Also
Adding an Attribute to an Element
Adding Content to an Element
XML File Changes View

Using Namespaces in XML Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

XML namespaces provide a method for avoiding element name conflicts. When you are specifying XML file changes in
InstallShield, you can specify the namespace mappings that should be declared in the XML file and then specify namespace
prefixes for any of the file’s elements.

Tip • If you use the Import XML Settings Wizard to import an XML file into the XML File Changes view, InstallShield imports any
namespaces that are declared for the file.

See Also
Namespace Tab for an XML File
XML File Changes View

Declaring Namespace Mappings for an XML File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

You can declare namespace mappings for an XML file in the XML File Changes view.

InstallShield 2020 User Guide ISP-2600-UG00 803

Chapter 4
Configuring the Target System

Task To declare a namespace mapping for an XML file:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, click the XML file that should contain the namespace.

3. Click the Namespace tab.

4. Click a row in the table to add a new namespace.

5. In the Prefix column, type the prefix that should be used for any elements that are associated with the corresponding
namespace.

6. In the URI column, type a URL or a string of characters that identifies the Internet resource.

See Also
Namespace Tab for an XML File
XML File Changes View

Adding a Namespace Prefix to an Element

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

If you have declared a namespace mapping for an XML file, you can associate any element in the file with that namespace
by adding the corresponding prefix to the element.

Task To add a namespace prefix to an element:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, right-click the element to which you want to add a prefix and then do one of the following:

• To add a prefix to only the selected element, point to Namespace Prefix, and then click to the appropriate
namespace mapping.

• To add a prefix to the element and all of its subelements, point to Namespace Prefix (include all subelements),
and then click to the appropriate namespace mapping.

InstallShield adds the prefix to the element (and all of its subelements, if appropriate) in the XML Files explorer.

804 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Tip • You can also add a namespace prefix by right-clicking an element, clicking Rename, and adding the prefix and the colon
(:) before the element name.

See Also
XML File Changes View

Adding a Namespace Prefix to an Attribute

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

If you have declared a namespace mapping for an XML file, you can associate any attribute in the file with that namespace
by adding the corresponding prefix to the attribute.

Task To add a namespace prefix to an attribute:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, click the element that contains the attribute.

3. In the right pane, click the General tab.

4. In the grid, double-click the attribute to which you want to add the prefix, and then place the cursor at the start of the
attribute name.

5. Add the prefix and a colon (:) before the attribute name.

See Also
XML File Changes View

Removing a Namespace Prefix from an Attribute

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 805

Chapter 4
Configuring the Target System

• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

Task To remove a namespace prefix from an attribute:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, click the element that contains the attribute.

3. In the right pane, click the General tab.

4. In the grid, double-click the attribute from which you want to remove the prefix, and then place the cursor at the start
of the attribute name.

5. Delete the prefix and a colon (:) before the attribute name.

See Also
XML File Changes View

Removing a Namespace Prefix from an Element

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

Task To remove a namespace prefix from an element:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, right-click the element whose prefix you want to remove, and then do one of the following:

• To remove the prefix from only the selected element, point to Namespace Prefix, and then click <None>.

• To remove the prefix from the element and all of its subelements, point to Namespace Prefix (include all
subelements), and then click <None>.

InstallShield removes the prefix from the element (and all of its subelements, if appropriate) in the XML Files explorer.

806 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

See Also
XML File Changes View

Removing Namespace Mappings from an XML File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

Task To remove a namespace mapping from an XML file:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, click the XML file that contains the namespace that you want to remove.

3. Click the Namespace tab.

4. Click the row that contains the namespace mapping that you want to remove, and then click the Delete button.

InstallShield removes the namespace from the table.

See Also
Namespace Tab for an XML File
XML File Changes View

Testing Installation Changes to an XML File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

InstallShield 2020 User Guide ISP-2600-UG00 807

Chapter 4
Configuring the Target System

InstallShield enables you to test just the XML file changes that are configured for your project through the XML File Changes
view without requiring you to build and run your entire installation. When you test the installation changes, InstallShield
uses the latest version of MSXML that you have on your machine to parse the XML file and execute the XPath expressions
that you configured. When MSXML finds an area of the XML file that matches the XPath expression, the changes that were
configured in the XML File Changes view are made.

Note • If your XML file changes include Windows Installer properties or InstallScript text substitutions, they are not replaced
with the appropriate values during testing.

Task To test installation changes to an XML file:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, right-click the XML file that you want to test and then click Test XML File Install Changes.
The Select Test XML File dialog box opens.

3. In the File name box, select the target file to which you want the installation changes applied, or specify a new target
file name and location:

• If you are modifying an XML file that is installed as part of your installation, select a copy of that file. (Do not select
the actual file in your installation because testing the XML installation changes would modify it.)

• If you are modifying an XML file that already exists on the target system, select a copy of that file.

• To test what happens if the XML file does not exist at run time and it is not installed as part of your installation,
specify a new file name and location.

The default file name is the name of the test file that you right-clicked in step 2.

4. Click Open.

If the target file already exists, InstallShield applies the changes from the test file to the target file. If the target file that you
specified does not exist and the Always create XML file if it does not already exist check box is selected on the Advanced
tab for the XML file, InstallShield creates the file and applies the changes from the test file.

InstallShield displays details about the installation test on the Results tab of the Output window. The details include a
hyperlink to the test file.

Tip • If the target file is open in a browser window when you perform the testing, you may need to refresh the browser to see
the test changes.

See Also
Using Windows Installer Properties to Dynamically Modify XML Files
Using InstallScript Text Substitution to Dynamically Modify XML Files
XML File Changes View

808 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Testing Uninstallation Changes to an XML File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

After you have tested the XML file installation changes that you have configured through the XML File Changes view, you
may want to test the XML file changes that occur during uninstallation. This enables you to determine whether the changes
that you configured behave as you expected during uninstallation.

When you test the uninstallation changes, InstallShield uses the latest version of MSXML that you have on your machine to
parse the XML file and execute the XPath expressions that you configured. When MSXML finds an area of the XML file that
matches the XPath expression, the changes that were configured in the XML File Changes view are made.

Note • If your XML file changes include Windows Installer properties or InstallScript text substitutions, they are not replaced
with the appropriate values during testing.

Task To test uninstallation changes to an XML file:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, right-click the XML file that you want to test and then click Test XML File Uninstall Changes.
The Select Test XML File dialog box opens.

3. In the File name box, select the target file to which you want the uninstallation changes applied.

The default value is the name of the file whose installation changes you last tested.

4. Click Open.

InstallShield applies the uninstallation changes that are configured in the XML File Changes view to the test file.

InstallShield displays details about the uninstallation test on the Results tab of the Output window. The details include a
hyperlink to the test file. Note that if you have configured the XML file to be removed during uninstallation, the hyperlink
may not work, since the file may no longer be present.

Tip • If the target file is open in a browser window when you perform the testing, you may need to refresh the browser window
to see the test changes.

InstallShield 2020 User Guide ISP-2600-UG00 809

Chapter 4
Configuring the Target System

See Also
XML File Changes View

Removing an Element or an XML File from the XML File Changes View
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

Task To remove an element or an XML file from the XML File Changes view:

1. In the View List under System Configuration, click XML File Changes.

2. In the XML Files explorer, right-click the XML file or XML element that you want to remove and click Delete.

If you delete an XML file, InstallShield displays a message that explains that the component associated with the XML file will
be deleted along with the file itself.

See Also
XML File Changes View

Modifying Text Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes string functions for
finding and modifying string variables and literals. You can use these functions in InstallScript projects.

810 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

InstallShield enables you to configure search-and-replace behavior for content in text files—for example, .txt, .htm, .xml,
.config, .ini, and .sql files—that you want to modify at run time on the target system. The text files can be part of your
installation, or they can be files that are already present on target systems.

The Text File Changes view is where you define the changes that you want to be made to the text files. This view lets you do
the following:

• Add one or more text change sets to your project. A text change set is a reference to one or more text files that you
want to search at run time.

• Add one or more text change items to a text change set. A text change item identifies the search-and-replace criteria.

Task To configure text file changes:

1. Create a text change set.

2. Specify the change for the text file.

For more information on how to modify a text file at run time, consult this section of the documentation.

See Also
Specifying the Code Page that Should Be Used for Opening ANSI Text Files
Text File Changes View

Creating a Text Change Set

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes string functions for
finding and modifying string variables and literals. You can use these functions in InstallScript projects.

The first step in configuring text file changes is to create a reference to the file (or files) that you would like to edit; this
reference is called a text change set. The file can be any non-binary file—for example, a .txt, .htm, .xml, .config, .ini, or .sql
file. The file can be part of your installation (that is, one that you added to your project in the Files and Folders view), or it
can be a file that is already present on target systems.

Note • Each text change set must be associated with a component in your project. Therefore, before you can create a text
change set, your project must have at least one component. If no components exist when you are creating a text change
reference, the Create a New Component dialog box is displayed, enabling you to create a component.

InstallShield 2020 User Guide ISP-2600-UG00 811

Chapter 4
Configuring the Target System

Task To create a text change set to reference one or more text files that you want to change at run time:

1. In the View List under System Configuration, click Text File Changes.

2. Right-click the Text File Changes explorer and then click Add Change Set.

InstallShield adds a new change set with a default name.

3. Enter a new name, or right-click it later and click Rename to give it a new name.

The name is not displayed at run time; it is an internal name that is used to differentiate between various change sets
in your project.

4. In the right pane, configure the settings for the change set. For details about each setting, see Change Set Settings.

After you have created a reference to a text file and configured its settings, you can move on to the next step, which is to
specify the search-and-replace criteria.

Tip • You can use Windows Installer public properties to specify the names of the text files that you want to include in or
exclude from your search. This enables you to use data that end users enter in dialogs, or other configuration information that
is determined at run time, when your product’s text files are modified at run time. To learn more, see Using Windows Installer
Properties to Dynamically Modify Text Files.

See Also
Specifying the Code Page that Should Be Used for Opening ANSI Text Files
Text File Changes View

Specifying a Change for a Text File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes string functions for
finding and modifying string variables and literals. You can use these functions in InstallScript projects.

Once you have specified the text file that you would like to edit, you can move onto the next step of configuring text file
changes: specifying the search-and-replace criteria. Each set of criteria is known as a change item.

812 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Task To specify the change that you want to be made for a text file:

1. In the View List under System Configuration, click Text File Changes.

2. In the Text File Changes explorer, right-click the change set item whose text changes you want to define, and then
click Add Change.

InstallShield adds a new change item with a default name.

3. Enter a new name, or right-click it later and click Rename to give it a new name.

The name is not displayed at run time; it is an internal name that is used to differentiate between various change items
in your project.

4. In the right pane, configure the settings for the change. For details about each setting, see Change Set Settings.

To modify additional strings in the text file, add additional change items to the change set in this view—one for each string
change.

Tip • You can use Windows Installer public properties to specify the search strings and the replacement strings. This enables
you to use data that end users enter in dialogs, or other configuration information that is determined at run time, when your
product’s text files are modified at run time. To learn more, see Using Windows Installer Properties to Dynamically Modify Text
Files.

See Also
Text File Changes View

Changing the Order in Which Text File Changes Are Made

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes string functions for
finding and modifying string variables and literals. You can use these functions in InstallScript projects.

Text file changes are made on the target system in the order in which they are listed in the Text File Changes view.

InstallShield 2020 User Guide ISP-2600-UG00 813

Chapter 4
Configuring the Target System

Task To change the order in which text file changes are made at run time:

1. In the View List under System Configuration, click Text File Changes.

2. In the Text File Changes explorer, right-click one of the change set items or change items that you want to move, and
then click either Move Up or Move Down.

Repeat the last step until all of the text file changes are correctly sorted.

See Also
Text File Changes View

Using Windows Installer Properties to Dynamically Modify Text Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes string functions for
finding and modifying string variables and literals. You can use these functions in InstallScript projects.

You can use a Windows Installer property to specify text strings for which you are searching or modifying. You can also use
a property to specify the text files that you are including or excluding in your search.

At run time, Windows Installer uses MsiFormatRecord to resolve the property value, and it uses that value to modify your
text file. This enables you to use data that end users enter in dialogs, or other configuration information that is determined
at run time, when your product’s text files are modified at run time.

Example
The following procedure demonstrates how to let end users specify during installation an IP address that must be written
to an XML-based web.config file at run time. The web.config file is installed with the product to INSTALLDIR, and it
contains XML such as the following:

<?xml version="1.0" encoding="UTF-8"?>

<configuration>
<appSettings>
<add key="IP Address" value="default" />
</appSettings>
</configuration>

The default value in bold must be replaced by the IP address that an end user enters.

814 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Note that you can substitute a hard-coded value with a property for the following change set settings in the Text File
Changes view:

• Include Files

• Exclude Files

In addition, you can use a property for the following change item settings in the Text File Changes view:

• Find What

• Replace With

• Insert Text

The property that you specify in any of these settings must be enclosed within square brackets, and the property name
must be all uppercase; for example, [MYPROPERTY].

Step 4 of the procedure is slightly different, depending on the project type, since Windows Installer controls the user
interface of Basic MSI installations, and the InstallScript engine controls the user interface of InstallScript MSI installations.

Task To let end users specify the IP address:

1. In the View List under System Configuration, click Text File Changes.

2. Add and configure a change set item, which identifies the file for which you want the installation to search:

a. Right-click the Text File Changes explorer and then click Add Change Set.

InstallShield adds a new change set item. Steps 2b through 2d explain how to configure its settings, which are
displayed in the right pane.

b. In the Target Folder setting, select the [INSTALLDIR] directory property.

c. In the Include Files setting, enter the following:

web.config

d. Leave the default values for the other settings.

3. Add and configure a change item, which identifies the search-and-replace criteria:

a. In the Text File Changes explorer, right-click the change set item that you created in step 2, and then click Add
Change.

InstallShield adds a new change item. Steps 3b through 3e explain how to configure its settings, which are
displayed in the right pane.

b. In the Action setting, select Replace.

c. In the Find What setting, enter the following:

<add key="IP Address" value="default"

d. In the Replace With setting, enter the following:

<add key="IP Address" value="[MYPROPERTY]"

e. Leave the default values for the other settings.

4. Use the property in a dialog. This part of the procedure depends on which project type you are using.

InstallShield 2020 User Guide ISP-2600-UG00 815

Chapter 4
Configuring the Target System

• For Basic MSI projects:

a. In the View List under User Interface, click Dialogs.

b. In the Dialogs explorer, expand the All Dialogs folder, and click the language under the dialog that should
contain the User Name control. As an alternative, you can add a new dialog.

c. Add an Edit Field control to the dialog, and set its Property property to the following:

MYPROPERTY

• For InstallScript MSI projects:

a. In the View List under Behavior and Logic, click InstallScript.

b. Find the dialog code in the OnFirstUIBefore event for the dialog that should contain the User Name control,
and add a call to the Windows Installer API function MsiSetProperty. For example, if you want end users to
enter the IP address in an edit box on the SdShowDlgEdit1 dialog that you have added to your project, you
would add an MsiSetProperty call as shown in the following lines of code:

Dlg_SdShowDlgEdit1:
nResult = SdShowDlgEdit1 (szTitle, szMsg, szField1, svEdit1);
MsiSetProperty (ISMSI_HANDLE, "MYPROPERTY", svEdit1);
if (nResult = BACK) goto Dlg_SdWelcome;

5. Build your release.

Tip • If you are creating a multilanguage project and you want to use a property that can have different values based on the
language that your installation uses, you can use a localizable property. For more information, see Creating a Localizable
Property.

See Also
MsiFormatRecord (Windows Installer Help Library)
MsiFormatRecord (Windows Installer Help Library)
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
Working with Dialogs in Basic MSI Projects
Working with Dialogs in InstallScript and InstallScript MSI Projects
Dialog Functions
Dialog Customization Functions

Specifying the Code Page that Should Be Used for Opening ANSI Text Files
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

816 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

This information does not apply to InstallScript projects; however, the InstallScript language includes string functions for
finding and modifying string variables and literals. You can use these functions in InstallScript projects.

When an installation opens an ANSI text file to make the changes that are configured in the Text File Changes view, the
installation uses the code page that is specified in the CodePage column of the ISSearchReplaceSet table of your project.
The default value of this column is the number 0, which is CP_ACP, the code page that is currently configured to be the
system Windows ANSI code page on the target system. You can use the Direct Editor view to override this value with a
specific code page.

CodePage column is of 2-byte (signed). In order to provide a CodePage value greater than 32,767, you have to provide in
the form of 2's complement.

For example:

Name Identifier CodePage

UTF-8 65001 -535

UTF-7 65000 -536

Windows-1252 1252 1252

Task To override the default code page that should be used to open an ANSI text file:

1. In the View List under Additional Tools, click Direct Editor.

2. In the Tables explorer, click the ISSearchReplaceSet table. InstallShield displays the table in the right pane.

3. In the grid, find the row that corresponds with the change set item whose code page you want to configure.

The ISSearchReplaceSet column in this grid shows all of the names of the change sets that are available in the Text
File Changes explorer in the Text File Changes view.

4. Change the value of the CodePage field in the appropriate row.

See Also
Direct Editor
Text File Changes View

Removing a Change Item or a Change Set from the Text File Changes View
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 817

Chapter 4
Configuring the Target System

• MSI Database
• Transform

This information does not apply to InstallScript projects; however, the InstallScript language includes string functions for
finding and modifying string variables and literals. You can use these functions in InstallScript projects.

If you no longer want a particular change to be performed to a text file, you can remove its change item from the Text File
Changes view. In addition, if you no longer want a file or group of text files to be searched, you can remove the
corresponding change sets from the Text File Changes view.

Task To remove a change item or a change set from the Text File Changes view:

1. In the View List under System Configuration, click Text File Changes.

2. In the Text File Changes explorer, right-click the change set item or change item that you want to remove, and then
click Delete.

InstallShield removes the item from the Text File Changes view.

See Also
Text File Changes View

Scheduling Tasks
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

You can have your installation create and configure automated tasks through the Windows task scheduler at run time on
target systems. The scheduled tasks can launch files that are part of your installation, or files that are already present on
target systems.

See Also
Adding a Scheduled Task
Scheduled Tasks View

818 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Adding a Scheduled Task

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

Note • Each scheduled task must be associated with a component in your project. Therefore, before you can add a scheduled
task, your project must have at least one component. If no components exist when you are adding a scheduled task, the Create
a New Component dialog box is displayed, enabling you to create a component.

Task To add a scheduled task to your project:

1. In the View List under System Configuration, click Scheduled Tasks.

2. Right-click the Scheduled Tasks explorer and then click Add Scheduled Task. InstallShield adds a new task with a
default name.

3. Enter a new name, or right-click it later and click Rename to give it a new name.

The name is not displayed at run time; it is an internal name that is used to differentiate between various scheduled
tasks in your project.

4. In the right pane, configure the settings for the task. For details about each setting, see Scheduled Tasks Settings.

See Also
Scheduled Tasks View

Using Windows Installer Properties to Dynamically Configure a Scheduled

Task
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database

InstallShield 2020 User Guide ISP-2600-UG00 819

Chapter 4
Configuring the Target System

• Transform

You can use a Windows Installer property to specify information such as the account information that should be used to
run the file that a scheduled task launches.

At run time, Windows Installer uses MsiFormatRecord to resolve the property value, and it uses that value to configure
your scheduled task. This enables you to use data that end users enter in dialogs, or other configuration information that is
determined at run time, when your product’s scheduled tasks are created at run time.

Example
The following procedure demonstrates how to let end users specify during installation an account and password that
should be used to run the scheduled task. The properties that you specify must be enclosed within square brackets, and
the property names must be all uppercase; for example, [MYPROPERTY].

Step 4 of the procedure is slightly different, depending on the project type, since Windows Installer controls the user
interface of Basic MSI installations, and the InstallScript engine controls the user interface of InstallScript MSI installations.

Task To let end users specify account and password information for the scheduled task:

1. In the View List under System Configuration, click Scheduled Tasks.

2. In the Scheduled Tasks explorer, select the task that you want to configure.

3. In the Run As setting, enter the following:

[DOMAINNAME]\[USERNAME]

4. In the Password setting, enter the following:

[PASSWORD]

5. Use the properties in a dialog. This part of the procedure depends on which project type you are using.

• For Basic MSI projects:

a. In the View List under User Interface, click Dialogs.

b. In the Dialogs explorer, expand the All Dialogs folder, and click the language under the dialog that should
contain Domain Name, User Name, and Password controls. As an alternative, you can add a new dialog.

c. Add an Edit Field control to the dialog, and set its Property property to the following:

DOMAINNAME

d. Repeat step 5c for the USERNAME and PASSWORD properties.

• For InstallScript MSI projects:

a. In the View List under Behavior and Logic, click InstallScript.

b. Find the dialog code in the OnFirstUIBefore event for the dialog that should contain the Domain Name, User
Name, and Password controls, and add a call to the Windows Installer API function MsiSetProperty. For
example, if you want end users to enter the information in edit boxes on the SdShowDlgEdit3 dialog that
you have added to your project, you would add MsiSetProperty calls as shown in the following lines of
code:

Dlg_SdShowDlgEdit3:

820 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

nResult = SdShowDlgEdit3
(szTitle, szMsg, szField1, szField2, szField3, svEdit1, svEdit2, svEdit3);
MsiSetProperty (ISMSI_HANDLE, "DOMAINNAME", svEdit1);
MsiSetProperty (ISMSI_HANDLE, "USERNAME", svEdit2);
MsiSetProperty (ISMSI_HANDLE, "PASSWORD", svEdit3);
if (nResult = BACK) goto Dlg_SdWelcome;

6. Build your release.

See Also
Scheduled Tasks View

Removing a Scheduled Task

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• Transform

Task To remove a scheduled task from your project:

1. In the View List under System Configuration, click Scheduled Tasks.

2. In the Scheduled Tasks explorer, right-click the task that you want to remove and then click Delete.

InstallShield removes the task from your project.

See Also
Scheduled Tasks View

Installing, Controlling, and Configuring Windows Services

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database

InstallShield 2020 User Guide ISP-2600-UG00 821

Chapter 4
Configuring the Target System

• MSM Database
• Transform

Windows services are executable files that Windows–based systems run in the background to manage various system
tasks, even if no user is currently logged in. A service is an executable file, but it must be designed as a service; you cannot
automatically use an arbitrary executable file as a service. Windows services can be installed to run every time that the
system starts or on demand when needed. InstallShield enables you to install new Windows services and configure existing
services. Windows has a Services administrative tool with which you can view and configure the services that are installed
on a system.

You can use the Services view to configure a component that installs, starts, stops, or deletes a service during installation
or uninstallation. You can also use this view to configure extended service customization options that are available with
Windows Installer 5. As an alternative to using the Services view, you can use the Services area under the Advanced
Settings node of the Components view or the Setup Design view. If you configure service information in any of these areas,
the other areas are automatically updated accordingly.

Note the following details about working with services:

• The service that you are starting, stopping, deleting, or configuring can either be already present on the target system
during installation or uninstallation, or it can be installed as part of your installation.

• The service executable file should be the key file of its component. For more information, see Component Key Files.

• The Remote Installation setting for the service’s component must be set to Favor Local. For more information, see
Setting a Component’s Remote Installation Setting.

Tip • The View Filter at the top of the Services view lets you select a component or feature whose service data you want to
display in the view, and hide the ones whose service data you do not want to display in the view. The View Filter lists your
project’s hierarchy of features, subfeatures, and components.

Task To install, start, stop, delete, uninstall, or configure a service:

1. If your installation is installing the service, add the service executable file to a component in your project, and make it
the key file of the component. For more information, see Adding Files to Components.

If the service is already present on target systems, skip this step.

2. In the View List under System Configuration, click Services.

3. Right-click the Services node and then click Add Service. InstallShield adds a new service.

4. Type a new name for the service now, or click it and then press F2 later to rename it.

The name that you enter must match the name that is shown on the service’s Properties dialog box. (To access an
installed service’s properties: In the Services administrative tool, right-click the service and then click Properties.)

5. Select the service that you added, and then configure the settings that are displayed in the right pane as needed. For
information about each of the settings, see Services View.

Repeat the process for each service in this component’s key file.

Note • You must be familiar with the technical details of your service before you can configure its settings.

822 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Tip • If configuring the service fails at run time, the installation may fail with an error message. ICE102 validates some of the
service-related settings to help avoid such configuration failures. Therefore, it is recommended that you perform validation for
your release.

See Also
Services View

Creating Predetermined User Accounts at Run Time

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

InstallShield has support for creating one or more Windows user accounts in groups without using logon dialogs. This
support requires using three Windows Installer properties for the user account, group, and password of each account that
you want to be set up at run time.

Properties for Creating User Accounts

Use the following properties to create user accounts at run time:

• ISNetApiLogonUsername—Set the value of this property to the user account that you want the installation to create.
Use either of the following formats:

• MachineName\UserName

• DomainName\UserName

• ISNetApiLogonGroup—Set the value of this property to the group to which you want the user account to belong.

• ISNetApiLogonPassword—Set the value of this property to the password that you want to be configured for the user
account.

To configure the required properties and their values, use the Properties view. For instructions on how to do this, see
Creating Properties in Windows Installer–Based Projects.

Guidelines for Creating User Accounts

To create more than one user account, separate each entry for the ISNetApiLogonUsername property value with a tilde
that is enclosed in square brackets: [~]. For example, to create a user named User1 on a domain named Domain1 and a
user named User2 on a machine named Machine2, use the following format:

Domain1\User1[~]Machine2\User2

Each user account that you specify for the ISNetApiLogonUsername property must have a corresponding group in the
ISNetApiLogonGroup property and a corresponding password in the ISNetApiLogonPassword property. If these three
properties do not have the same number of entries, a run-time error occurs.

InstallShield 2020 User Guide ISP-2600-UG00 823

Chapter 4
Configuring the Target System

The following table shows sample properties and their corresponding values for the creation of three different user
accounts:

Table 4-9 • Properties for User Accounts and Groups

Property Name Property Value

ISNetApiLogonUsername Domain1\User1[~]Domain1\User2[~]Domain2\User3

ISNetApiLogonGroup Users[~]Users[~]Administrators

ISNetApiLogonPassword Password1![~]Password1![~]Password1!

In this example, User1 is part of the Users group and has a password of Password1! for the Domain1 domain. User2 is part
of the Users group and has a password of Password1! for the Domain1 domain. User3 is part of the Administrators group
and has a password of Password1! for the Domain2 domain.

The ISNetApiLogonUsername, ISNetApiLogonGroup, and ISNetApiLogonPassword properties are formatted properties.

Thus, the value of these properties can be a different property, an environment variable, a file path, or a component
directory path. For example:

• [PROPERTYNAME]—At run time, this resolves to the value of the specified property.

• [%EnvironmentVariable]—At run time, this resolves to the value of the specified environment variable.

• [#FileKey]—At run time, this resolves to the full path of the file that has the specified file key in the File table.

• [$ComponentName]—At run time, this resolves to the installation location of the specified component.

See Also
Adding the Ability to Create or Set an Existing User Account

Per-User vs. Per-Machine Installations

InstallShield 2020

Project • This information applies to Basic MSI projects.

Two Windows Installer properties, along with the current user’s privileges, affect where the configuration information such
as your product’s shortcuts and registry entries are stored on a target machine—to the All Users profile or the current user’s
profile:

• ALLUSERS determines where the configuration information is stored.

• MSIINSTALLPERUSER indicates that the Windows Installer should install the package for only the current user.

The MSIINSTALLPERUSER property is available with Windows Installer 5 and on Windows 7 or Windows Server 2008 R2.
Earlier versions of Windows Installer and Windows ignore this property.

You can set the ALLUSERS and MSIINSTALLPERUSER properties for your project through the Property Manager. You can also
set these properties using the following methods:

• At the command line

824 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

• Through a custom action

• In the CustomerInformation and ReadyToInstall dialogs

ALLUSERS, MSIINSTALLPERUSER, and Windows 7 or Windows Server 2008 R2

If the ALLUSERS property is set to 2 and MSIINSTALLPERUSER is set to 1, the Windows Installer performs a per-user
installation.

During a per-machine installation, the Windows Installer requires elevated privileges, and it directs files and registry
entries to per-machine locations. If User Account Control (UAC) is available on the target system, a per-machine
installation typically prompts for consent or credentials, depending on the access level of the user. During a per-user
installation, the Windows Installer does not prompt for credentials, and it redirects files and registry entries to per-user
locations.

For more information, see Single Package Authoring on the MSDN Web site.

Effects of ALLUSERS on Windows Vista and Later

Custom actions that have an in-script execution setting of deferred in system context are used to perform an action with
the rights granted to the LocalSystem account on Windows, since the Windows Installer service runs in the system context.
Actions not marked as deferred in system context run with user impersonation and have the rights that the user who
launches the installation has.

When a per-user installation (that is, one where ALLUSERS is not set) is run, deferred-in-system-context actions run in the
same context in which normal deferred or immediate custom actions run, which is with user impersonation. This can
potentially cause a run-time issue with the custom action in the following circumstances:

• The user who launches the Windows Installer installation is not an administrator; or the user is running the installation
on Windows Vista or later, the user is part of the Administrators group, and the user does not have administrator
privileges by default.

• The custom action attempts to modify a resource in a per-machine location on the machine, such as a file in the
Program Files folder, or a registry key or value in HKEY_LOCAL_MACHINE.

While this may not be an issue with Windows XP or earlier versions of Windows, Windows Vista and later do not give users
full administrator privileges by default. Therefore, since a deferred-in-system-context action runs with user impersonation
when ALLUSERS is not set, the custom action could fail.

The recommended method for preventing this behavior is to specify that a per-machine installation should always be
performed by setting ALLUSERS to 1 in the Property Manager. Per-machine installations are generally easier to manage than
per-user installations.

Default Value of ALLUSERS

The ALLUSERS property is set to 1 by default in all Basic MSI projects. If you configure your installation so that it can be
installed per user without administrative privileges, you may want to consider changing the value of the ALLUSERS property
or removing this property from your project.

Default Controls on the ReadyToInstall Dialog

Use the Show Per-User Option setting in the General Information view to specify whether you want to give end users the
option of installing your product for all users or for only the current user. Available options for the Show Per-User Option
setting are:

InstallShield 2020 User Guide ISP-2600-UG00 825

Chapter 4
Configuring the Target System

• No—InstallShield does not set any related properties. At run time, the ReadyToInstall dialog does not include the
buttons that let end users specify how they want to install the product. This is the default value.

• Yes—InstallShield sets the ISSupportPerUser property equal to 1.

If the following conditions are true at run time, the ReadyToInstall dialog includes the per-user and per-machine buttons:

• The ISSupportPerUser property is equal to 1.

• The target system has Windows 7 or later, or Windows Server 2008 R2 or later.

• The product is not already installed on the target system.

The buttons on the ReadyToInstall dialog let end users specify how they want to install the product. If elevated privileges
are required, the shield icon is included on the all-users button. If an end user selects the per-user button, the ALLUSERS
property is set to 2, and the MSIINSTALLPERUSER property is set to 1. If an end user selects the all-users button, the
ALLUSERS property is set to 1, and the MSIINSTALLPERUSER property is not set.

Note • Selecting No for the Show Per-User Option setting in the General Information view does not prevent end users from
setting MSIINSTALLPERUSER from the command line when they run your installation. If your installation does not support this,
you may want to add a launch condition or other run-time check to prevent this from occurring.

Default Controls on the CustomerInformation Dialog

By default, the CustomerInformation dialog in all Basic MSI projects does not display the radio button group that enables
end users to specify whether they want to install the product for all users or for only the current user. This is the
recommended implementation for this dialog.

Task To display the radio button group that lets end users set ALLUSERS from the CustomerInformation dialog:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, under All Dialogs, expand the CustomerInformation dialog, and then click Behavior.
InstallShield displays the list of controls for the CustomerInformation dialog.

3. At the bottom of the lower-right pane, click the Conditions tab. In the upper-right pane, InstallShield displays the
conditions for the selected control.

4. In the list of controls, click DlgRadioGroupText. InstallShield displays this control’s conditions in the upper-right
pane.

5. In the upper-right pane, right-click the row that contains the condition whose value is 1 and whose action is Hide, and
then click Delete.

6. Repeat steps 4 and 5 for the RadioGroup control.

See Also
Creating Properties in Windows Installer–Based Projects
SdCustomerInformation
SdCustomerInformationEx
ALLUSERS Property (Windows Installer Help Library)
ALLUSERS Property (Windows Installer Help Library)

826 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring the Target System

Running InstallScript Installations Without Administrative

Privileges
InstallShield 2020

Project • This information applies to InstallScript projects.

InstallShield enables you to create InstallScript installations that can be run by end users who do not have administrative
privileges. The proper locations of registry entries, folders, and Start Menu items are dynamically determined at run time.
The InstallScript system variable ALLUSERS is the key to such installations; if an installation is run by an end user who does
not have administrative privileges, ALLUSERS is initialized to FALSE, and assigning it a new value in the script has no effect.

Note the following details:

• Automatic registration of files (which are included in components that have Yes selected for the Self-Register setting)
requires administrative privileges.

• InstallScript objects typically require administrative privileges, since they usually install or register files in locations
that require administrative privileges.

• Installing a DIFx driver requires administrative privileges.

• Installing the Setup Player for a One-Click Install installation requires administrative privileges.

• Installing a Windows service requires administrative privileges.

• Connecting to a remote registry requires administrative privileges.

• If an end user who is not an administrator or power user attempts to maintain an InstallScript installation that was
installed when ALLUSERS was set to TRUE, the installation displays an error message during initialization. The error
message indicates that a user with administrator rights installed the product, and similar privileges are needed to
modify or uninstall the product.

See Also
ALLUSERS

InstallShield 2020 User Guide ISP-2600-UG00 827

Chapter 4
Configuring the Target System

828 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Customizing Installation Behavior

InstallShield 2020

An important aspect of creating an installation is customizing it for your end users’ needs. The “Customizing Installation
Behavior” section of the documentation discusses various features of InstallShield that help you extend the functionality of
your installation. For example, you may find it useful to create custom actions to add support for something not directly
supported by Windows Installer. Furthermore, you may set up custom actions to call any script that you write in the
InstallScript view’s script editor. Refer to this section of the documentation for more information on how you can
customize the installation behavior in your project.

Using InstallScript
InstallShield 2020

You can leverage the power and ease of InstallScript to extend the functionality of your installation package. The
InstallScript view includes a script editor pane for you to author your InstallScript code.

Project • You must have a file named Setup.rul in your project if you are using InstallScript. InstallScript and InstallScript
MSI projects contain a Setup.rul file by default. You must add a Setup.rul file in Basic MSI, DIM, and Merge Module projects if
you want to use InstallScript custom actions in these types of projects.

Using Event-Driven InstallScript in InstallScript and InstallScript MSI Projects

InstallScript and InstallScript MSI projects contain an event-driven script. When you use InstallScript in these project types,
many of the functions are logged for uninstallation.

Using InstallScript in Custom Actions

Basic MSI, DIM, and Merge Module Projects

In a Basic MSI, DIM, or Merge Module project, you can use custom actions to run InstallScript at run time. These project
types do not support event-driven script.

InstallScript MSI Projects

In an InstallScript MSI project, you can use an InstallScript custom action to extend functionality in an execute sequence
where the default event handlers are not scheduled appropriately for your installation’s needs.

Creating and Using Custom Actions

Task To author an InstallScript custom action and execute it in your installation:

1. Add a blank Setup.rul to your project in the InstallScript view if it does not already exist.

2. Write an entry-point function. Note that you cannot call an entry-point function in the User Interface sequence for an
InstallScript MSI installation project.

3. Compile the script.

InstallShield 2020 User Guide ISP-2600-UG00 829

Chapter 4
Customizing Installation Behavior

4. Create a custom action that calls your InstallScript function.

5. Invoke the InstallScript custom action by either including it in a sequence (InstallScript MSI, Basic MSI, and merge
module projects) or executing it as a control event (Basic MSI and merge module projects).

6. Debug if necessary.

Note • As with other custom actions, changes made to the system through InstallScript custom actions are not automatically
restored when the package is uninstalled. Because InstallScript custom actions are not logged and removed by the
uninstaller, you must write a corresponding custom action to uninstall any changes that your custom action makes.

See Also
Event Handlers
InstallScript View
InstallScript Functions that Are Logged for Uninstallation
Defining Sequences
InstallScript Limits
Working with the Script Editor Pane in Various Views

Overview of ISSetup.dll
InstallShield 2020

ISSetup.dll is a C++ MSI DLL that contains the full InstallScript scripting run-time engine. For InstallScript MSI, Basic MSI,
DIM, and Merge Module projects, ISSetup.dll executes InstallScript custom actions. For InstallScript projects,
ISSetup.dll must be in the Disk1 folder.

Your installation always uses the InstallScript scripting run-time engine with which it was built, even if more a more recent
version is installed on a target machine by another installation.

Important • Note the following information:

• ISSetup.dll allows you to add only 1,000 InstallScript custom actions to your InstallScript MSI, Basic MSI, DIM, or Merge
Module project. If your project includes more than 1,000 InstallScript custom actions, a build error is generated.
• The version of ISSetup.dll that is used for InstallScript projects is different than the one that is used in InstallScript MSI,
Basic MSI, DIM, and Merge Module projects. These two versions are not interchangeable.

See Also
Redistributable Files that Are Distributed with an InstallScript Installation
Upgrading Projects from InstallShield 11.5 or Earlier
InstallScript Limits

Script Files
InstallShield 2020

Project • This information applies to InstallScript projects.

830 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

When you create an installation project, InstallShield creates two script files and stores them in the Script Files folder of
your project folder.

• Setup.rul is created for global event handlers and exception handlers.

• FeatureEvents.rul is created for feature event handlers.

Initially, these two files are empty; the default event handlers defined by InstallShield do not appear in these files unless
you select them from within the InstallScript view in InstallShield. When you do so, they are inserted into the appropriate
script file and displayed in the script pane in the InstallScript view, where you can edit them.

Note that if you change the default feature event handler code in FeatureEvents.rul, you must put the following
statement in Setup.rul to include your changes in the installation:

#include "FeatureEvents.rul"

See Also
Working with the Script Editor Pane in Various Views
InstallScript Limits

Creating InstallScript Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

You must have a file named Setup.rul in your project if you are using InstallScript. InstallScript and InstallScript MSI projects
contain a Setup.rul file by default. You must add a Setup.rul file in Basic MSI, DIM, and Merge Module projects if you want to
use InstallScript custom actions in these types of projects.

Task To add a new InstallScript file to your project:

1. In the View List under Behavior and Logic, click InstallScript.

2. In the InstallScript explorer, right-click Files and click New Script File.

3. Name the file.

New script files are named Setup.rul by default. If you already have a file called Setup.rul, a new file is added with the
name Setupn.rul, where n is a successive number. You can rename the file by right-clicking it and then clicking Rename.

The new script file is placed in the Link To folder. InstallShield attempts to use a path variable in case you move your
project. You cannot edit the Link To value.

InstallShield 2020 User Guide ISP-2600-UG00 831

Chapter 4
Customizing Installation Behavior

You can also include additional header files (.h files) and script files. Repeat the above procedure to add a new script file to
your project.

See Also
InstallScript View
Predefined Path Variables
Working with the Script Editor Pane in Various Views
InstallScript Limits

Opening an InstallScript File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

Task To open a script file in your project so that you can edit it:

1. In the View List under Behavior and Logic, click InstallScript.

2. In the InstallScript explorer, click the file that you want to open.

See Also
Working with the Script Editor Pane in Various Views

Inserting and Importing Script Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

InstallShield enables you to reuse InstallScript files (.rul) and InstallScript header files (.h) in multiple projects. You can
insert or import script files into a project through the InstallScript view:

832 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• Inserting a script file creates a link to the script file in its current location.

• Importing a script file copies the script file to the folder containing the script files for your project. The script files that
you import can be stored somewhere on your system, or they can be stored in a repository.

InstallShield supports all path variable types that you define in the Path Variables view for the location of these script files.
However, it is important to be aware that a corresponding folder structure exists in your source code database so that your
source code control software can resolve paths.

Inserting Script Files

Task To insert a script file:

1. In the View List under Behavior and Logic, click InstallScript.

2. In the InstallScript explorer, right-click Files and then click Insert Script Files. The Open dialog box opens.

3. Select the InstallScript file (.rul) or InstallScript header file (.h) that you want to insert.

4. Click Open.

Importing Script Files

Task To import a script file:

1. In the View List under Behavior and Logic, click InstallScript.

2. In the InstallScript explorer, right-click Files and then click Import Script Files. The Import InstallScript Files dialog
box opens.

3. Do one of the following:

• In the Repository Items box, click the InstallScript file (.rul) or InstallScript header file (.h) that you want to add
to your project.

• If the script file that you want to import is not stored in the repository, click the Browse button to select it.

4. Click OK.

See Also
Debugging Scripts
Using a Repository to Share Project Elements
Working with the Script Editor Pane in Various Views

Compiling Scripts
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 833

Chapter 4
Customizing Installation Behavior

• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

You must compile your script before your InstallScript code can be called in your installation.

InstallShield searches only for a file named Setup.rul when compiling the script. You can include files with different
names, but they must be included in Setup.rul or in an include file with the #include preprocessor statement.

Task To compile your script, do one of the following:

• On the Build menu, click Compile.

• Click the Compile button on the toolbar.

• Press CTRL+F7.

Before compiling, InstallShield saves any changes that you have made to your script files. The compiler’s status, including
any error or warning messages, is displayed in the Output window. Double-click a compiler message to go to the line in
your script where the error was found.

If you compile your script file after making changes to it, it is not necessary to rebuild your release. Note that InstallShield
automatically compiles your script whenever you build a release.

If your script compiled successfully, InstallShield creates Setup.inx (the object code that the setup engine executes) and
streams it into your Windows Installer package when you build a release.

You may also need to uninstall the release that you previously ran to test your InstallScript custom action before you can
see the changes to the script.

You can set compiler options on the Compile/Link tab of the Settings dialog box.

See Also
Debugging Scripts
InstallScript Error Information
Working with Releases
InstallScript Limits

Debugging Scripts
InstallShield 2020

The InstallScript Debugger is useful for stepping through your InstallScript code and checking the progress of your code.

Before you can debug your script, you must first compile it, execute it as a custom action (if applicable), and build a release.

Task To debug your script directly from within InstallShield, do one of the following:

• On the Build menu, click Debug.

• Press F5.

834 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• Click the Debug button on the toolbar.

InstallShield will run the installation and open the InstallScript Debugger when the custom action is executed.

While you are in the InstallScript Debugger, press F1 at any point to view the InstallScript Debugger Help.

For information about debugging on a test system, see Debugging an Installation on any Computer.

See Also
Compiling Scripts

Using Preprocessor Statements to Debug the Script

InstallShield 2020

Use the #define and #ifdef statements to create an internal debugger in the script.

Task To deug a script by using the preprocessor statements:

1. Wherever you want to insert a debug statement in the script, start with the following #ifdef directive:

#ifdef DEBUG

2. On lines that follow that directive, type the debug statements.

3. On a separate line after the debug statements, type:

#endif

4. For debugging purposes, compile the following compiler setting:

DDEBUG=1

Here is an example of a debugging section using an #ifdef statement:

#ifdef DEBUG
if nResult < 0 then
WriteLine (LogFileHandle, "PlaceBitmap failed");
endif;
#endif

The InstallScript Debugger enables you to trace program execution and inspect variables as your installation executes.

Renaming an InstallScript File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object

InstallShield 2020 User Guide ISP-2600-UG00 835

Chapter 4
Customizing Installation Behavior

• Merge Module

Task To rename an InstallScript file:

1. In the View List under Behavior and Logic, click InstallScript.

2. In the InstallScript explorer, right-click the file and click Rename.

3. Type a new name for the file.

Project • InstallScript projects must contain a source file named Setup.rul; that file is the main compilation unit of an
installation script. If your InstallScript project does not include a script file with that name, error C8503 occurs when you
compile your script or build a release.

Using String Entries in Scripts

InstallShield 2020

You can use string identifiers in your script in place of any value that accepts a string literal. When the custom action is
executed, the installation replaces the string identifier with the corresponding string value for the language in which the
installation is running.

String identifiers must follow an at symbol (@) in your script. The Select String dialog box lets you browse the list of string
entries in your project. It also lets you modify string entries for the default language before inserting the selected string
identifier into your script.

For example, assuming your project contains a string identifier called MSG_ACTION_SUCCEEDED, you could display its
value in a message box as demonstrated below:

szMsg = @MSG_ACTION_SUCCEEDED;
nType = INFORMATION;
MessageBox (szMsg, nType);

See Also
Localizing the End-User Interface
String Editor View
How an Installation Determines Which Language to Use for the User Interface

Removing InstallScript Files from Projects

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object

836 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• Merge Module

When you remove a script file from your installation, you are deleting the reference to that file from your project, but not
the file itself. If you later decide to insert it into your installation, you do not need to rewrite your script.

Note that the script file may, in fact, still be compiled if it is included in another file.

Task To remove InstallScript files from your project:

1. In the View List under Behavior and Logic, click InstallScript.

2. In the InstallScript explorer, right-click the file and click Remove.

Caution • You cannot rename a file to the name of an existing file under the project location, even if the script file has been
removed through the above procedure. For example, assume you have a script file called Setup.rul in your project. Next,
remove that file and add a new script file, called Script1.rul by default. You cannot rename Script1.rul to Setup.rul,
because doing so would overwrite the first Setup.rul. To avoid this, you should move your original Setup.rul out of your
project folder, rename it, or delete it through Windows Explorer.

Creating Script Libraries (.obl Files)

InstallShield 2020

InstallScript’s built-in functions are defined in library files (.obl files) to which a script is linked when the script is compiled.

Task To create a library file for functions that you have defined:

1. Create one or more .rul files containing the definitions of your functions.

2. At the command line, for each of your .rul files, run Compile.exe with the -c switch to compile the file without linking
it to any existing library file. This will create an .obs file (rather than the .inx file that is created by compiling without
the -c switch). For example, enter the following command line to create the file MyFunc.obs in the current folder.

Compile MyFunc.rul -c

To create an .obs file with a different name or location, use the -o switch.

3. Run Compile.exe with the -l switch, and one or more .obs files as parameters, to create the library file. For example,
enter the following command line to create the file MyFunc.obl in the current folder.

Compile MyFunc.obs -l

Entering the following command line creates the file MyFunc1.obl in the current folder.

Compile MyFunc1.obs MyFunc2.obs -l

To create an .obs file with a different name or location, use the -o switch.

Tip • If you have many .obs files, you can shorten the command line by using a command file as in the following example:

Compile @MyObsFiles.txt -l

InstallShield 2020 User Guide ISP-2600-UG00 837

Chapter 4
Customizing Installation Behavior

To quickly create the command file, you can use the MS-DOS command DIR with its /b (bare format) switch and redirect the
output to a file. For example:

DIR *.obs /b > MyObsFiles.txt

To compile an installation script using your library file, specify the library file on the command line or—when compiling
within InstallShield—on the Compile/Link Tab of the Settings dialog box.

See Also
Compile.exe

Publishing InstallScript Files (.rul and .h) to a Repository

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

If you have an existing InstallScript file (.rul) or InstallScript header file (.h) that you would like to reuse in other projects or
share with other users, you can publish it to a repository.

Task To publish a script file to a repository:

1. In the View List under Behavior and Logic, click InstallScript.

2. In the InstallScript explorer, right-click the script file that you would like to publish, and then click Publish Wizard.
The Publish Wizard opens.

3. Complete the panels in the Publish Wizard.

After you have imported a script file from a repository into a project, there is no link between the current script file and the
existing repository script file. If you make a change to the script file and then republish it to the repository, it does not affect
the script file in the project to which it was imported. However, you can reimport the script file from the repository into
your project.

See Also
Inserting and Importing Script Files
Using a Repository to Share Project Elements

838 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

InstallScript Lists
InstallShield 2020

Lists are used to store related information, such as strings or numbers. InstallScript lists are very similar to single-linked
lists in the C language. InstallScript list functions are very flexible, enabling you to return information in an order different
from the order in which it was stored and access and use that information in a variety of ways.

List Functions
InstallShield provides a number of functions for creating and manipulating lists. There are three types of InstallScript list
functions:

• Functions ending in -String that work with string lists only

• Functions ending in -Item that work with number lists only

• Functions that work with either string or number lists

InstallShield also has many secondary list-related functions that use or create lists.

List Structure
Lists are used to store related information—either strings or numbers. All the information in a list must be of the same data
type, and the number of elements is limited only by the available memory.

An InstallScript list has two parts. The first part is the head, which InstallShield uses internally. The head of the list contains
general information about the list, such as whether it contains strings or numbers. The head also contains pointers to the
beginning and end of the list.

The second part of the list is the list body. The list body contains the actual strings or numbers. You can have as many
strings or numbers in a list as the memory in the system will allow.

Remember that lists cannot contain both numbers and strings. A list must have only strings or only numbers.

Variables representing lists can be declared as type LIST or type LONG. Lists exist only in memory, meaning they are
destroyed when the installation is complete. If a list is local to a function, the list is destroyed when the function returns
control to the calling code.

See Also
List Processing Functions

Creating and Destroying Lists

InstallShield 2020

Before creating a list, decide which type of list you want to build: a string list or a number (item) list. To create the list, call
the ListCreate function:

// This builds the list head for a string list.

listID1 = ListCreate (STRINGLIST);

–or–

// This builds the list head for a number (item) list.

listID2 = ListCreate (NUMBERLIST);

InstallShield 2020 User Guide ISP-2600-UG00 839

Chapter 4
Customizing Installation Behavior

ListCreate automatically builds the head of the list and returns its ID number. The ID is used in all subsequent functions
that operate on the list. Therefore, you must always create a list using ListCreate before you use any other list function.
You must store the return value from ListCreate in a variable of type LIST or type LONG.

This fragment creates a number list and then a string list. It also tests each one to make sure that the lists were created
successfully.

// This creates an empty list for strings.

listID1 = ListCreate (STRINGLIST);

if (listID1 = LIST_NULL) then

MessageBox ("Unable to create the string list", SEVERE);
endif;

// This will create an empty list for numbers.

listID2 = ListCreate (NUMBERLIST);

if (listID2 = LIST_NULL) then

MessageBox ("Unable to create the number list", SEVERE);
endif;

When you are finished using a list, you will typically want to destroy the list to free the memory for other uses. ListDestroy
destroys the list and its contents. This example creates a list referenced by listID, adds a string to the list, and then destroys
the entire list.

listID = ListCreate (STRINGLIST);

if (listID = LIST_NULL) then

MessageBox ("Unable to create list.", SEVERE);
abort;
endif;

ListAddString (listID, "This is a string in the list", AFTER);

ListDestroy (listID);

If you do not destroy a list using ListDestroy, the list will be destroyed when the installation is complete. If the list is local
to a function, the list is destroyed when the function returns control to the calling code.

See Also
ListCreate
ListDestroy

Adding Elements to Lists

InstallShield 2020

InstallShield provides several functions for adding elements to lists:

Table 4-1 • Functions that Are Used to Add Elements to Lists

Function Description

ListAddItem Adds an item to the list.

ListAddString Adds a string to the list.

840 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-1 • Functions that Are Used to Add Elements to Lists (cont.)

Function Description

ListReadFromFile Reads a text file into a list.

ListAddString and ListAddItem add a single element to the list that you specify. Remember that, regardless of where you
place the new string in the list, it becomes the current string. Use the options BEFORE and AFTER to indicate where you
want to place the new element in the list relative to the current element. If you are working with a newly created list, using
either BEFORE or AFTER will add the string to the first element position in the list.

Adding elements to a list and the resulting effects on the list order and the element in the current position are most easily
explained by example. The examples below use string lists and ListAddString, but the same principles and steps apply to
using ListAddItem and number lists. Consider these scenarios:

• Adding an element to an empty list

• Adding an element before the current element

• Adding an element after the current element

• Adding elements before and after the current element

Adding an Element to an Empty List

InstallShield 2020

The first string that you add to the list goes immediately after the head of the list. This string (String 1 in the sample code)
becomes the current string in the list. The script fragment shown below results in a list like that depicted after it:

// Create the empty list of strings.

listID = ListCreate (STRINGLIST);

// Test for a valid list

if (listID = LIST_NULL) then
MessageBox ("List not created", SEVERE);
else
// Add a string to the list.
szString = "String 1";
ListAddString (listID, szString, AFTER);
endif;

Figure 4-1: String 1 is added to a list.

InstallShield 2020 User Guide ISP-2600-UG00 841

Chapter 4
Customizing Installation Behavior

Adding an Element Before the Current Element

InstallShield 2020

If the current string is the first string in the list and you add a new string before it, the new string becomes the first string in
the list. The string that was formerly in the first element position now resides in the second element position. The new
string at the first element position is now the current string:

// Create the empty list of strings.

listID = ListCreate (STRINGLIST);

// Test for a valid list

if (listID = LIST_NULL) then
MessageBox ("List not created", SEVERE);
else
// Add some strings to the list.
szString = "String 1";
ListAddString (listID, szString, AFTER);

szString = "String 2";

ListAddString (listID, szString, BEFORE);
endif;

Figure 4-2: String 2 is added before String 1.

Adding an Element After the Current Element

InstallShield 2020

If the current string is the first string in the list, and you add the new string after the current string, the new string becomes
the second string in the list, as well as the new current string. Refer to the script fragment below and to the illustration
following it:

// Create the empty list of strings.

listID = ListCreate (STRINGLIST);

// Test for a valid list

if (listID = LIST_NULL) then
MessageBox ("List not created", SEVERE);
else
// Add some strings to the list.
szString = "String 1";
ListAddString (listID, szString, AFTER);

szString = "String 2";

ListAddString (listID, szString, AFTER);
endif;

842 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Figure 4-3: String 2 is added after String 1.

Adding Elements Before and After the Current Element

InstallShield 2020

As another example, the code segment shown below creates a new list and puts String 1 in the first position. String 2 is then
added before String 1, leaving String 2 in the first position as the current string. Next, String 3 is added after the current
string, resulting in the list depicted below.

// Create the empty list of strings.

listID = ListCreate (STRINGLIST);

// Test for a valid list

if (listID = LIST_NULL) then
MessageBox ("List not created", SEVERE);
else
// Add some strings to the list.
szString = "String 1";
ListAddString (listID, szString, AFTER);

szString = "String 2";

ListAddString (listID, szString, BEFORE);

szString = "String 3";

ListAddString (listID, szString, AFTER);
endif;

Figure 4-4: String 1 is added. Then String 2 is added before String 1. Last, String 3 is added after String 2.

In the example above, if String 3 were added before the current string, the result would be as shown below, with String 3
becoming the current string. This code segment is shown below:

// Create the empty list of strings.

listID = ListCreate (STRINGLIST);

// Test for a valid list

if (listID = LIST_NULL) then
MessageBox ("List not created", SEVERE);
else
// Add some strings to the list.

InstallShield 2020 User Guide ISP-2600-UG00 843

Chapter 4
Customizing Installation Behavior

szString = "String 1";

ListAddString (listID, szString, AFTER);

szString = "String 2";

ListAddString (listID, szString, BEFORE);

szString = "String 3";

ListAddString (listID, szString, BEFORE);
endif;

Figure 4-5: String 1 is added. Then String 2 is added before String 1. Last, String 3 is added before String 2.

Changing Existing Elements in a List

InstallShield 2020

Call the ListSetCurrentString function to change the value of an element in a string list. Remember that only the current
element may be changed, so be sure to make the string you want to update the current string in the list.

Call the ListSetCurrentItem function to change the value of an element in a number list. Again, the item that you want to
update must be the current element in the list.

The example below demonstrates calling ListSetCurrentItem to change the value of the current item in a number list. The
ListSetCurrentString function works in the same manner, but with a string list and string variables.

// Create a list and verify its creation.

listID = ListCreate (NUMBERLIST);
if (listID = LIST_NULL) then
MessageBox ("Unable to create list.", SEVERE);
abort;
endif;

// Add items (1078 and 304) to the list.

nItem = 1078;
ListAddItem (listID, nItem, AFTER);
nItem = 304;
ListAddItem (listID, nItem, AFTER);

// Current item is the second item (304).

// Now set current item to new value (305).
nItem = 305;
ListSetCurrentItem (listID, nItem);
ListDestroy (listID);

See Also
ListSetCurrentString
ListSetCurrentItem

844 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Deleting Elements from a List

InstallShield 2020

Call the ListDeleteString function to delete the current string from a list. Or, call the ListDeleteItem function to delete the
current number from a list. If there are no more elements to delete, these functions return the END_OF_LIST constant.

Note that since ListDeleteString and ListDeleteItem delete the current element, you must reset the current element to
the element that you want deleted. After deletion, the next element in the list becomes the current element. You reset the
element by any of the methods described in Traversing Lists.

The example below illustrates the use of several list functions, including ListDeleteString. The ListDeleteItem function is
used in the same manner, except that the list is a number list and the variables are number variables.

// Create the empty list of strings.

listID = ListCreate (STRINGLIST);

if (listID = LIST_NULL) then // Test for a valid list.

MessageBox ("List not created", SEVERE);
endif;

// Add some strings to the list.

szString = "String 1";
ListAddString (listID, szString, AFTER);
szString = "String 2";
ListAddString (listID, szString, AFTER);
szString = "String 3";
ListAddString (listID, szString, AFTER);

// Delete the current string.

ListDeleteString (listID);

// Reset the current string in the list.

lResult = ListCurrentString (listID, svString);

// svString contains "String 2."

See Also
ListDeleteString
ListDeleteItem

Finding a Particular Element in a List

InstallShield 2020

You can traverse lists non-incrementally. Call the ListFindString function or the ListFindItem function when you want to
search for a specific string or number element in a list. These two functions begin their search at the current element and
continue forward through the list from that point.

To start a search from the beginning of a list, call the ListGetFirstString or the ListGetFirstItem function before calling the
ListFindString or the ListFindItem function.

When the ListFindString or the ListFindItem function finds the specified string or number, it becomes the current element
in the list.

In the script fragment below, a number list is created, and the number 1 (in nItem) is added as the first element. Then,
ListFindItem searches the list for the number 1, and deletes it, if found. Finally, the list is destroyed.

InstallShield 2020 User Guide ISP-2600-UG00 845

Chapter 4
Customizing Installation Behavior

listID = ListCreate (NUMBERLIST);

if (listID = LIST_NULL) then

MessageBox ("Unable to create list.", SEVERE);
abort;
endif;

nItem = 1;
ListAddItem (listID, nItem, AFTER);

if (ListFindItem (listID, nItem) = 0) then

ListDeleteItem (listID);
endif;

ListDestroy (listID);

Note • The ListFindString and ListFindItem functions look for only the first instance of the specified string or number at or
after the current element.

See Also
ListFindString
ListFindItem
ListGetFirstString
ListGetFirstItem

Getting the First and Next Elements in a List

InstallShield 2020

Call the ListGetFirstString function or the ListGetFirstItem function to return the first string element or number element,
respectively, from a list. The element that you retrieve then becomes the current element in the list.

Call the ListGetNextString function or the ListGetNextItem function to return the string element or number element after
the current element in a list. The element that you retrieve then becomes the current element in the list.

// Create the empty list of strings.

listID = ListCreate (STRINGLIST);

// Test for a valid list.

if (listID = LIST_NULL) then
MessageBox ("List not created", SEVERE);
endif;

// Add some strings to the list.

ListAddString (listID, "String 1", AFTER);
ListAddString (listID, "String 2", AFTER);
ListAddString (listID, "String 3", AFTER);

// Traverse the list and display the strings in a message box.

lResult = ListGetFirstString(listID, szDriveName);

while (lResult != END_OF_LIST)

MessageBox (szDriveName, INFORMATION);
lResult = ListGetNextString (listID, szDriveName);

846 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

endwhile;

See Also
ListGetFirstString
ListGetFirstItem
ListGetNextString
ListGetNextItem

Reading a File into a List

InstallShield 2020

Call the ListReadFromFile function to read an entire file into a string list. Each line in the file becomes an element in the
list. The ListReadFromFile function provides an easy way to load a list, rather than building it one item at a time.

See Also
ListReadFromFile

Setting an Index in a List

InstallShield 2020

InstallShield provides the ListSetIndex function, which lets you make an element the current element using an index
number. If you know the location of a particular element in a list, you can call the ListSetIndex function to access that
element immediately. You can traverse a list in either direction by using the index to set a specific element in a list to the
current element. The index of the list starts at 0 (zero).

The ListSetIndex function works on both string and number lists. After you set the indexed element as the current
element, call either the ListCurrentItem function or the ListCurrentString function to return the value of the indexed
item.

This example demonstrates traversing a list non-incrementally using ListSetIndex.

listID = ListCreate (STRINGLIST);

GetGroupNameList (listID);
nCheck = ListSetIndex (listID, LISTFIRST);

while (nCheck != END_OF_LIST)

ListCurrentString (listID, svString);
MessageBox (svString, INFORMATION);
nCheck = ListSetIndex (listID, LISTNEXT);
endwhile;

ListDestroy (listID);

The ListCount function tells you how many elements are in a list. The ListCount function is used mainly for general
information purposes, although it can be used to establish an upper index value in conjunction with ListSetIndex. For
example, you can call ListCount to get the number of elements in a list, and use that value with ListSetIndex to traverse a
list. The above example, which uses a while loop, is rewritten below using an InstallScript for loop based on the number of
elements in the list.

listID = ListCreate (STRINGLIST);

GetGroupNameList (listID);

// Get the number of elements in the list.

InstallShield 2020 User Guide ISP-2600-UG00 847

Chapter 4
Customizing Installation Behavior

nItems = ListCount (listID);

// Display the number of elements in the list.

SprintfBox (INFORMATION, "", "i = %d", nItems);

// Loop for nItems times beginning with zero,

// displaying each list element in turn in a message box.
for i = 0 to (nItems - 1)
ListSetIndex (listID, i);
ListCurrentString (listID, svString);
MessageBox (svString, INFORMATION);
nCheck = ListSetIndex (listID, LISTNEXT);
endfor;

ListDestroy (listID);

See Also
ListSetIndex
ListCurrentItem
ListCurrentString
ListCount

Traversing Lists

InstallShield 2020

InstallShield provides these functions for traversing lists incrementally and non-incrementally:

Table 4-2 • Functions that Are Used to Traverse Lists

Function Description

ListCount Sees how many string or numeric elements are contained in a

specified list.

ListCurrentItem Returns the current item in the list.

ListCurrentString Returns the current string in the list.

ListFindItem Attempts to find a numeric element in a list. If found, the element

becomes the current element of the list.

ListFindString Attempts to find a string element in a list. If found, the element

becomes the current element of the list.

ListGetFirstItem Retrieves the first element from a number list.

ListGetFirstString Retrieves the first string from a string list.

ListGetNextItem Retrieves the element after the current element from a number list.

ListGetNextString Retrieves the element after the current element from a string list.

848 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-2 • Functions that Are Used to Traverse Lists (cont.)

Function Description

ListSetIndex Sets the current element of the list as an index.

InstallShield uses single-linked lists, which means that unless you use functions that set indices or search for specific
elements in lists, you can traverse lists incrementally in one direction only: from the first element to the last.

InstallShield allows you to traverse lists in non-incremental fashion by means of indices and by searching for particular
elements in lists. Refer to the individual function descriptions for more details.

Most list traversing and list access operations are carried out relative to the current list element. Furthermore, most of the
functions used to traverse and access lists establish a current element as a result of their action. Therefore, making an
element the current element in a list is not an isolated action; it is a byproduct of another action.

If a list is empty, adding an element to the list will establish a current element. If a list is not empty, then making an element
the current element is best accomplished by traversing the list or searching for a particular element in the list.

Tip • Lists are often processed within while loops, usually checking for END_OF_LIST. An infinite loop can result if the list is not
valid. If you are processing lists in a while loop, make sure that you have created the list with the ListCreate function, and that
you have not destroyed the list with the ListDestroy function.

Writing a List to a File

InstallShield 2020

Call the ListWriteToFile function to write the contents of a string list to a file. Each element in the list becomes a line in the
file.

The example script below reads the Autoexec.bat file into the listFile string list and then writes that string list to a file
named Autoexec.bak.

listFile = ListCreate (STRINGLIST);

szPath = "C:\\";
szFileOld = "C:\\Autoexec.bat";
szFileNew = "C:\\Autoexec.bak";

if (ListReadFromFile (listFile, szFileOld) < 0) then

MessageBox ("ListReadFromFile failed.", SEVERE);
endif;

ListWriteToFile (listFile, szFileNew);

Saving InstallScript Files

InstallShield 2020

All open script files are saved automatically when you click Save on the File menu in InstallShield.

InstallShield 2020 User Guide ISP-2600-UG00 849

Chapter 4
Customizing Installation Behavior

System Restore
InstallShield 2020

Project • This information applies to InstallScript projects.

System Restore is a Windows feature that enables end users to restore PCs corrupted during software installation. The
System Restore feature automatically monitors and records key system changes to the end user’s PC. System Restore
reduces support costs and increases customer satisfaction by letting the end user easily undo a change that may have
harmed their system or revert to a time when they knew that their system was performing optimally.

InstallScript installations support System Restore by setting a restore point before starting the file transfer; the end user
can then use System Restore to restore the system to the state it was in before the file transfer.

Note • Installation actions (for example, registry changes and file modifications) that take place before file transfer cannot be
undone by System Restore.

Your installations are System Restore compatible by default. You can disable System Restore compatibility by placing the
following code in your script’s OnBegin event handler:

Disable( PCRESTORE );

If the file Wininit.ini exists in the target machine’s Windows folder, the installation cannot set a restore point. To handle
Wininit.ini, put code like the following in the OnFirstUIBefore and OnMaintUIBefore event handler functions:

/* Look for Wininit.ini in the Windows folder. If it is found ... */

if FindFile( WINDIR, "Wininit.ini", svResult )=0 then
bRebootForSystemRestore = TRUE;
/* ... get its size. */
GetFileInfo( WINDIR ^ "Wininit.ini", FILE_SIZE, nvSize, svResult );
/* If its size is zero bytes ... */
if nvSize=0 then
/* ... delete Wininit.ini. */
if DeleteFile( WINDIR ^ "Wininit.ini" )=0 then
bRebootForSystemRestore = FALSE;
endif;
endif;
/* If Wininit.ini has a non-zero size or could not be deleted, notify the end user and allow a
reboot. */
if bRebootForSystemRestore then
szQuestion = "Windows System Restore lets you undo " +
"changes to your computer. If you want to be able " +
"to use System Restore to undo this installation, " +
"you must reboot your computer now.\n\n" +
"Do you want to reboot your computer now?"
if AskYesNo( szQuestion, YES )=YES then
System( SYS_BOOTMACHINE );
endif;
endif;
endif;

850 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Getting and Setting Properties

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

Windows Installer properties can contain useful information about the product, the setup, the operating system, and the
user. By calling MsiGetProperty and MsiSetProperty, you can directly interact with these properties in your immediate
InstallScript custom action.

Note • Note that the MsiGetProperty and MsiSetProperty properties cannot be used for deferred InstallScript custom
actions, which do not have access to the active .msi database and do not recognize any Windows Installer properties. They can
access only the information that has been written into the execution script.

The following example retrieves the user name from the Windows Installer setup package, confirms the value, gives the
user the opportunity to change it, and then writes the new value back into the database.

Note • It may be necessary to specify a proper buffer size if the property value exceeds 1024 characters. For an example of
how to write code for this scenario, refer to Changes in Behavior for Some MSI APIs That Are Called in InstallScript Custom
Actions in the “Upgrading Projects from InstallShield 2011 or Earlier” topic.

// Include header file for built-in functions

#include "isrt.h"
// Include header file for MSI API functions and constants
#include "iswi.h"

export prototype Func1(HWND);

function Func1(hMSI)
STRING svName;
NUMBER nvSize, nResponse;
begin
// Retrieve the user's name from the MSI database
nvSize = 256;
MsiGetProperty (hMSI, "USERNAME", svName, nvSize);

nResponse = AskYesNo ("Your name will be registered as " +

svName + ". Is this correct?", YES);

if nResponse = NO then
AskText ("Enter the name that will be registered for " +
"this product.", svName, svName);
MsiSetProperty(hMSI, "USERNAME", svName);
endif;
end;

InstallShield 2020 User Guide ISP-2600-UG00 851

Chapter 4
Customizing Installation Behavior

See Also
Accessing or Setting Windows Installer Properties Through Deferred, Commit, and Rollback Custom Actions
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
MsiGetProperty (Windows Installer Help Library
MsiGetProperty (Windows Installer Help Library
MsiSetProperty (Windows Installer Help Library
MsiSetProperty (Windows Installer Help Library

Using Bit Flags

InstallShield 2020

Project • This information applies to InstallScript projects.

Bit flags are one or more (up to 32) Boolean values stored in a single number variable.

Each bit flag typically has a corresponding predefined constant associated with it; this constant has the bit for this flag set
to 1 and all other bits set to 0. For example, the following constant identifies the bit flag for bit 0, that is, the right-most bit
in the number:

#define BITFLAG_EXAMPLE_1 0x00000001

Other bit flags could be the following:

#define BITFLAG_EXAMPLE_2 0x00000002

#define BITFLAG_EXAMPLE_3 0x00000004

Note that 0x00000003 is not a valid bit flag, since this value corresponds to two bits in the number being set to 1.

Setting Bit Flags in a Variable

To set bit flags in a variable, use the bitwise OR operator (|). For example, to assign the value BITFLAG_EXAMPLE_1 and
BITFLAG_EXAMPLE_2 to the number variable nFlags, use code like the following:

nFlags = nFlags | BITFLAG_TEST_1 | BITFLAG_TEST_2;

Clearing a Bit Flag from a Variable

To clear a bit flag from a variable, combine the bitwise AND operator (&) with the bitwise NOT operator (~). For example, to
remove the BITFLAG_TEST_1 flag from nFlags, use code such as the following:

nFlags = nFlags & ~BITFLAG_TEST_1;

Testing a Variable for a Bit Flag

To test a variable for a bit flag, use the bitwise AND operator (&) and the bit flag constant to zero all the bits other than the
bit for which you are testing. For example, if nFlags is currently set to BITFLAG_TEST_1 | BITFLAG_TEST_2, the following
expression evaluates to true (that is, a non-zero result):

nFlags & BITFLAG_TEST_1

All bits other than the rightmost bit are set to 0 by the & operation; the rightmost bit is 1 since it is 1 in both the constant
BITFLAG_TEST_1 and nFlags.

852 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

The following expression evaluates to FALSE since the third bit of nFlags is 0 and all other bits are set to 0 by the &
operation:

nFlags & BITFLAG_TEST_3

String Comparisons
InstallShield 2020

When InstallShield compares two strings, it starts by comparing the initial character in the first string with the initial
character in the second string. If those characters are equal, InstallShield then compares the characters in the next position
of each string. If those characters are also equal, it moves on to the characters in the next position, continuing in sequence
until it encounters one of the following conditions:

• Two characters in the same relative position in the two strings do not match. In this case, InstallShield bases its
resolution on the comparison of those two characters. If the character in string one has a greater value than the
character in the corresponding position of string two, then string one is greater; otherwise string two is greater.

• The end of one string is encountered without finding unequal characters in corresponding positions. In this case, the
strings are of unequal length and therefore they are not equal.

• The end of both strings is reached without finding unequal characters in corresponding positions. In this case, the
strings are equal in length and all characters match; therefore the strings are equal.

Consider the following example:

svString1 = "trusting";
svString2 = "TRUTHFUL";

if svString1 = svString2 then

MessageBox("Equal", INFORMATION);
else
MessageBox("Not Equal", INFORMATION);
endif;

String comparisons are not case-sensitive. Because an uppercase character is equal to its lowercase counterpart,
InstallShield finds that the first three characters of trusting and the first three characters of TRUTHFUL are equivalent. The
comparison ends with the test of the characters in the fourth position of each string. Since s is lower than t in the ASCII
character table, svString1 does not equal svString2. The remaining characters are not compared and the else branch is
executed.

Note • The value of each character is based on its ASCII value. For information about the ASCII values of specific characters
and symbols, refer to a basic programming manual.

Using Null-Delimited Strings

InstallShield 2020

Project • This information applies to InstallScript projects.

InstallShield 2020 User Guide ISP-2600-UG00 853

Chapter 4
Customizing Installation Behavior

Note the following when using a null-delimited, double-null-terminated string (for example, abc\0def\0ghi\0\0; such
strings are also sometimes referred to as multiple null-delimited strings or multiple null-terminated strings):

• When declaring a variable that will be set to a null-delimited string value, explicitly size the variable; for example:

STRING szString[1024];

Do not use autosizing; the installation engine expects autosized strings to not include null characters within the string.

• Do not try to create arrays of null-delimited strings; since array elements must always be autosized, string arrays do
not currently support this type of string.

• The specified size of a null-delimited string should be at least the number of characters to be stored plus two for the
two terminating null characters.

• Since strings are automatically initialized to all null characters, you do not need to explicitly set the second-to-last
character to null (though this will not cause any adverse effects) unless you have previously set the second-to-last
character to something other than null.

• The best way to determine the length of a null-delimited string is to call the CharReplace function to replace the null
characters and then call the StrLengthChars function to determine the size of the resulting string.

• The StrGetTokens and StrPutTokens functions may be useful when working with null-delimited strings.

• Most InstallScript functions other than the ones noted above do not work with multiple null-delimited strings. If you
want to use a multiple null-delimited string with a built-in function, use the CharReplace function first to replace the
null characters with another character, such as an underscore (_).

Relative Path
InstallShield 2020

A relative path includes all of the information necessary to locate a file by starting at the current folder on the current drive,
for example, Support\Validation. That folder can be located along that relative path only if it exists in the current
directory.

Long File Names

InstallShield 2020

Windows operating systems that are 32 bit support long file names. Long file names enable end users to give directories
and files more meaningful names. The term long file name refers to both long file names and long paths.

InstallShield provides the long file name functions to facilitate the installation of 16-bit applications and 32-bit
applications that do not recognize long file names. It is your responsibility to determine your application’s requirements.
InstallShield provides the tools to help you install any kind of application.

See Also
Long File Name Functions

854 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Long File Names and 16-bit Applications

InstallShield 2020

You can launch 16-bit applications using long file names, but you cannot pass long file names as arguments to 16-bit
applications; 16-bit applications require the short file name versions of long file names to function correctly.

If your installation passes a file name to a 16-bit application, you must provide a valid short file name to the application.
Long file names will not work.

If your installation writes file names to files such as .ini files, and if 16-bit applications are expected to use the files, you
must write short file names that the 16-bit applications can use.

See Also
Long File Name Functions

Long File Names and Double Quotation Marks

InstallShield 2020

Under 32-bit operating systems, if you pass a long file name containing one or more space characters to the command line
(such as in a DOS shell or in the Command Line setting for an icon), you must enclose the long file name in double
quotation marks. This is necessary because the command line recognizes the space character as a delimiter separating a
command from other arguments. The double quotation marks convert the long file name to a string literal, allowing the
command line to receive it as a single argument.

Under 32-bit operating systems, if you pass a long file name containing one or more space characters to the command line,
it must be enclosed in double quotation marks. However, due to the manner in which Windows NT accesses icon files, if a
long file name in double quotation marks is used in the Command Line setting for an icon, the default Windows icon may
display instead of the application’s icon.

To display your product’s icon, you can specify the icon’s path in the parameter szIconPath of the function

AddFolderIcon when using it to add an icon to a program folder.

Double quotation marks must be removed from long file names before they can be converted to short file names in
InstallShield. Refer to the LongPathToQuote and LongPathToShortPath functions.

See Also
Long File Name Functions

Long File Name Format

InstallShield 2020

Long file names contain names longer than the conventional 8.3 (eight characters plus a three-digit extension) short file
name limit. Long file names allow the use of all the characters used in short file names. In addition, long file names can
contain plus signs (+), commas (,), semicolons (;), equal signs (=), left and right square brackets ([ ]), and spaces.

Leading and trailing spaces are ignored. The fully qualified long file name (including null terminating character) can be up
to 256 characters long on NTFS file systems and 260 characters long on VFAT file systems.

By default, the operating system creates a short file name for every long file name. The short file name consists of the first
six characters of the long file name, a tilde (~), and a number.

InstallShield 2020 User Guide ISP-2600-UG00 855

Chapter 4
Customizing Installation Behavior

See Also
Long File Name Functions

Defining Constants Through the Compiler

InstallShield 2020

You can define InstallScript constants on the Compile/Link tab of the Settings dialog box instead of in the script.

The following restrictions apply when defining constants on this tab:

• You can define only numeric constants.

• If you define a constant that you defined with a #define statement in the script, a compile error occurs.

• If you define a constant that you defined as a variable in the script, the value of the constant is lost at run time.

See Also
Constant Data

Using Windows Constants in a Script

InstallShield 2020

Some Windows constants are predefined in the ISRTWindows.h file that is provided in the InstallShield Program Files
Folder\Script\Isrt\Include folder. This file is automatically included in your installation when you include Ifx.h in
your script. You do not need to redefine any constants that are defined in ISRTWindows.h; doing so will result in a compiler
warning. To determine which constants are predefined, refer to the ISRTWindows.h file.

To use constants that are not defined in ISRTWindows.h, you must define them (using #define) in the declaration block of
your installation script. You cannot simply include the Windows.h file that is usually part of a C++ program. The values that
you need to assign to the undefined constants can generally be found in an include file that is provided with the
appropriate Windows SDK or development tool. (For Microsoft Visual C++, most constants can be found in the Winuser.h
file, which is located in the InstallShield Program Files Folder\Script\Resource folder.)

Coding Long String Literals

InstallShield 2020

To make a very long string literal more easily readable in a script, split the long string into two or more shorter strings,
place them on consecutive lines, and concatenate them. In InstallScript, concatenation is performed with the plus sign (+).
The example below shows how to split a long string literal across several lines of code in this way:

szMonths = "January, February, March, April, " +

"May, June, July, August, September, " +
"October, November, December";

See Also
Concatenate Operator (+)

856 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Absolute Path
InstallShield 2020

Project • This information applies to InstallScript projects.

An absolute path includes all of the information necessary to locate a file by starting at the root directory of a specified
drive. For example, C:\Program Files\InstallShield\2020 is the absolute path to the InstallShield folder when installed
on drive C.

Building Functions
InstallShield 2020

Typically, functions are declared at the top of the file, and the body is defined at the bottom of the file. After you declare a
function prototype, you need to define the function itself in the function block. Each function block contains only one
function.

Task To build a function:

1. Start the function body with the keyword function.

2. Type the return value data type used in the function prototype, or type void if the function prototype specifies a return
type of void (which indicates that the function does not return a value). If the function prototype does not specify a
return type, it is not necessary to enter one here.

3. Type the function name.

4. To the right of the function name, type the names of the arguments that you are using in parentheses. The arguments
must correspond in data type to the parameters that you declared in the declare block.

Note • InstallScript functions do not allow you to pass an assignment statement as a parameter. In addition, you cannot
use the && or || operators within an argument to a function.

Steps 1 and 2 create the function header. Function headers do not end with a semicolon in InstallScript.

5. Declare any local variables that you will use in the function. Then type the keyword begin on a line by itself, without
punctuation.

6. After the begin line, add whichever statements you need in order to accomplish your particular task.

You can also use a return statement, particularly if you want to return a specific value from the function. See below for
information on returning values from a function.

7. End your function with the keyword end.

A sample function block is shown below:

function GetPathParts(szFullPath, svDrv, svPath, svName)

LONG lResult;
begin
lResult = ParsePath(svDrv, szFullPath, DISK);

InstallShield 2020 User Guide ISP-2600-UG00 857

Chapter 4
Customizing Installation Behavior

if (lResult = 0) then
lResult = ParsePath(svPath, szFullPath, DIRECTORY);
endif;

if (lResult = 0) then
lResult = ParsePath(svName, szFullPath, FILENAME);
endif;

return lResult;
end;

Note • User-defined functions can return a value with a return statement. Other types of data can be returned in parameters
that have been declared with the BYREF operator.

See Also
#include (including the contents of another script in the main installation script)
Declarations

Calling Functions
InstallShield 2020

All functions—whether user-defined, built-in, Sd, or external—are called in the same way. Type the name of the function,
followed by the parameters that you want to pass to the function. For example:

MyFunction (MyAge, MyHeight, MyWeight);

Note • InstallScript functions do not allow you to pass an assignment statement as a parameter. In addition, you cannot use
the && or || operators within an argument to a function.

An autosized string variable that is passed by reference to a function is not autosized within the called function. If the function
attempts to assign a value whose length is greater than the current size of that parameter, run-time error 401 occurs. To avoid
this error, declare strings with a specific size when they are to be passed by reference to a function.

See Also
BYREF Operator
Declarations
return
String Size and Autosize

Calling a DLL File Function

InstallShield 2020

There are three rules you must remember when you are calling DLL file functions from your InstallScript installation script:

• The maximum length of the DLL file name is 33 characters; the maximum length of the function name is 63 characters.

• The installation cannot accept a composite parameter (that is, a parameter with a width exceeding 4 bytes) when
calling a DLL file. However, a parameter can be a pointer that points to a composite structure.

858 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• A string variable whose address is stored in a pointer variable cannot be changed by passing the pointer to a DLL file
function. To allow a DLL file function to change the value of a string variable, pass the variable itself as an argument to
the function, after declaring the data type of that argument specifying the BYREF operator.

Task To call a DLL file function from your script:

1. Add the DLL file to your project as a support file if you have not already done so. For more information, see Adding
Support Files.

1. In the View List under Behavior and Logic, click InstallScript.

2. In the InstallScript explorer, click the InstallScript file (.rul) that should call the DLL function.

3. At the beginning of the script, prototype the function using the following syntax:

prototype [CallingConvention] [ReturnType] DLLName.FunctionName( ParamType1, ParamType2, ... );

For example:

prototype BOOL MyDLL.MyFunction( INT, INT, INT );

You can specify the calling convention to be cdecl or stdcall. If you do not specify a calling convention, InstallShield
uses stdcall.

Note that the DLL file name is case-sensitive; for example, the script compiler treats MyDLL.MyFunction and
mydll.MyFunction as different functions. When prototyping functions from User32.dll, Gdi32.dll, or Kernel32.dll,
you may use the keywords USER, GDI, and KERNEL in place of the DLL file name.

You can specify the return type to be any InstallScript data type except LIST. If you are declaring a DLL file function call
in which a wide-character string argument or a Unicode string argument is expected, use the wstring data type. If you
do not specify a return type, the installation assumes that the DLL file function returns a 4-byte value.

4. Load the DLL file by calling the UseDLL function. For example:

UseDLL( SUPPORTDIR ^ "MyDLL.dll" );

Note • You do not need to load _isuser.dll, _isres.dll, or Windows API DLL files, such as User32.dll, Gdi32.dll,
and Kernel32.dll. Do not call UseDLL and UnUseDLL to load and unload these DLL files.

5. Call the function as you would call any other function. For example:

bResult = MyDLL.MyFunction( nInt1, nInt2, nInt3 );

It is recommended that you include the DLL file name in the function call, as in the preceding example. If your script
declares functions with the same name from different DLL files, calling the function without including the DLL file
name results in a compiler error.

If the installation does not find the called function in the DLL file, the installation raises an exception, which you can
handle by using a try...catch...endcatch block.

6. After all script calls to the DLL have been made, unload the DLL file by calling UnUseDLL. For example:

UnUseDLL( SUPPORTDIR ^ "MyDLL.dll" );

InstallShield 2020 User Guide ISP-2600-UG00 859

Chapter 4
Customizing Installation Behavior

Note • You can use the IS_NULLSTR_PTR variable to pass a null pointer to an external DLL function or Windows API through a
parameter that has been prototyped as an InstallScript string. For more information, see IS_NULLSTR_PTR.

See Also
Creating InstallScript Files
Inserting and Importing Script Files
Compiling Scripts
Debugging Scripts
UseDLL
UnUseDLL

Passing an Array to a DLL File Function

InstallShield 2020

InstallScript arrays are internally formatted as OLE Automation safe arrays, not native C or C++ arrays. To pass an
InstallScript array to a DLL function that expects a C or C++ array, you must place the array data in the expected format by
calling GetCArrayFromISArray.

Declaring Functions
InstallShield 2020

The first step in creating a user-defined function is to declare the function. The keyword prototype tells the InstallShield
script compiler that the line contains a function definition.

Task To declare a function:

1. Type the keyword prototype.

2. Type the function’s return type. (This step is optional. If you do not enter a return type, it is assumed that the function
returns a NUMBER value or no value.) To specify that the function does not return a value, type void.

3. On the same line, enter the function name.

4. After the function name, type the data types of the parameters, and enclose them in parentheses and separate them
by commas.

5. If there are no parameters, put empty parentheses to the right of the function name.

6. End the line with a semicolon (;).

In the following examples, FunctionName is a function containing three parameters. The arguments passed when calling
FunctionName must be, in order, INT, STRING, and SHORT. CopyBitmapExample has no parameters. FileTransfer has
five parameters—three LONG variables and two STRING variables—and returns a NUMBER value.

prototype FunctionName (INT, STRING, SHORT);

prototype CopyBitmapExample( );
prototype NUMBER FileTransfer (LONG, LONG, LONG, STRING, STRING);

When you are declaring DLL functions, use the format <DLL file name>.<function name> for the name of the DLL file
function. For example:

860 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

prototype MyDLL.MyFunction(INT, INT);

The above declaration signals to the InstallScript compiler that the program will call a function named MyFunction, with
two INT parameters, in a file named Mydll.dll.

You can also optionally declare a calling convention, either cdecl or stdcall, when declaring a DLL file function. For
example:

prototype cdecl MyDLL.MyFunction(INT, INT);

If you do not explicitly declare a calling convention, InstallShield uses stdcall. If you explicitly declare both a calling
convention and a return type, place the calling convention before the return type.

Note • Most Windows API functions use the stdcall calling convention, but some C or C++ development environments build
DLL file functions with the cdecl calling convention unless you prototype your C or C++ function with the __stdcall modifier. For
more information, consult your compiler documentation.

Many Windows API functions are declared in the header file ISRTWindows.h, which is automatically included when you include
Ifx.h in your script. (You can prevent the automatic definition of Windows APIs by placing the preprocessor constant
ISINCLUDE_NO_WINAPI_H in the Preprocessor Defines box on the Compile/Link tab of the Settings dialog box.)

See Also
Declarations
Data Types and Predefined Structures
Pointers

Returning Values from Functions

InstallShield 2020

Like InstallScript’s built-in functions, user-defined functions can be designed to return a value to the caller. To return a
value from a function, you must include a return statement, followed by the value to be returned, before the function’s end
statement. If you do not include a return statement or if you do not specify a value after the keyword return, the value
returned by the function is unpredictable. (If the function prototype specifies a return type of void, the function cannot
return a value.)

Many programmers use return statements to return error codes that indicate the success or failure of a function call. Most
of InstallScript’s built-in functions use a return statement for that purpose. The return statement also is used commonly to
create functions that return the result of an operation performed on parameters passed to the function, as in the example
below, which returns the area of a rectangle:

function RectangleArea (nLength, nWidth)

INT nVal;
begin
nVal = (nLength * nWidth);
return nVal;
end;

The keyword return can be followed by a constant, a variable, a numeric or string expression, or a function call. In the
example below, RectangleArea has been modified to eliminate the assignment statement; the arithmetic expression
follows the keyword return:

function RectangleArea (nLength, nWidth)

begin

InstallShield 2020 User Guide ISP-2600-UG00 861

Chapter 4
Customizing Installation Behavior

return (nLength * nWidth);

end;

The value returned by a function can be ignored by the calling program or function, tested in a conditional expression, or
assigned to a variable. In the following example, the return value from RectangleArea is assigned to the variable nArea:

nArea = RectangleArea (nLong, nWide);

In the next example, the result of RectangleArea is tested in a conditional expression:

if (RectangleArea(nLong, nWide) > nMaxArea) then

MessageBox("Area exceeds maximum allowed.", INFORMATION);
endif;

To return more than one value or non-numeric values, use the BYREF operator to define parameters that are passed by
reference.

See Also
BYREF Operator
Declarations
return

Unsupported Functions
InstallShield 2020

Some of the functions that were available in InstallShield Professional and InstallShield—Windows Installer Edition are not
supported in InstallShield.

Component Functions
In InstallShield, features are the top-most level of project organization from the end user’s perspective. Because of this,
component functions are now feature functions. For example, ComponentDialog is now FeatureDialog. Nearly all of the
component functions are available to you as feature functions in InstallShield.

Project • Feature functions are available for use in InstallScript and InstallScript MSI project types. If you have a Basic MSI
project, you must convert your project to the InstallScript MSI project type in order to use feature functions in your installation.

PreShowComponentDlg and PostShowComponentDlg

In InstallShield—Windows Installer Edition 2.x, you had to call the PreShowComponentDlg and PostShowComponentDlg
functions in order to use component-related (now feature-related) functions. In InstallShield, feature-related functions are
available only for InstallScript and InstallScript MSI project types. If you have a Basic MSI project, you must convert your
project to the InstallScript MSI project type in order to use feature functions in your script.

Because feature functions are not supported for use in Basic MSI projects, the PreShowComponentDlg and
PostShowComponentDlg functions are no longer necessary and are not supported.

862 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Writing Entry-Point Functions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI with InstallScript custom actions

• InstallScript MSI with InstallScript custom actions
• Merge Module with InstallScript custom actions

When Windows Installer executes an InstallScript custom action, InstallShield calls the function that you specified when
you created the custom action. Every InstallScript custom action must have an exported, user-defined function as an entry
point into the script.

Prototyping and Defining Functions

An entry-point function is prototyped and defined like any other function, except that it has the following requirements:

• Its prototype must include the keyword export to declare it as an exported function.

• The function can accept only one argument, which must be a handle to the .msi database.

• It should return a value meaningful to Windows Installer, if your custom action is designed to wait for a return value.
These custom action return values are defined in IsMsiQuery.h and available to you if you include IsMsiQuery.h or
Iswi.h in your script.

The following example script declares an entry-point function, which returns success if it succeeded:

// Include Isrt.h for built-in InstallScript function prototypes.

#include "isrt.h"

// Include Iswi.h for Windows Installer API function prototypes and constants.
#include "iswi.h"

export prototype MyFunction(HWND);

function MyFunction(hMSI)
STRING szKey, svValue, svPath;
NUMBER nvType, nvSize, nReturn;
begin
RegDBSetDefaultRoot (HKEY_LOCAL_MACHINE);

szKey = "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\isdev.exe";

nReturn = RegDBGetKeyValueEx (szKey, "Path", nvType, svValue, nvSize);

// The App Paths key contains the folder where InstallShield was
// installed, followed by a semicolon.
StrSub (svPath, svValue, 0, StrFind(svValue, ";"));

if nReturn = 0 then
MessageBox ("InstallShield is installed to " + svPath, INFORMATION);
return ERROR_SUCCESS;
else
MessageBox ("Cannot determine where InstallShield is installed.", SEVERE);
return ERROR_INSTALL_FAILURE;

InstallShield 2020 User Guide ISP-2600-UG00 863

Chapter 4
Customizing Installation Behavior

endif;
end;

Multiple Entry Points

Your script can have multiple entry-point functions in it to serve multiple custom actions. However, InstallShield calls only
the single entry-point function specified for each InstallScript custom action.

Adding Function Calls with the Function Wizard

InstallShield 2020

You can use the Function Wizard to select a function, specify its arguments, and insert the function in your script.

Declared Windows API Functions

InstallShield 2020

Project • This information applies to InstallScript projects.

Windows API functions are declared in the header file ISRT.h, which is automatically included in your installation when you
include Ifx.h in your script. If this function is also explicitly declared in your script code, do one of the following:

• Remove your function declaration and use the declaration that is provided by InstallShield.

• If you are creating a script that needs to be compatible in both InstallShield 2020 and versions of InstallShield
Professional earlier than 7, surround your declaration with code such as the following:

#if _ISCRIPT_VER < 0x700prototype ...#endif

You may also need to update code that calls the Windows API function, if the declaration that is defined by InstallShield is
different than your declaration.

You can prevent the automatic definition of Windows APIs by placing the preprocessor constant ISINCLUDE_NO_WINAPI_H
in the Preprocessor Defines box on the Compile/Link tab of the Settings dialog box.

Specifying a Non-Default Feature Event Handler Function

InstallShield 2020

By default, if the file Setup.rul exists in the InstallScript view and defines a function <feature name>_<event name> (for
example, NewFeature1_Installing), then that function is the handler for that event of that feature.

You can select a different function to be the handler for the feature event. It can be any function defined in any script file in
the InstallScript view, as long as it takes no arguments and is declared using the export keyword, for example:

864 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

export prototype MyFeatureHandler();

Task To specify a non-default feature event handler function, do the following:

1. Open a script file (.rul file) in the InstallScript view.

2. Do one of the following in the script editor pane:

• Declare and define the function that you want to specify as a feature event handler.

• In the Event Category and Event lists at the top of the script editor pane, select the feature and select an event
handler. InstallShield automatically creates the event handler (for example, Feature1Installing).

Note • If you put parentheses in a feature’s name, event handler functions with names of the default form <feature
name>_<event name> will not compile properly.

Accessing Global Variables

InstallShield 2020

Project • This information applies to InstallScript MSI projects.

A global variable is data declared outside of a function and available to any module in the script. By using global variables,
you can share persistent data with event handlers, entry-point functions, and user-defined functions.

For example, if you retrieve the value of the operating system’s version in your OnBegin event handler, you can later access
that global value in an entry-point function. The following script excerpt illustrates this:

// Include header file for built-in functions

#include <isrt.h>
// Include header file for event handlers and MSI APIs
#include <iswi.h>

// Declare global variable

NUMBER nvResult;

// Prototype entry-point function

export prototype MyFn(HWND);

function OnBegin()
// Declare local variable
STRING svResult;
begin
GetSystemInfo (WINMAJOR, nvResult, svResult);
end;

function MyFn(hMSI)
begin
if nvResult > 4 then
// Code for version of Windows later than 4.0
else

InstallShield 2020 User Guide ISP-2600-UG00 865

Chapter 4
Customizing Installation Behavior

// Code for Windows 4.0

endif;
end;

Important • Global variables share state across all event handlers. However, if you create an InstallScript custom action for
your project, global variables will not share state from the InstallScript custom action to the event-driven InstallScript code, or
vice versa. Thus, if you declare a global variable in your event-driven InstallScript code, that variable would not be available to
your InstallScript custom action. Similarly, if you declare a variable in your InstallScript custom action, that variable would not
be available to your event-driven InstallScript code.

Uninstalling Initialization (.ini) File Entries

InstallShield 2020

The uninstallation removes modifications that are made with the InstallScript initialization file functions while logging is
enabled. For more details, see the information in this section of the documentation.

See Also
InstallScript Functions that Are Logged for Uninstallation

General Limitations of Uninstalling Initialization (.ini) File Entries

InstallShield 2020

The following limitations apply to uninstalling .ini file entries and modifications automatically:

• Logging must be enabled when the .ini file functions are called.

• If an .ini file was created by any of the .ini file functions, it is not removed.

• If a section name was created by any of the .ini file functions, it is not removed, even if no more keys are present.

• If a key value is completely replaced by an InstallScript function (not appended to, or prepended to), the key values
that existed before the installation are not restored. In this case InstallShield considers the replaced key a newly
created key and will uninstall it as if it is a new key that was created by the installation.

• The uninstallation does not restore keys or values that were deleted using WriteProfString.

• To append a value to existing key (for example, network under [386Enh]), the new entry must either be appended at
the end or prepended in the very beginning of the existing string, but never inserted in the middle.

• Only the comma (,) and semicolon(;) are considered valid delimiters. If a string value to be uninstalled is found as a
part of longer string, the value and the delimiter before or after it is also removed appropriately (based on the string’s
position) only if the delimiter is a comma or a semicolon. For example, if the uninstallation removes pqr from the
string Key=pqr,rst,uvw, it also removes the comma after pqr. A character other than a comma or a semicolon in its
place will not be removed. As a rule, avoid adding spaces around delimiters.

See Also
InstallScript Functions that Are Logged for Uninstallation

866 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Uninstalling AddProfString’s Initialization (.ini) File Entries

InstallShield 2020

The uninstallation removes the keyname and value pair completely if the following conditions are true:

• The key was successfully created by AddProfString.

• The keyname and the value pair that exist when the uninstallation is run exactly match the installed keyname and
value pair. If another installation or program modifies the installed key between the installation and uninstallation,
the keyname and value pair will not be removed completely. Only the value that was created by the original
installation will be removed; the key itself and any additional values will not be removed by the uninstaller.

For example, if the System.ini file originally read as follows:

[386Enh]

device=votc.386

device=*vmpcd

and after your call to AddProfString, it read as follows:

[386Enh]

device=*vmp32

device=votc.386

device=*vmpcd

the uninstallation would remove device=*vmp32.

If another installation had added a value to the existing line, only the value from the installation that is being uninstalled
will be removed. The original keyname and the new value will be left in the file. For example, if you had added the line Test
Values=votc.386 in Test.ini under the [Test] section:

[Test]

Test Values=votc.386

Continuous Test=No

and another installation had added a new value to Test Values after your installation had run:

[Test]

Test Values=votc.386,pctcp.386

Continuous Test=No

when your application is uninstalled, votc.386 will be removed and TestValues=pctcp.386 will be left in the file:

[Test]

Test Values=pctcp.386

Continuous Test=No

See Also
General Limitations of Uninstalling Initialization (.ini) File Entries

InstallShield 2020 User Guide ISP-2600-UG00 867

Chapter 4
Customizing Installation Behavior

Uninstalling ReplaceProfString’s Initialization (.ini) File Entries

InstallShield 2020

The uninstallation removes the keyname and value pair completely if the following conditions are true:

• The key was successfully created by ReplaceProfString.

• The key did not previously exist.

• The keyname and value pair that exist when the uninstallation is run exactly match the installed keyname and value
pair. If another installation or program modifies the installed key between the installation and uninstallation, the
keyname and value pair will not be removed completely. Only the value that was created by the original installation
will be removed; the key itself and any additional values will not be removed by the uninstaller.

For example, if the System.ini file originally read:

[386Enh]

device=votc.386

device=*vmpcd

and after your call to ReplaceProfString, it read:

[386Enh]

device=*vmp32

device=votc.386

device=*vmpcd

the uninstallation would remove device=*vmp32.

See Also
General Limitations of Uninstalling Initialization (.ini) File Entries

Uninstalling WriteProfString’s Initialization (.ini) File Entries

InstallShield 2020

The uninstallation removes the keyname and value pair completely if the following conditions are true:

• The key was successfully created by WriteProfString.

• The key did not previously exist.

• The keyname and value pair that exist when the uninstallation is run exactly match the installed keyname and value
pair. If another installation or program modifies the installed key between the installation and uninstallation, the
keyname and value pair will not be removed completely. Only the value that was created by the original installation
will be removed; the key itself and any additional values will not be removed by the uninstaller.

See Also
General Limitations of Uninstalling Initialization (.ini) File Entries

868 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Extending Your Installation with COM Objects

InstallShield 2020

Important • Do not confuse COM objects with InstallShield objects. They are two separate features.

Instead of using DLLs or other executable files, you can extend your installation with COM objects. COM objects can be
integrated into your installation fairly easily. Use the following procedure to assign COM objects in your script.

Task To assign a COM object:

1. Declare an object variable. For example:

OBJECT oMyCOMObject

2. Get a reference to your COM object and assign it to the variable by using the set keyword. For example:

set oMyCOMObject = CreateObject ( szMyProgID );

The value of szMyProgID is a valid program ID for your COM object. If you leave the set keyword out, the script engine
attempts to set the default property of oMyCOMObject to szProgID. Because there is no default property, since
oMyCOMObject does not contain a reference to your COM object yet, the script will fail.

Important • By default, once a COM object is loaded by the installation using CoCreateObject, CoCreateObjectDotNet,
CoGetObject, or DotNetCoCreateObject, it remains loaded until the installation is finished. The COM object remains loaded
regardless of whether the COM object variable goes out of scope or is set to NOTHING.

Consequently, the library referenced by the COM object is also not released until the installation is finished. However, it is
possible to unload the library referenced by the COM object by calling the Windows API CoFreeLibrary. CoFreeLibrary
unloads the library regardless of whether any object variables still reference it. Therefore, you should only call CoFreeLibrary
after all objects that reference the library have gone out of scope or are set to NOTHING. See the following example code:

prototype void ole32.CoFreeLibrary( byval int );

int hModule;

program

// Free the library.

hModule = GetModuleHandle( "CSharpClassLibrary.dll" );

if( !hModule ) then

MessageBox( "Failed to get module handle", INFORMATION );

else

CoFreeLibrary( hModule ); // Release the library

endif;

endprogram

CoFreeUnusedLibraries can also be used to unload the library. However, by default, the system waits 10 minutes before
unloading the library, and in most cases, the installation requires the library to be unloaded immediately. If your installation

InstallShield 2020 User Guide ISP-2600-UG00 869

Chapter 4
Customizing Installation Behavior

will run on Windows XP and later only, you can call CoFreeUnusedLibrariesEx, which includes the option of unloading the
library immediately.

Below is an example COM object that validates a serial number. It has one method, Validate, and one property, IsEval.

function OnFirstUIBefore()
OBJECT oObj;
STRING szProgID, szMsg, szTitle, svName, svCompany, svSerial;
BOOL bValidSerialNumber, bEval, bValidate;
NUMBER nResult;
begin
szProgID = "MySerialValidation";
set oObj = CreateObject( szProgID );
if ( !IsObject( oObj ) ) then
MessageBox( "Object " + szProgID + " is invalid!", SEVERE );
return ISERR_GEN_FAILURE;
endif;

bValidSerialNumber = FALSE;
while (!bValidSerialNumber)
szMsg = "Please enter your name, company name, and product serial number.";
szTitle = "Enter info";
nResult = SdRegisterUserEx( szTitle, szMsg, svName, svCompany, svSerial );
if ( nResult < 0 ) then
MessageBox( "Failed to display dialog box.", INFORMATION );
return ISERR_GEN_FAILURE;
endif;

/* Check the value of the object's IsEval property. */

bEval = oObj.IsEval;
/* Execute the object's Validate method and
get the return value from the method. */
bValidate = oObj.Validate( svSerial );
if ( bEval || bValidate ) then
bValidSerialNumber = TRUE;
else
MessageBox( "Invalid serial number; please re-enter.", INFORMATION );
endif;
endwhile;

return ISERR_SUCCESS;
end;

Note • You can pass a data structure to your COM object as long as it has the members that your COM object expects. The
following is an example of passing a data structure:

#define PERSON_NAME_SIZE 1024

typedef PERSON
begin
STRING Name[PERSON_NAME_SIZE];
NUMBER Age;
end;

function OnBegin()

870 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

PERSON pPerson;
NUMBER nPhoneNumber;
OBJECT oMyCOMObject;
STRING szMyProgID;
begin
/* Assign a value to szMyProgID in this line. */
set oMyCOMObject = CreateObject ( szMyProgID );
if ( !IsObject( oMyCOMObject ) ) then
MessageBox( "Object " + szMyProgID + " is invalid!", SEVERE );
return ISERR_GEN_FAILURE;
endif;
nPhoneNumber = oMyCOMObject.GetPhoneNumber( pPerson );

return ISERR_SUCCESS;
end;

Note • The standard COM return value HRESULT is not visible to an automation client such as InstallScript. To return a value
from your COM object method, you should have an [out,retval] parameter in your method’s parameter list, as illustrated in the
following code samples.

IDL:

interface IMyInterface : IDispatch

{
[id(1)] HRESULT DoSomeWork([in] long nInputValue, [out,retval] long *pReturnValue);
}

C++:

STDMETHODIMP MyInterfaceImpl::DoSomeWork(long nInputValue, long *pReturnValue)

{
// your implementation code
*pReturnValue = 1; //return a value to client
return S_OK;
}

InstallScript:

function OnBegin()
NUMBER nObjReturn;
begin
set oMyCOMObject = CreateObject("MyProgID");
if (IsObject(oMyCOMObject) then
nObjReturn = oMyCOMObject.DoSomething(10);
/*nObjReturn will contain the value 1, returned from your implementation*/
endif;
end;

See Also
Object Functions

InstallShield 2020 User Guide ISP-2600-UG00 871

Chapter 4
Customizing Installation Behavior

Specifying Features and Subfeatures in Function Calls

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Feature is a general term that refers to a set of components or subfeatures in InstallShield. A subfeature is a feature that is
located below another feature—similar to the relationship between a folder and a subfolder.

Top-level features are the highest features in the hierarchy. Top-level features are never referred to as subfeatures.

How to Refer to Features and Subfeatures in InstallScript Code

Some feature functions and setup type dialog functions require you to refer to a single feature, while others require you to
refer to multiple features.

Referring to Single Features

To refer to a single feature, use the feature’s name. To refer to a subfeature, use a path-like expression where the name of
each feature in the hierarchy leading to that feature is separated by double backslashes. For example, to specify the
subfeature Tutorials under the top-level feature Help Files, use the following expression in your installation script:

szFeature = "Help Files\\Tutorials";

To refer to the subfeature CBT under Tutorials, use the following:

szFeature = "Help Files\\Tutorials\\CBT";

Note that the name of a feature cannot contain backslashes.

Referring to Multiple Features

In InstallScript MSI installations, some feature and setup type dialog functions, such as SdFeatureMult, display multiple
features and their subfeatures. In these cases, you refer to multiple features by specifying the feature immediately above
them in the hierarchy. To refer to multiple top-level features, use a null string ("").

For example, if you pass a null string to the SdFeatureMult function, the corresponding dialog displays all the top-level
features in your script-created component set in the left window on the SdFeatureMult dialog, depending on the value of
the MEDIA system variable. All subfeatures appear in the right window on this dialog.

See Also
Feature Functions
Dialog Functions
Dialog Customization Functions

872 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Calling a Windows API Function

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

You can call a Windows API function from within your InstallScript code.

Task To call a Windows API function:

1. At the beginning of the script, prototype the function using the following syntax:

prototype ReturnType DLLName.FunctionName( ParamType1, ParamType2, ... )

For example:

prototype INT User.LoadString( INT, SHORT, BYREF WSTRING, INT );

Use Dumpbin.exe with the /EXPORTS option to determine which functions reside in any of the Windows API DLLs
Kernel32.dll, User32.dll, and GDI32.dll. To determine the return type and parameter types for a function, consult
a Windows programming reference such as the Microsoft Development Library (MSDL).

Note • You can specify the return type to be one of the following InstallScript data types: BOOL, CHAR, HWND, INT, LONG,
LPSTR, NUMBER, POINTER, or SHORT. If a return type is not specified, InstallShield assumes that the DLL function returns
a 4-byte value.

2. Call the function as you would call any other function. For example:

nResult = LoadString( iInstance, nStringID, szMyString, MAX_SIZE );

3. To get extended error information if the function fails, check the value of the Err object’s LastDllError property. (It is
not possible to call the Windows API function GetLastError to get extended error information, since the setup itself
changes this value before returning control to the script.)

Embedding Custom Transfer File Operations

InstallShield 2020

In InstallShield, you can embed additional file transfer operations during the standard file transfer of the installation. Also,
the progress bar is updated smoothly and appropriately during these operations. There are a few different common
scenarios in which you would use this functionality.

InstallShield 2020 User Guide ISP-2600-UG00 873

Chapter 4
Customizing Installation Behavior

This table provides an overview of what functions are called for each scenario.

Table 4-3 • Determining Which Functions Are Appropriate for Common Custom Transfer File Operations

Scenario Using Function that Should Be Called

FeatureMoveData None

XCopyFile or CopyFile FeatureAddCost

LaunchApplication (external FeatureAddCost, FeatureSpendCost, FeatureAddUninstallCost, or

applications) FeatureSpendUninstallCost

These procedures include step-by-step information about how to use custom file transfer operations for each scenario.

Task To install additional files during the standard file transfer operation using XCopyFile or CopyFile:

1. Before file transfer, determine the size of the files to be installed, taking into account the cluster size on the target
folder for the files. You can accomplish this using the GetAndAddFileCost, CalculateAndAddFileCost, and/or
GetAndAddAllFilesCost functions.

2. Using the FeatureAddCost function, add the cost determined in Step 1 to the cost for the feature that these files are
associated with. Note that all cost must be associated with a particular feature. Therefore, if the files to be installed
are not associated with an existing feature, you must create a dummy feature or use an existing feature.

3. During file transfer, call the XCopyFile function to install the files. Typically, this would be done during the Installing
event of the feature associated with the additional files or in the OnMoving or OnMoved events. The progress bar is
updated smoothly and appropriately during the call. Note that you should disable the Cancel button in the status
dialog during the XCopyFile operation. See the description for the XCopyFile function for more information.

Note • There is no additional action required for the uninstallation. The files are uninstalled while the uninstallation progress
is updated appropriately.

Task To call an external installation that installs additional files during the standard file transfer operation:

1. Before file transfer, determine the size and number of the files to be installed (or other operations) by the external
installation by examining the external installation and taking note of what operations occur.

2. Using the FeatureAddCost function, add the cost determined in Step 1 to the cost for the feature that this installation
is associated with. Note that all cost must be associated with a particular feature. Therefore, if the files to be installed
are not associated with an existing feature, you must create a dummy feature or use an existing feature. Review the
two scenarios below.

3. If the external installation is called during uninstallation, add the number of operations and size of the operations to
the uninstallation cost using FeatureAddUninstallCost.

4. During file transfer, use the LaunchApplication event to launch the installation, typically in silent mode. Typically,
this would be done during the Installing event of the feature associated with the additional files or in the OnMoving or

874 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

OnMoved events. Use the LAAW_USE_CALLBACK option so that your script regains control periodically during the
installation and uninstallation.

5. Override the OnLaunchAppAndWaitCallback event, and add code to poll the running installation to determine its
progress. Then call the FeatureSpendCost (Installation) function or the FeatureSpendUninstallCost (Uninstallation)
function to spend the appropriate amount of cost that the installation has completed. Repeat this process while the
external installation is running. The progress bar is updated smoothly and appropriately during the call. Note that you
might have to adjust the LAAW_PARAMETERS.nCallbackInterval so that the OnLaunchAppAndWaitCallback event is
called often enough to keep the progress updated smoothly.

See Also
FeatureAddCost
FeatureSpendCost
FeatureAddUninstallCost
FeatureSpendUninstallCost

Expressing Large Numbers in InstallScript

InstallShield 2020

When a number is stored in an InstallScript integer, only 31 bits of data are available to store the value. Therefore, the
maximum value that can be expressed is 2^31 (2 GB). Note also that since InstallScript integers are always considered to be
signed, the 32 bit is interpreted as the sign bit and cannot be used to store numeric data. This limits the values that can be
expressed to 2^31 (2 GB) instead of 2^32 (4 GB), which could be stored in an unsigned data type.

In some cases, it is necessary or desirable to be able to specify larger values. To accomplish this in InstallShield, a number
of functions support the specification of large numbers as a pair of 32-bit numbers with the sign bit (32 bit) of each number
always being set to 0 to indicate a positive number. Using this format, it is possible to specify and retrieve a number with up
to 62 bits of data or 2^62 of size.

Note however that since the language does not have a data type that can express the number as a single variable, the
operations that can be performed on this data are limited. This data is typically passed between functions that support
these values. The data can also be converted to a single value expressed in a larger size unit (such as KB or MB) using the
ConvertSizeToUnits function or passed to an external DLL function that can handle larger data types.

When a number is specified as a high/low pair, the lower 32-bit value specifies the lower 31 bits of data (with the sign bit
always set to 0 and ignored) of the full value. The upper 32-bit value specifies the upper 31 bits of data (again with the sign
bit always set to 0 and ignored). For example, an upper value of 4 actually indicates 4 * 2^31 or 8589934592 (8 GB) of size.
This, combined with a lower value of 100, would indicate a total size of 8589934692 units.

Note that in the case of numbers less than 2^31, the high value will always be 0 and thus can be ignored if you are sure that
the size of the value will never exceed 2^31. However, it is recommended that if you need to use this data for computations,
you use the ConvertSizeToUnits function to convert this data to a single value of the most appropriate units with minimal
amount of rounding to express the data in a single value.

Note • Note that convention differs from the unsigned high/low value pairs used by Windows in which the lower value stores
the lower 32 bits of data and the high value stores the upper 32 bits of data. The ConvertWinHighLowSizeToISHighLowSize
function is provided for easy conversion of data returned by Windows API functions.

The following functions support high/low value pairs:

• GetDiskInfo

InstallShield 2020 User Guide ISP-2600-UG00 875

Chapter 4
Customizing Installation Behavior

• GetFileInfo

• GetAndAddFileCost

• CalculateAndAddFileCost

• GetAndAddAllFilesCost

• FeatureFileInfo

• FeatureGetCostEx

• FeatureAddCost

• FeatureSpendCost

• ConvertWinHighLowSizeToISHighLowSize

• ConvertSizeToUnits

Installing Device Drivers

InstallShield 2020

InstallShield supports installing device drivers in InstallScript installations using Windows Driver Install Frameworks (DIFx),
which includes the DIFxAPI component. This component allows drivers to be installed or uninstalled without using the
Windows Installer.

Project • This information applies to InstallScript projects. Installing device drivers is supported in InstallScript MSI and Basic
MSI projects using the DIFx Windows Installer functionality. For information on configuring device drivers using the Windows
Installer, see Configuring Device Driver Settings.

Task To install a 32-bit DIFx driver in an InstallScript project:

1. In the View List under Installation Information, click General Information.

2. For the DIFx Support (for 32-bit platforms) setting, select Enabled.

3. Add the DIFx driver files to the project.

4. Override the feature event for the feature containing the DIFx driver files and either call the DIFxDriverPackageInstall
function for non-Plug and Play (PnP) drivers or the DIFxDriverPackagePreinstall function for PnP drivers.

5. Build and run the installation.

Task To install a 64-bit DIFx driver in an InstallScript project:

1. In the View List under Installation Information, click General Information.

2. For the DIFx Support (for 64-bit Itanium platforms) setting or the DIFx Support (for 64-bit AMD platforms) setting,
select Enabled.

3. Add the DIFx driver files to the project.

876 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

4. Override the feature event for the feature containing the DIFx driver files and either call the DIFxDriverPackageInstall
function for non-Plug and Play (PnP) drivers or the DIFxDriverPackagePreinstall function for PnP drivers.

5. Build and run the installation.

See Also
General Information View
Device Driver Functions

Checking the Compiler Version

InstallShield 2020

In InstallShield, _ISCRIPT_VER is defined as 0xVVM, where VV is the major version of the product and M is the maintenance
pack release number. For example, 0x900 evaluates as InstallShield DevStudio version 9.0 and maintenance pack 0 (the
first release). This preprocessor constant was defined in InstallShield Professional 7 as 0x700 and in InstallShield
Professional 6 as 0x600, but is undefined and evaluates as zero in InstallShield Professional 5.x.

You can use this constant to test whether the InstallShield compiler is being used by including code like the following in
your script. This code tests for the existence of the first release of InstallShield DevStudio (version 9.0, maintenance pack
number 0) or later.

#if _ISCRIPT_VER >= 0x900

MessageBox( "DevStudio 9.x and above",INFORMATION );
#elif _ISCRIPT_VER >= 0x700
MessageBox ( "This is an IS 7.x compiler.", INFORMATION );
#else
MessageBox ( "This is an IS 6.x compiler or below.", INFORMATION );
#endif

Preprocessor Constants Maintained for Backwards Compatibility

The preprocessor constants _ISCRIPT_ISPRO and _ISCRIPT_ISDEV will be maintained for backwards compatibility.
_ISCRIPT_ISPRO is defined for InstallScript projects (and InstallShield Professional projects). _ISCRIPT_ISDEV is defined for
InstallScript MSI projects and Basic MSI projects.

See Also
Preprocessor Directives
#if. . .#else. . .#endif
#elif

Checking the Authoring Environment with _ISCRIPT_ISDEV and

_ISCRIPT_ISPRO
InstallShield 2020

Project • This information applies to InstallScript projects.

InstallShield 2020 User Guide ISP-2600-UG00 877

Chapter 4
Customizing Installation Behavior

The preprocessor constant _ISCRIPT_ISPRO is defined in InstallScript projects (and in InstallShield Professional projects)
but is undefined and evaluates as zero in InstallScript MSI and Basic MSI projects. The preprocessor constant
_ISCRIPT_ISDEV is defined in InstallScript MSI and Basic MSI projects but is undefined and evaluates as zero in InstallScript
projects (and in InstallShield Professional projects).

You can use _ISCRIPT_ISDEV and _ISCRIPT_ISPRO to write a single script that produces different behavior in the different
project types by including code like the following in your script:

#ifdef _ISCRIPT_ISPRO
// code specific to InstallShield Professional and InstallScript projects
#else
#ifdef _ISCRIPT_ISDEV
// code specific to Basic MSI and InstallScript MSI projects
#endif
#endif

See Also
Preprocessor Directives
#if. . .#else. . .#endif
#elif

Launching an Installation from Another InstallScript Installation

InstallShield 2020

Project • The following information applies to InstallScript projects.

You can launch a complete installation by calling the LaunchApplication function. For example, if you placed the child
installation’s files on a CD-ROM, you could call LaunchApplication as follows:

LaunchApplication (SRCDISK ^ "Launched Setup Folder\\Setup.exe", "", "", SW_HIDE,"", LAAW_OPTION_WAIT);

As an alternative, you can include the child installation in your project as a support file. If you do this, your main installation
copies the child installation to the target system, runs the installation, and deletes the installation along with any other
support files. Use the SUPPORTDIR variable in the path of your child installation:

LaunchApplication (SUPPORTDIR ^ Setup.exe, "", "", SW_HIDE,"", LAAW_OPTION_WAIT);

Alternatively, you could insert links to the child installation into your file groups, install the child installation onto the
target system, and then launch the installation from the target location. (With these methods, the child installation is left
on the target system until the parent installation is uninstalled.)

See Also
LaunchApplication

Language Support for InstallScript

InstallShield 2020

The table below shows the languages supported by the Premier edition of InstallShield. Following are descriptions of each
of the columns:

• InstallShield Language—Name used by the InstallShield interface to refer to this language.

878 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• InstallScript Constant—Language constant provided by InstallShield for filtering language-specific components.

• Windows English Equivalent—Name that the English version of Windows uses to refer to the language.

Table 4-4 • Supported Languages

InstallShield Language InstallScript Constant English Equivalent

Basque ISLANG_BASQUE Basque

Bulgarian ISLANG_BULGARIAN Bulgarian

Catalan ISLANG_CATALAN Catalan

Chinese (Simplified) ISLANG_CHINESE_SIMPLIFIED Chinese (Simplified)

Chinese (Traditional) ISLANG_CHINESE_TRADITIONAL Chinese (Traditional)

Croatian ISLANG_CROATIAN Croatian

Note that for backward compatibility, this

constant continues to be 0x001a rather
than the more logical 0x041a (in light of its
relation to Serbian); you should continue
to use this constant rather than
ISLANG_CROATIAN_STANDARD.

Czech ISLANG_CZECH Czech

Danish ISLANG_DANISH Danish

Dutch ISLANG_DUTCH Dutch (Standard)

English ISLANG_ENGLISH_UNITEDSTATES English (United States)

Finnish ISLANG_FINNISH Finnish

French (Canadian) ISLANG_FRENCH_CANADIAN French (Canadian)

French (Standard) ISLANG_FRENCH_STANDARD French (Standard)

German ISLANG_GERMAN German (Standard)

Greek ISLANG_GREEK Greek

Hungarian ISLANG_HUNGARIAN Hungarian

Indonesian ISLANG_INDONESIAN Indonesian

Italian ISLANG_ITALIAN Italian (Standard)

Japanese ISLANG_JAPANESE Japanese

InstallShield 2020 User Guide ISP-2600-UG00 879

Chapter 4
Customizing Installation Behavior

Table 4-4 • Supported Languages (cont.)

InstallShield Language InstallScript Constant English Equivalent

Korean ISLANG_KOREAN Korean

Norwegian ISLANG_NORWEGIAN Norwegian (Bokmal)

Polish ISLANG_POLISH Polish

Portuguese (Brazilian) ISLANG_PORTUGUESE_ BRAZILIAN Portuguese (Brazilian)

Portuguese (Standard) ISLANG_PORTUGUESE_STANDARD Portuguese (Standard)

Romanian ISLANG_ROMANIAN Romanian

Russian ISLANG_RUSSIAN Russian

Serbian ISLANG_SERBIAN_CYRILLIC Serbian (Cyrillic)

Slovak ISLANG_SLOVAK Slovak

Slovenian ISLANG_SLOVENIAN Slovene

Spanish ISLANG_SPANISH Spanish (Traditional Sort)

Swedish ISLANG_SWEDISH Swedish

Thai ISLANG_THAI Thai

Turkish ISLANG_TURKISH Turkish

Preventing Color Distortion

InstallShield 2020

If you are experiencing problems with color distortion in your InstallScript custom action, it is most likely due to shifts in
the color palette. This section explains how colors are apportioned on Windows systems and offers troubleshooting tips to
help you minimize any distortion in your installation’s end-user interface.

On systems operating in 256-color mode, there is one 256-color palette for displaying all available colors; in 16-color mode,
there is a 16-color palette, regardless of the number of colors that the video driver supports. Systems operating in high-
color or true-color mode do not use a color palette of any type. The colors are displayed directly, so color distortion should
not occur on these systems. On systems using a color palette, entries are allocated and used as needed when an object—
such as a bitmap—is displayed.

Once the current color palette has been allocated, to display a new color Windows attempts to use a color similar to one
that was already allocated. Therefore, distortion may result on a 256-color system if multiple objects that contain several
different colors are displayed simultaneously.

880 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Also, Windows allocates 16 static colors (VGA colors) and four additional shades of gray during startup. These colors are
used by the system to display 16-color images and are never de-allocated by Windows. See the Windows platform SDK for
more information on color palette handling.

Use the tips below to minimize any color distortion related to color palette shifts. Color palette tips apply to all images that
you display during installation, including the background color, .avi files, metafiles, and bitmaps.

Main Installation Window Background

• Try using a solid color background, which requires only one palette entry. Call the SetColor function with a solid
background constant to create a solid background.

• Try using a 16-color gradient background, which requires only 16 palette entries. Call the SetColor function with one
of the gradient color constants to create this type of background.

• Try using a tiled or a centered bitmap background. Call the PlaceBitmap function to create one of these backgrounds.

• Avoid using a 256-color gradient background, which requires about 80 palette entries.

Bitmaps and Metafiles

• When a bitmap is removed by calling the PlaceBitmap function with the REMOVE option, all color palette entries used
by that bitmap that are not being used by any other currently displayed image are freed from the color palette when
other colors are needed to display other objects. If you experience color distortion, always remove a bitmap once it is
no longer visible (instead of covering it with another bitmap) so that its color palette entries are freed.

• Try to use similar colors (including the 16 static colors, which are always allocated) for bitmaps and billboards
displayed during the installation to reduce the number of color palette entries needed.

• You can determine the maximum colors available on the target system by calling the GetSystemInfo function with
the COLORS option. Perhaps you will want to display bitmaps of different resolutions based on the return value.

• Note that 24-bit bitmaps do not include a custom color palette in the bitmap file. When displaying a 24-bit bitmap on a
256-color system, only the currently available palette entries will be used, even if there are additional color palette
entries available. If you are displaying 24-bit bitmaps in your installation and you expect it to run on 256-color
systems, it is recommended that you also include 256-color versions of your bitmaps.

• Since metafiles are drawn instead of placed, additional color palette entries are not allocated when a metafile is
drawn; only the existing color palette entries are used to display the metafile. If you expect your installation to run on
256 color systems, it is recommended that you use only the standard 16 static colors in your metafile, because these
colors will be available, regardless of the current color palette’s availability.

• Verify that the system’s video driver supports 256 or more colors. If the video driver does not support 256 colors, the
bitmap will not display properly, even if your video card and monitor support 256 colors.

• If a monitor is not capable of displaying 256-color bitmaps, only the 16 static colors are used. This can cause severe
distortion problems. If you are using 256-color images in your installation, it is recommended that you require end
users to run it on systems that support 256 colors.

InstallShield 2020 User Guide ISP-2600-UG00 881

Chapter 4
Customizing Installation Behavior

Using Custom Actions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield supports the use of custom actions to run InstallScript, VBScript, or JavaScript code; call DLL functions; run
executable files; call a managed method in a managed assembly; set a property or a directory; trigger an error and end the
installation; run PowerShell scripts; terminate a process; or run other installation packages.

Task InstallShield divides the task of creating and implementing custom actions into the following steps:

1. Create a custom action in the Custom Actions and Sequences view (or the Custom Actions view) or by using the
Custom Action Wizard.

2. Decide when your custom action should run.

3. Launch a custom action by inserting it into a sequence or placing it as the result of a dialog’s control event (Basic MSI
projects).

For details about each of the InstallShield custom actions that are added automatically to InstallShield projects to support
different functionality, see InstallShield Custom Action Reference.

Project • Merge module projects only: You can control the launch of custom actions in a merge module by modifying the
ModuleInstallExecuteSequence table in the Direct Editor. When you add the merge module to your installation project, all
custom actions and dialogs included in the merge module are available for you to insert in the installation’s sequences via the
Custom Actions and Sequences view.

See Also
Inserting Actions into Sequences
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Custom Actions and Sequences View (or Custom Actions View)

Using the Custom Action Wizard

InstallShield 2020

Project • This information applies to the following project types:

882 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

You can use the Custom Action Wizard to create a custom action or modify an existing one.

Task To launch the Custom Action Wizard:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI, InstallScript MSI, MSI
Database, and Transform projects) or Custom Actions (in DIM, Merge Module, and MSM Database projects).

2. Right-click the Custom Actions explorer and click Custom Action Wizard. The Custom Action Wizard launches.

3. Follow the wizard panels to create your custom action.

Alternatively, you can create a custom action in the Custom Actions and Sequences view (or the Custom Actions view)
without using the Custom Action Wizard. For more information, see Creating Custom Actions in the Custom Actions and
Sequences View (or the Custom Actions View).

To learn about displaying action information on the progress dialog and in the installation’s log file, see Using Action Text.

See Also
Cloning Custom Actions

Creating Custom Actions in the Custom Actions and Sequences View (or the
Custom Actions View)
InstallShield 2020

Project • The Custom Actions and Sequences view is available in the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The view is called the Custom Actions view in the following project types:

• DIM
• Merge Module
• MSM Database

InstallShield 2020 User Guide ISP-2600-UG00 883

Chapter 4
Customizing Installation Behavior

The recommended way to create a custom action is with the Custom Action Wizard. The wizard walks you through all the
required steps to create a custom action and prompts for information. You can also create your custom action in the
Custom Actions and Sequences view (or the Custom Actions view)—without using this wizard—by configuring all of its
settings directly in the view.

Task To add a custom action:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI, InstallScript MSI, MSI
Database, and Transform projects) or Custom Actions (in DIM, Merge Module, and MSM Database projects).

2. Right-click the Custom Actions explorer and then click the type of custom action that you want to add.

3. Rename the new custom action by selecting it, pressing the F2 key, and typing the new name.

4. Configure the custom action’s settings.

To learn about displaying action information on the progress dialog and in the installation’s log file, see Using Action Text.

See Also
Cloning Custom Actions
InstallShield Custom Action Reference

Cloning Custom Actions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

InstallShield provides the ability to copy or clone your custom actions. Cloning creates a new custom action of the same
type and with all of the same properties and values as the original custom action. You can use cloning to create multiple
custom actions that have similar attributes without having to manually set every custom action attribute.

Note that the clone operation clones only the custom action. It does not insert the custom action into any of the
installation sequences.

Task To clone a custom action:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI, InstallScript MSI, MSI
Database, and Transform projects) or Custom Actions (in DIM, Merge Module, and MSM Database projects).

2. In the Custom Actions explorer, right-click the custom action that you want to clone and click Clone.

884 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

InstallShield adds a copy of the cloned custom action to the Custom Actions explorer. The name of the custom action is the
same name as the cloned custom action, except that the copy has a 1 at the end of the name.

See Also
Using Custom Actions

Exporting Custom Actions to Other Projects

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

Task To save a custom action to another project:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI and InstallScript MSI
projects) or Custom Actions (in DIM and Merge Module projects).

2. In the Custom Actions explorer, right-click your custom action and click Export. The Export into dialog box opens.

3. Browse to the location of an existing InstallShield project file (.ism file). It can be either an installation project or a
merge module project, but the file cannot be open in another instance of InstallShield.

4. Click Open.

A copy of this custom action is added to the specified .ism file. If the other .ism file already has a custom action of that name
with different properties, the Resolve Conflict dialog box opens to offer you options for resolving the conflicts.

See Also
Reusing Project Elements

Configuring Custom Action Settings

InstallShield 2020

Project • The Custom Actions and Sequences view is available in the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The view is called the Custom Actions view in the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 885

Chapter 4
Customizing Installation Behavior

• DIM
• Merge Module
• MSM Database

When you create a custom action, you need to configure its settings. You may also need to later modify its settings. For
example, you might want to edit the condition that is assigned to a custom action.

Depending on the type of custom action that you want to create, the settings for that action may have different meanings.
For example, if your action calls an executable file that is stored in the .msi package, the Source setting needs to have the
name of the entry in the table that points to the executable file that you want to call. The target setting is a command-line
argument in this case.

Task To configure the settings for a custom action:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI, InstallScript MSI, MSI
Database, and Transform projects) or Custom Actions (in DIM, Merge Module, and MSM Database projects).

2. In the Custom Actions explorer, click the custom action whose settings you want to configure.

3. In the right pane, configure the settings as appropriate.

For information about each setting, see Custom Action Settings.

To learn about displaying action information on the progress dialog and in the installation’s log file, see Using Action Text.

See Also
Summary List of All Custom Action Types (Windows Installer Help Library)
Summary List of All Custom Action Types (Windows Installer Help Library)
InstallShield Custom Action Reference

Custom Action Type Overview

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The value that is displayed in the MSI Type Number setting for a custom action represents a combination of the type of
custom action (such as standard DLL, executable file, or InstallScript), the location (such as stored in the Binary table or
installed with the product) as well as several of the custom action’s settings, such as Return Processing, In-Script
Execution, and Execution Scheduling. It is the numeric value that is calculated by using the OR operator to combine several
bits that are available for the Type column in the Windows Installer CustomAction table. InstallShield also offers support
for extended custom action types, such as InstallScript custom actions and standard DLL file functions.

886 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

The Windows Installer Help Library refers to custom actions by a numeric type. When you add a custom action to your
project in the Custom Actions and Sequences view (or the Custom Actions view), the custom action type number is
calculated automatically, and the MSI Type Number setting is set to this number. For example, launching an executable file
whose fully qualified path is stored in the Property table is calculated as custom action type 50. To learn what value is
used for any of the basic types of custom actions, see Summary List of All Custom Action Types in the Windows Installer
Help Library.

For more information about each of the types of custom actions that are available in InstallShield, see Custom Action
Types.

See Also
Custom Action Type 50 (Windows Installer Help Library)
Custom Action Type 50 (Windows Installer Help Library)
Inserting Actions into Sequences

Custom Action Return Values

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Depending on your selections in the Custom Action Wizard’s Additional Options panel, Windows Installer will wait for a
successful return code before continuing with the installation. Your custom action must return one of these values
according to its status.

Table 4-5 • Custom Action Return Values

Return Value Description

ERROR_FUNCTION_NOT_CALLED The custom action was not executed.

ERROR_INSTALL_FAILURE The custom action failed.

ERROR_INSTALL_SUSPEND The custom action was suspended, but it will be

resumed later.

ERROR_INSTALL_USEREXIT The custom action could not complete

successfully because the end user aborted it.

ERROR_NO_MORE_ITEMS The custom action succeeded, but the

remaining actions should be skipped.

InstallShield 2020 User Guide ISP-2600-UG00 887

Chapter 4
Customizing Installation Behavior

Table 4-5 • Custom Action Return Values (cont.)

Return Value Description

ERROR_SUCCESS The custom action succeeded.

If you are authoring an InstallScript custom action, your entry-point function can return either ERROR_SUCCESS or
ERROR_INSTALL_FAILURE. These constants are defined for you when you include Iswi.h in your script. The InstallScript
engine reports any of the other exceptions to Windows Installer.

In-Script Execution
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

When you create a custom action, one setting that must be configured is the In-Script Execution setting on the Respond
Options panel of the Custom Action Wizard. Actions are executed in the order in which they appear in a sequence. However,
the sequences are run many times during a typical installation. The In-Script Execution setting enables you to select which
iteration of the sequence will trigger your action.

(Terminal Server Aware)

If you select a Terminal Server Aware option—for example, Immediate Execution (Terminal Server Aware)—the custom
action impersonates the end user during per-machine installations on terminal server machines.

Immediate Execution
As its name implies, Immediate Execution runs when the internal Windows Installer installation script is being compiled.
When an .msi file is launched, the Windows Installer service converts all the tables in the installation database into an
internal script. (This internal script is not the same as InstallScript code.) This script is built by cycling through all the
actions in the installation in the order in which they appear. The building of this script is immediate execution. When an
action is encountered whose In-Script Execution setting is set to Immediate Execution, that action is executed. Therefore,
this action launches before any file transfers are encountered, possibly even before the end-user interface for the
installation is fully loaded.

As a rule, custom actions scheduled for immediate execution do not modify the target system, but only set properties and
query the target system (for example, to see if the target system meets your product’s ). Custom actions that set Windows
Installer properties must be scheduled for immediate execution, and custom actions that occur in the User Interface
sequence must be scheduled for immediate execution.

888 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Because actions of this type run before any changes have been made to the system, they cannot rely on files that are being
installed by the installation.

Deferred Execution
Deferred Execution takes place when the internal script generated during Immediate Execution is executed by the
Windows Installer service. After that script has been fully generated, the Windows Installer service runs the newly compiled
script. The script runs through all of the actions in your sequences and executes them in order. However, if an action is
scheduled for immediate execution, the action does not run again during Deferred Execution.

Actions that launch during Deferred Execution have access to files being installed as part of the system. As a result, you can
call a custom action that calls a function from a DLL file installed with your product during this phase of the installation.
However, Deferred Execution custom actions must take place between InstallInitialize and InstallFinalize in order to work
properly.

Custom actions that rely on a file being installed to the target system, or that rely on other system changes to have already
been performed, must be scheduled for deferred execution.

Rollback Execution
Rollback occurs when an error is encountered by the installation or the end user cancels the installation before it has a
chance to complete. The Rollback Execution option allows you to set your action to execute only during rollback.
Therefore, any actions that are enabled for Rollback Execution are written to the installation script, as are Deferred
Execution actions. Unlike Deferred Execution actions, Rollback Execution actions launch only during rollback. (Rollback
custom actions run only if the installation fails during deferred execution.)

Any custom actions that make changes to the target system during an installation should be undone with a Rollback
Execution custom action in the event of rollback. For example, if you have a custom action that creates a file, you should
create a second custom action that deletes the file, and schedule the second action for rollback execution. (A rollback
custom action should be scheduled before the custom action it reverses.)

Commit Execution
Commit Execution actions do not run until the InstallFinalize action completes successfully. This means that they wait until
the installation has completed transferring files, registering COM servers, and creating shortcuts and registry entries. Then,
any actions that are set to Commit Execution launch in the order in which they appear in the sequence.

For example, if you have a custom action that creates a temporary file, you should create a second custom action that
deletes the file, and schedule it for commit execution.

Deferred Execution in System Context

Like Deferred Execution actions, these actions do not launch until the script generated by the Windows Installer service is
run. However, actions of this type execute with no user impersonation.

See Also
Defining Sequences
Inserting Actions into Sequences
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties

InstallShield 2020 User Guide ISP-2600-UG00 889

Chapter 4
Customizing Installation Behavior

Documenting the Behavior of Custom Actions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Windows Logo • The intended behavior of each custom action must be documented for the Windows logo program. This is
especially helpful if system administrators deploy your product to enterprise environments; they sometimes need to know
what the custom actions do. If you validate your installation package but you have not specified a value for the Help File Path
setting, InstallShield generates validation error ISICE10. For more information, see ISICE10.

Task To document the behavior of a custom action in your project:

1. Create a file that describes the intended behavior of the custom action. The file should be a text-based file such as a
.txt, .htm, or .rtf file. Note that each custom action should have its own document.

2. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI, InstallScript MSI, MSI
Database, and Transform projects) or Custom Actions (in DIM, Merge Module, and MSM Database projects).

3. In the Custom Actions explorer, click the action that you are documenting.

4. For the Help File Path setting, click the ellipsis button (...) to browse to the file that describes the behavior of the
custom action.

Tip • You can specify whether InstallShield should stream the contents of each of the custom action help files into the .msi file
at build time. For more information, see the description of the Include Custom Action Help setting for a product configuration
in the Releases view.

See Also
ISCustomActionReference Table
Validating Projects
Guidelines for Creating Custom Actions that Meet Requirements of the Windows Logo Program

890 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Guidelines for Creating Custom Actions that Meet Requirements of the

Windows Logo Program
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

If you are applying for the Windows logo, your application must meet Microsoft’s Windows logo program requirements.
You can use the validation suite to verify whether your installation package meets most of the custom action–related logo
requirements. However, some of the requirements cannot be verified through the validation suites.

Following is a list of the requirements that are not validated through the validation suites or the associated ISICEs but still
must be met to achieve logo compliance for the Windows logo program:

• Do not call the Global Assembly Cache tool (Gacutil.exe) from a custom action. This tool was not designed to be used
during installations.

• All custom actions must record success or failure in the Windows Installer log by calling MsiProcessMessage.

• Custom actions that change system state during installation must remove or restore the system state during
uninstallation. In addition, custom actions that change system state must be written as a deferred and rollback
custom action pair.

This does not apply to custom action types 19 (displays an error, returns failure, and ends the installation), 35 (sets the
installation directory), or 51 (sets a property)

• The intended behavior of each custom action in your installation must be documented. This does not apply to custom
action types 19 (displays an error, returns failure, and ends the installation), 35 (sets the installation directory), or 51
(sets a property). For more information, see Documenting the Behavior of Custom Actions.

For information about all of the InstallShield custom actions that are added automatically to InstallShield projects to
support different functionality, see InstallShield Custom Action Reference.

Conditionally Launching Custom Actions Based on Release Flags

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

InstallShield 2020 User Guide ISP-2600-UG00 891

Chapter 4
Customizing Installation Behavior

When your installation is built, InstallShield automatically adds a property called ISReleaseFlags to the Property table.
This property contains all of the release flags that are included in the build. These flags appear exactly as they do in the
Release Flags setting in the Releases view. Multiple flags are separated by a comma.

A custom action can be conditionally launched based on release flags in the following ways.

Configuring the Condition Setting

The easiest way to conditionally launch a custom action is to set the Condition setting when you insert the custom action
into a sequence. In this case, you can enter a condition such as ISReleaseFlags><"MyReleaseFlag" in the Condition
setting. This condition succeeds if the substring “MyReleaseFlag” is contained in the value of the ISReleaseFlags
property.

Calling MsiGetProperty
A more robust way to set a condition on your custom action based on release flags is to author a call to MsiGetProperty
within the custom action. In addition to determining if the action should launch, you can also indicate what code is
executed by the action. For example, you can use one function from a DLL file for all scenarios, yet provide different
functionality for each scenario through conditional logic within your function.

The drawback to conditionally launching your custom action in this way is that you can use only a script or DLL custom
action. Additionally, your custom action still launches behind the scenes. When the custom action launches, it can check if
a specified release flag has been included in the build. If that flag exists, the custom action continues. If the flag is not there,
the action exits.

See Also
Conditional Statement Syntax
Release Flags
Getting and Setting Properties

Placing Files in the .msi Database and Extracting Them During Run Time
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

The Support Files view (in Basic MSI projects) and the Support Files/Billboards view (in InstallScript MSI projects) enable
you to store temporary files that are to be used by your installation program but are not to be installed. Examples are
license text files (as displayed by SdLicense) or DLL files called by your installation. The location to which the support files
are extracted at run time is stored in the Windows Installer property SUPPORTDIR.

Note • Deferred, commit, and rollback custom actions in Basic MSI and InstallScript MSI installations have access to only
some of the built-in Windows Installer properties: CustomActionData, ProductCode, and UserSID. If you want a custom action
to access any other properties (such as SUPPORTDIR) during deferred, commit, or rollback execution, you need to pass them as
CustomActionData. To learn more, see Accessing or Setting Windows Installer Properties Through Deferred, Commit, and
Rollback Custom Actions.

892 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Project • Note that the value of the Windows Installer property SUPPORTDIR is not the same as the value of the InstallScript
system variable SUPPORTDIR.

Custom Action Script Examples

InstallScript
To access a particular support file during installation, Basic MSI projects and InstallScript MSI projects should reference the
Windows Installer property SUPPORTDIR. You can use MsiGetProperty to query the path, and then append the file name to
the SUPPORTDIR value to obtain the complete path of the file. In the settings for a custom action, this is just [SUPPORTDIR].

In an InstallScript custom action, you could use code such as the following:

export prototype STRING GetSupportFilePathMSI(HWND);

function STRING GetSupportFilePathMSI(hMSI)

STRING szSupportDir[MAX_PATH + 1];
STRING szMyFile[MAX_PATH + 1];
NUMBER nLength;
begin
// set initial buffer size
nLength = MAX_PATH + 1;
MsiGetProperty(hMSI, "SUPPORTDIR", szSupportDir, nLength);

// reset buffer-size variable

nLength = MAX_PATH + 1;
MsiGetProperty(hMSI, "MYFILE", szMyFile, nLength);

// return full file path

return szSupportDir ^ szMyFile;
end;

In this example, the name of the support file that is being used is stored in the MYFILE property.

C++
In C++, you could use the following code:

UINT __stdcall ShowSupportdir(MSIHANDLE hInstall)

{
TCHAR szSupportDir[MAX_PATH + 1] = {'\0'};
DWORD dwBuff = sizeof(szSupportDir);
MsiGetProperty(hInstall,"SUPPORTDIR",szSupportDir,&dwBuff);
MessageBox(NULL,szSupportDir,"SUPPORTDIR is ...",MB_OK);
}

VBScript
In VBScript, you could use the following code:

dim strSupportDir
strSupportDir = Session.Property("SUPPORTDIR")

InstallShield 2020 User Guide ISP-2600-UG00 893

Chapter 4
Customizing Installation Behavior

See Also
Using Support Files
MsiGetProperty
MsiGetProperty

Accessing or Setting Windows Installer Properties Through Deferred,

Commit, and Rollback Custom Actions
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

Deferred, commit, and rollback custom actions in Basic MSI and InstallScript MSI installations have access to only some of
the built-in Windows Installer properties: CustomActionData, ProductCode, and UserSID. If you want a custom action to
access any other properties during deferred, commit, or rollback execution, you can pass them as CustomActionData. You
can do so by scheduling an immediate set-a-property type of custom action to set a property that matches the name of the
custom action. The value of this property is then available in the CustomActionData property within the deferred, commit,
or rollback custom action.

Using CustomActionData to Access a Property

The following example shows how to access the Windows Installer property SUPPORTDIR through a deferred InstallScript
custom action.

Task To access SUPPORTDIR through a deferred InstallScript custom action:

1. In the Custom Actions and Sequences view, create a set-a-property custom action (type 51) called GetSUPPORTDIR.
Configure the Property Name, Property Value, and Install Exec Sequence settings for the custom action as follows,
and leave all of the other settings blank.

• Property Name: DisplaySupportDir

• Property Value: [SUPPORTDIR]

• Install Exec Sequence: After InstallInitialize

2. In the InstallScript view, create a new function called DisplaySupportDir.

3. Add the following code to display a message box containing the value of SUPPORTDIR:

function DisplaySupportDir(hMSI)
STRING supportDirPath;
NUMBER supportDirPathBuffer;
begin
supportDirPathBuffer = MAX_PATH;
if(MsiGetProperty(hMSI, "CustomActionData", supportDirPath, supportDirPathBuffer) ==
ERROR_SUCCESS) then
SprintfBox(INFORMATION,"Deferred Execution","The value of SUPPORTDIR is %s",supportDirPath);

894 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

SprintfBox(INFORMATION,"Deferred Execution","The value of InstallScript's SUPPORTDIR is

%s",SUPPORTDIR);
endif;
end;

4. In the Custom Actions and Sequences view, create an InstallScript custom action called DisplaySupportDir.
Configure the Function Name, In-Script Execution, and Install Exec Sequence settings for the custom action as
follows, and leave all of the other settings blank.

• Function Name: DisplaySupportDir

• In-Script Execution: Deferred Execution in System Context

• Install Exec Sequence: After GetSUPPORTDIR

Important • The property name that you enter in step 1 must match the name of the custom action that you create in step 4.

Using CustomActionData to Access More Than One Property

If you want a deferred, commit, or rollback custom action to access more than one Windows Installer property, you can
“pack” the properties in CustomActionData and then have your deferred, commit, or rollback custom action “unpack”
them after retrieving the value of CustomActionData.

For example, if you want to retrieve the values of [INSTALLDIR], [SUPPORTDIR], and [SetupType], you would set the
Property Value setting of your type 51 custom action to this:

[INSTALLDIR];[SUPPORTDIR];[SetupType]

where each property is separated by a semicolon.

You can use code such as the following VBScript to “unpack” the values from the CustomActionData property:

Dim PropArray
PropArray = Split(Session.Property("CustomActionData"), ";")
INSTALLDIR = PropArray(0)
SUPPORTDIR = PropArray(1)
SetupType = PropArray(2)
'Now do something with these variables...

InstallScript Custom Actions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module

In order to use your InstallScript functions in a Windows Installer installation, you first need to create a custom action that
calls your script. The easiest way to create a custom action is to use the Custom Action Wizard.

The primary panels of this wizard are:

InstallShield 2020 User Guide ISP-2600-UG00 895

Chapter 4
Customizing Installation Behavior

• Action Type Panel

• Action Parameters Panel

• Respond Options Panel

• Insert into Sequence Panel

When you complete the wizard, a custom action of type 65536 is created. This custom action type is not defined in the
Windows Installer Help Library. Because InstallScript is not natively supported by Windows Installer, InstallShield created
action type 65536.

Project • You should not use an InstallScript custom action in the User Interface sequence of an InstallScript MSI project. You
can use the event-driven script to provide the user interface in an InstallScript MSI project.

Calling Functions in Standard DLL Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

Although Windows Installer restricts the parameters that you can pass to a functions in a DLL file written for a custom
action, InstallShield offers a solution that enables you to pass any number of parameters to a function and store the return
value. Note that the function must use the __stdcall calling convention. Functions with more than one parameter will not
work properly if this convention is not used.

You can specify that you are calling a function in a standard DLL file in the Custom Action Wizard’s Action Type panel by
selecting Call a function in a standard dynamic-link library for the Type option. The next panel, the Function Definition
panel, allows you to specify the function’s parameters and return value.

Note • If you call a function in a standard DLL file that is installed with the product and the action is scheduled as deferred (for
the In-Script Execution setting), the DLL file that you are calling must be the component’s key file.

A custom action that calls a function in a standard DLL file stored in the Binary table cannot be scheduled for deferred
execution.

If you want a Windows Installer property to be set to the function’s return value, the action must be configured for immediate
execution. If you try to specify a return property for an action that is scheduled for deferred, rollback, or commit execution, the
return property is ignored at run time.

Understanding the Parameters and Return Value as a Formatted String

When you specify the function signature for a standard DLL file action, that action’s Function Signature setting in the
Custom Actions and Sequences view uses the following formatting to display the function’s name, arguments, return type,
and return property.

DataType1=[PropertyName1] DllName::FuncName(in DataType2="Value", Direction DataType3=[PropertyName2])

896 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

The following table describes each portion of the format.

Table 4-6 • Format for the Arguments of a Function

Argument Description

DataType1=[PropertyName1] DataType1 is of type void, STRING, BOOL, NUMBER, HWND, HANDLE, or

POINTER. PropertyName1 is the name of a property from the Property Manager
view.

If the return type is void, =[PropertyName1] is omitted.

DllName Specify the name of the DLL file, without the dot or file extension.

FuncName Enter the name of the function that you are calling.

in DataType2="Value" This is the format for an argument that is a constant. DataType1 is of type
STRING, BOOL, NUMBER, HWND, HANDLE, or POINTER. Value is the data that
you want to pass for this argument. The constant’s data type is always
preceded by in.

Direction This is the format for an argument that references a Windows Installer
DataType3=[PropertyName2] property’s value. Direction can be in, inout, or out. For a discussion of these
property types, see the Function Definition panel under the argument’s source.

DataType3 can be of type STRING, BOOL, NUMBER, HWND, HANDLE, or

POINTER. PropertyName2 is the name of a property whose value will be passed
to or set by the function, depending on the value of Direction.

Example
For the custom action created in Calling MessageBoxA in an Installation, the Target value reads:

void User32::MessageBoxA(in HWND=0, in STRING=[MESSAGEPROP], in STRING=[CAPTIONPROP], in NUMBER=1)

In this example, the data type is void, in HWND=0 represents a numeric value of 0, and MESSAGEPROP is a property that
contains a string that will be passed to the function MessageBoxA in User32.dll.

Calling Functions in Windows Installer DLL Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database

InstallShield 2020 User Guide ISP-2600-UG00 897

Chapter 4
Customizing Installation Behavior

• Transform

A DLL file function specifically written for a Windows Installer custom action can accept only the handle to the installer
database as a parameter. The steps below explain how you can retrieve information from the .msi database for use in your
custom action.

You specify that your custom action resides in a Windows Installer DLL file (custom action types 1 and 17) by selecting Call
a function in a Windows Installer dynamic-link library in the Custom Action Wizard’s Action Type panel.

An alternative is to select Call a function in a standard dynamic link library in the Action Type panel. In this case,
InstallShield allows you to specify the function’s parameters.

Task There are three major steps involved in passing a parameter to a function in a DLL file written for Windows Installer:

1. Prepare your DLL file.

2. Create a custom action and insert it into one of the sequences.

3. Pass the parameter using the Property Manager view. These steps are explained in greater detail below.

Preparing DLL Files

In order for you to pass data to a DLL file function in a custom action, the function to which you are passing data needs to
call the MsiGetProperty function, which retrieves the value of an installer property. In the example below, it retrieves the
value of a public property called MYPROPERTY.

UINT __stdcall MyActionName(MSIHANDLE hInstall)

{
TCHAR szValue[51] = {0};
DWORD dwBuffer = 50;

MsiGetProperty(hInstall, TEXT("MYPROPERTY"), szValue, &dwBuffer);

MessageBox(GetForegroundWindow( ),
szValue,
TEXT("Value of MYPROPERTY"), MB_OK | MB_ICONINFORMATION);

return ERROR_SUCCESS;
}

For more information, see MsiGetProperty in the Windows Installer Help Library.

If you use a C++ compiler to build your DLL file, ensure that the compiler does not change the function names exported
from the DLL file. With Microsoft Visual C++, for example, you can create a .def file that specifies the function names to be
exported from your DLL file. A typical .def (called MyActions.def) file looks like the following:

LIBRARY MyActions
EXPORTS
MyActionName

For more information about function name decoration, see your compiler documentation.

Creating Custom Actions and Inserting them into Sequences

The second step is to create your custom action and insert it into one of the Installation sequences. To create the custom
action, use the Custom Action Wizard, and to place the custom action, use the Custom Actions and Sequences view.

898 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Passing the Parameter Using the Property Manager

Task To pass the new parameter using the Property Manager:

1. In the View List under Behavior and Logic, click Property Manager.

2. Click the New Property button. InstallShield adds a new row at the bottom of the view.

3. In the Name column, type the name of the property that you would like to retrieve with MsiGetProperty (MYPROPERTY,
in this example).

4. In the Value column, type the value that you want to pass. For example, if you want to pass the URL to your Web site,
type http://www.mycompany.com.

See Also
Custom Action Return Values

Passing Parameters to a DLL File Function in a Custom Action

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

There are a number of reasons why you might pass a parameter to a function in a custom action. For example, you might
want to pass a URL for Web registration or the UserName property for a custom user interface. However, Windows Installer
does not directly support passing parameters to DLL file functions.

The entry-point function for a Windows Installer DLL file can have only one argument, which is the handle to the database.
To learn about a suggestion for passing parameters to a DLL file written for Windows Installer, see Calling Functions in
Windows Installer DLL Files.

Task To accomplish this in InstallShield:

1. In the Custom Wizard’s Action Type panel, select Call a function in a standard dynamic-link library.

2. In the Function Definition panel, specify the parameters that you want InstallShield to pass to the function.

Calling a Public Method in a Managed Assembly

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM

InstallShield 2020 User Guide ISP-2600-UG00 899

Chapter 4
Customizing Installation Behavior

• InstallScript MSI
• Merge Module

The managed-code type of custom action calls a public method in a .NET assembly that is written in managed code such as
Visual Basic .NET or C#.

If you include a managed-code custom action in your project, InstallShield creates a C++ Windows Installer wrapper DLL for
your .NET assembly. The wrapper DLL includes your assembly, as well as the information that is required to mediate, load,
and run the assembly.

Note • If you specify that the location of your managed assembly should be the Binary table, InstallShield stores the wrapper
DLL—which includes your assembly—in the Binary table.

See Also
Run-Time Requirements for Managed-Code Custom Actions
Specifying the Signature for a Managed Method in an Assembly Custom Action
Using 32-Bit vs. 64-Bit Managed-Code Custom Actions
Using the Custom Action Wizard
Creating Custom Actions in the Custom Actions and Sequences View (or the Custom Actions View)

Run-Time Requirements for Managed-Code Custom Actions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

The managed-code type of custom action requires the Microsoft .NET Framework on the target system.

InstallShield includes redistributables for the .NET Framework. If it is possible that target systems may not have the .NET
Framework, you can add the appropriate .NET Framework redistributable to your project. For instructions, see Adding .NET
Framework Redistributables to Projects.

You can use the property IS_CLR_VERSION to identify a semicolon-delimited list of .NET Framework versions that the
custom action should attempt to load to run your managed code. In most scenarios, this property is not set in the
installation package. It is set at the command line. To specify that version 1.1 is required, use the following command-line
parameter:

IS_CLR_VERSION=v1.1.4322

Note that the complete version number of the .NET Framework should be specified for the property value. If more than one
version is acceptable, you can specify a semicolon-delimited list of versions. The first one that can be loaded is used. For
the following example command-line parameter, the custom action attempts to load version 2.0. If that version is not
present, the custom action attempts to load version 1.1. If version 1.1 is not present, the custom action fails.

IS_CLR_VERSION=v2.0.50727;v1.1.4322

900 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

To specify that the custom action should attempt to load whatever is the latest version of the .NET Framework that is
installed if none of the specified versions are installed, add a semicolon to the end of the property value, as shown in the
following example:

IS_CLR_VERSION=v2.0.50727;v1.1.4322;

The semicolon at the end of the property value also indicates that if none of the specified versions are present but a version
of the .NET Framework is already loaded, the custom action uses the currently loaded version, even if it is not the latest
version that is installed.

Note • If the execution of your managed-code custom action is set to deferred mode, you must use the Windows Installer
property CustomActionData to pass the IS_CLR_VERSION property and value. To learn more, see Specifying the Signature for
a Managed Method in an Assembly Custom Action.

Tip • If issues with the custom action occur at run time because of .NET Framework version mismatches, you may want to
instruct end users to set the IS_CLR_VERSION property at the command line when they run your installation. Note that for
deferred custom actions, you must have already used the CustomActionData property to pass the IS_CLR_VERSION property.
For more information, see Specifying the Signature for a Managed Method in an Assembly Custom Action.

See Also
Using 32-Bit vs. 64-Bit Managed-Code Custom Actions

Specifying the Signature for a Managed Method in an Assembly Custom Action

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

The Managed Method Definition panel in the Custom Action Wizard is where you specify arguments for the method that
your managed assembly custom action should call. You can also specify this information on the Method Signature dialog
box.

Using the Default Method Signature

If you use the default method signature, the custom action handles methods with up to one parameter. If the method takes
a parameter, it is passed the MsiHandle, as well as any return type. If the method returns an integer, this integer is passed
directly to Windows Installer. Therefore, if a method returns integer 1603 (ERROR_INSTALL_FAILURE) in this scenario, the
installation aborts.

For more information, see Custom Action Return Values in the Windows Installer Help Library.

InstallShield 2020 User Guide ISP-2600-UG00 901

Chapter 4
Customizing Installation Behavior

Using a Custom Method Signature for an Immediate Custom Action

If you use a custom method signature, the custom action calls the method with the arguments that you specified. If the
value of a parameter is a Windows Installer property and the custom action is set for immediate execution, the method
stores any by-reference and out parameter values in the passed properties. In addition, the custom action converts the
return value to a string and stores it in the return property. If no return property is specified, the return value is ignored.

Note that if you use a custom signature, the custom action’s return value is not passed to Windows Installer. However, if
the managed code throws an unhandled exception, the custom action returns ERROR_INSTALL_FAILURE to Windows
Installer. Therefore, in order for the custom action to indicate failure and for Windows Installer abort the installation, the
managed code must throw an unhandled exception.

Using a Custom Method Signature for a Deferred, Commit, or Rollback Custom Action
Deferred, commit, and rollback custom actions have access to only some of the built-in Windows Installer properties:
CustomActionData, ProductCode, and UserSID. Therefore, if you use a custom method signature and you want your
managed assembly custom action to access or pass any other properties during deferred, commit, or rollback execution,
you must pass them through the CustomActionData property. Note the following guidelines for deferred, commit, and
rollback managed assembly custom actions:

• Custom signatures that pass properties need to have their values passed in as CustomActionData in the following
format:

PROPERTYNAME="Property Value"

Separate multiple property name–property value pairs with a space, as in the following example:

PROPERTYNAME1="Property Value 1" PROPERTYNAME2="Property Value 2"

• If the managed assembly for your deferred, commit, or rollback custom action is installed with the product, use
CustomActionData to identify the location of the managed assembly, and use the following format:

#filekey.dll="location of assembly"

For the “location of assembly” portion, use the format [#filekey.dll].

• If the path for the managed assembly references one or more properties, use CustomActionData to pass each of the
properties and their corresponding values.

• Consider using CustomActionData to pass the following property and value:

IS_CLR_VERSION="[IS_CLR_VERSION]"

If run-time issues occur because your custom action attempts to load the wrong version of the .NET Framework to run
your managed code, you can have end users set the value of the IS_CLR_VERSION property at the command line when
they run your installation. For deferred, commit, and rollback managed-code custom actions, IS_CLR_VERSION must
be passed to CustomActionData in order for end users to use this run-time override. To learn more about the
IS_CLR_VERSION property, see Run-Time Requirements for Managed-Code Custom Actions.

Specifying Parameter Values for a Custom Method Signature

If you use a custom method signature, you can enter any of the following types of values for a parameter:

• A single property that is enclosed within square brackets—for example, [ProductName]. Note that immediate-mode
managed assembly custom actions can update ref and out parameters. InstallShield does not support combining
multiple properties or mixing properties with strings for a parameter value.

• A literal—for example, a string such as the number 1 or 1603.

902 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• An explicit string that is enclosed within quotation marks—for example, “My Project Name-1”.

• The variable MsiHandle, which indicates the installation handle.

At run time, after a property has been resolved or a string has been isolated from within its quotation marks, the custom
action attempts to convert the string to an instance of the type of the method’s appropriate parameter. A parameter of
type String is passed as is, and all normal numeric types are handled by calling the public static Parse(string) method to
turn the string into the type. In addition, the custom action calls any type’s public static Parse(string) method and uses the
return value as the passed parameter value. IntPtr is also handled despite the lack of a Parse method.

See Also
Accessing or Setting Windows Installer Properties Through Deferred, Commit, and Rollback Custom Actions
Custom Action Wizard
Method Signature Dialog Box
Using 32-Bit vs. 64-Bit Managed-Code Custom Actions

Using 32-Bit vs. 64-Bit Managed-Code Custom Actions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

When you build a release that includes a managed-code custom action in your project, InstallShield attempts to determine
the target architecture (32 bit or 64 bit) of the main .NET assembly that is associated with the custom action. InstallShield
does this by examining the portable executable (PE) file for the assembly and determining if the PE file is 32 bit or 64 bit. If
the PE file uses Microsoft intermediate language (MSIL) code, InstallShield treats it as 32 bit. InstallShield configures the
release so that the appropriate version of the .NET Framework—32 bit or 64 bit—is used to run your managed code at run
time.

If you want to override the built-in default behavior, use the Direct Editor view to add a new record with the following fields
to the ISClrWrap table.

Table 4-7 • Overriding the Default Architecture for a Managed-Code Custom Action

ISClrWrap Table Column Description

Action_ Enter the name of the managed-code custom action that you want to modify.

Name Enter the following: TargetPlatform

Value Specify the appropriate architecture.

• To use a 32-bit version of the .NET Framework, enter the following: x86

• To use a 64-bit version of the .NET Framework, enter the following: x64

InstallShield 2020 User Guide ISP-2600-UG00 903

Chapter 4
Customizing Installation Behavior

See Also
Run-Time Requirements for Managed-Code Custom Actions

Calling a Kill-Process Custom Action

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Transform

The kill-process type of custom action terminates one or more processes at run time. The following procedure describes
how to include and configure this type of custom action in your project.

Task To add a kill-process custom action to your project:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. Right-click the Custom Actions explorer and then click New Kill Process. InstallShield adds a kill-process custom
action with a default name.

3. Enter a new name, or right-click it later and click Rename to assign it a new name. Use a name that helps you
distinguish this custom action from other actions in your project.

4. In the right-pane, configure the action’s settings:

a. In the In-Script Execution setting, select the iteration of the sequence that should trigger the action. For details
about each option, see In-Script Execution.

b. Use the settings in the Sequences area to schedule the custom action at the point where you want the process to
be terminated. As an alternative, you can drag the custom action from the Custom Actions explorer to the
appropriate node under the Sequences explorer.

c. In the Function Name setting, select the appropriate function:

• KillProcess—If you selected one of the immediate options in the In-Script Execution setting and you want
to kill a process that has a particular name, select this option.

• KillProcessByID—If you selected one of the immediate options in the In-Script Execution setting and you
want to kill a process that has a particular process identifier (PID), select this option.

• KillProcessDeferred—If you selected one of the deferred, commit, or rollback options in the In-Script
Execution setting and you want to kill a process that has a particular name, select this option.

• KillProcessByIDDeferred—If you selected one of the deferred, commit, or rollback options in the In-Script
Execution setting and you want to kill a process that has a particular PID, select this option.

904 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

d. In the Processes setting, enter executable file names or PIDs of the processes that you want to terminate.

If Function Name is set to: Then, specify Processes using:

KillProcess or KillProcessDeferred Executable file names

KillProcessByID or KillProcessByIDDeferred PIDs

If you want to terminate more than one process, use a semicolon (;) to separate each file name or PID. For
example, to terminate processes that have names such as myfile1.exe and myfile2.exe, enter the following:

myfile1.exe;myfile2.exe

Tip • The value of the Processes setting may by written to the ISTerminateProcesses property. If you have
additional kill-process custom actions that do not specify a value in the Processes setting, such as those migrated
from InstallShield 2015 or earlier, shared use of the ISTerminateProcesses property may result in undesired
behavior.

e. Configure any of the action’s other settings as needed.

See Also
Using the Custom Action Wizard

Calling a PowerShell Custom Action

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Transform

Windows PowerShell is a .NET Framework–based command-line shell and script language that enables system
administrators to automate system configuration tasks. InstallShield lets you include in your installations custom actions
that run PowerShell scripts (.ps1). You may want to add this type of custom action to a project to perform system
configuration tasks at installation run time. Note that PowerShell actions require PowerShell 2.0 or later on target systems.

Adding a PowerShell Custom Action to Your Project

Task To add a PowerShell custom action to your project:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. Right-click the Custom Actions explorer, point to New PowerShell, and click one of the following commands:

• Stored in Binary table—To have your code base stored in the Binary table, select this command. This location is
useful if you do not want the file to be installed on the target system.

InstallShield 2020 User Guide ISP-2600-UG00 905

Chapter 4
Customizing Installation Behavior

• Installed with product—To call code from a script file that is going to be installed on the target system, select
this command.

InstallShield adds a PowerShell custom action with a default name.

3. Enter a new name, or right-click it later and click Rename to assign it a new name. Use a name that helps you
distinguish this custom action from other actions in your project.

4. In the PowerShell Script File Name setting, select the PowerShell script file (.ps1) in the list of files that are stored in
the Binary table or that are included in your project. If the location that you specified is stored in the Binary table,
you can click this ellipsis button (...) in this setting to browse to the file.

5. Configure the action’s other settings as needed.

Once you have added the custom action to your project, schedule it as needed. For more information, see Inserting Actions
into Sequences.

Run-Time Requirements for a PowerShell Custom Action

PowerShell is installed on only some operating systems by default. If an installation launches a PowerShell custom action
but PowerShell is not installed, the custom action fails.

To check that PowerShell is installed on a target system, you can add the predefined system search for PowerShell to your
project, and configure your PowerShell custom action to run only if the system search determines that PowerShell is
installed. You can also use this system search to determine which version of PowerShell is installed, and you can include a
condition for the custom action that triggers its launching only on appropriate target systems. By default, the predefined
system search for PowerShell sets the value of the POWERSHELLVERSION property to the version of PowerShell.

You can use the Windows Installer property IS_CLR_VERSION to identify a semicolon-delimited list of .NET Framework
versions that the custom action should attempt to load to run your PowerShell script.

To learn more about the POWERSHELLVERSION and IS_CLR_VERSION properties, see Windows Installer Property Reference.

Interacting with the Running Basic MSI or InstallScript MSI Installation

Several cmdlets that let you interact with the running Basic MSI or InstallScript MSI installation are available:

Table 4-8 • Cmdlets that Interact with a Running Basic MSI or InstallScript MSI Installation

Cmdlet Description

get-property -name [Property Name] This cmdlet gets the value of a Windows Installer property. The Name
parameter is a positional parameter.

The following sample code gets the value of the property called MYPROPERTY:

$Value = get-property -name MYPROPERTY

set-property -name [Property Name] - This cmdlet sets the value of a Windows Installer property. The Name and
value [value] Value parameters are positional parameters.

The following sample code uses the value of the MYPROPERTY property to set
the value of a second property called NEWPROPERTY:

$Value = get-property -name MYPROPERTY

set-property -name NEWPROPERTY -value $Value

906 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-8 • Cmdlets that Interact with a Running Basic MSI or InstallScript MSI Installation (cont.)

Cmdlet Description

format-properties -Value [format This cmdlet expands the value of a formatted expression. The Value
string] parameter is a positional parameter.

The following sample code formats a string that contains a Windows Installer
property called NEWPROPERTY. The property name and its surrounding square
brackets are replaced by the value of the property at run time.

$myFormat = format-properties -Value "This is a text string with

[NEWPROPERTY] embedded."

trace-info -LogMessage [log string] This cmdlet writes any information that is needed to the Windows Installer
log, making it available for debugging or other information purposes. The
LogMessage parameter is a positional parameter.

The following sample code writes the string, I am a PowerShell custom

action to the Windows Installer log.

trace-info -LogMessage “I am a PowerShell custom action”

To indicate that your script has succeeded, ensure that it returns 0. For example, you may want to end your script with the
following:

exit(0)

See Also
Using the Custom Action Wizard

Launching Executable Files

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Launching an executable file from your installation is useful to install third-party tools, display a readme file, or display a
Web page that contains the most up-to-date information about the product being installed. To launch an executable file
from within your installation, you need to add a custom action in the Custom Actions and Sequences view (in Basic MSI,
InstallScript MSI, MSI Database, and Transform projects) or the Custom Actions view (in DIM, Merge Module, and MSM
Database projects).

InstallShield 2020 User Guide ISP-2600-UG00 907

Chapter 4
Customizing Installation Behavior

You can use the Custom Action Wizard to create the custom action that launches an executable file from your installation.
Each wizard panel is listed below, with the entries that you need to make in order to launch an executable file.

908 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Basic Information Panel

Table 4-9 • Settings for the Basic Information Panel in the Custom Action Wizard

Panel Option Value

Name Provide a meaningful name for your custom action. This name is used internally in your product and
is for identification purposes only.

Comment Type comments about this custom action.

Action Type
Table 4-10 • Settings for the Action Type Panel in the Custom Action Wizard

Panel Option Value

Type Select the type of custom action that you want to create. For this example, select Launch an
executable.

Location The selection that you make depends on where the target executable file will be during the
installation. Because Notepad is on everyone’s machine, it is the target for this custom action.
Because Notepad is practically guaranteed to be present in the target machine’s Windows folder,
you can point to it using the Directory table. Therefore, select Stored in the Directory table.

Action Parameters
Table 4-11 • Settings for the Action Parameters Panel in the Custom Action Wizard

Panel Option Value

Source Since you choose to launch an executable file stored in the Directory table, you are given a list of
choices that reflect all of your current entries in the Directory table. One of these options is
WindowsFolder. Choose this option to point to Notepad without having to hard-code a path.

Target For this option, you need to enter the target file within the specified directory from the Source
option. Enter Notepad.exe and click the Next button to continue.

Additional Options
Table 4-12 • Settings for the Additional Options Panel in the Custom Action Wizard

Panel Option Value

Return Specify how Windows Installer should control the processing of the custom action thread. You can
Processing have the main and custom action threads run synchronously (the installation waits for the custom
action thread to complete before resuming the main installation thread) or asynchronously (the
installation runs the custom action simultaneously as the main installation continues).

In this example, select the Synchronous (Check exit code) option.

InstallShield 2020 User Guide ISP-2600-UG00 909

Chapter 4
Customizing Installation Behavior

Respond Options
Table 4-13 • Settings for the Respond Options Panel in the Custom Action Wizard

Panel Option Value

In-Script Select Immediate execution to have your action executed as soon as it is encountered in the script.
Execution

Execution Select Always execute so that your custom action launches every time that it is encountered.
Scheduling

Inserting Custom Actions into Sequences

After you have created a custom action, you must insert it into a sequence in the Custom Actions and Sequences view.

See Also
Launching an Installation from Another InstallScript Installation

Using Msiexec.exe to Launch a Second Windows Installer Installation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

An alternative to launching a second .msi package using the nested installation custom action type is to create a custom
action that launches Msiexec.exe instead. Launching a second installation in this manner causes it to run in its own
process and creates the proper entries on the target system. In addition, the uninstallation process is much more effective
when you launch your second installation in this way. Registry entries are properly cleaned up and reference counts are
incremented and decremented accurately.

Creating a Custom Action

The first step is to create your custom action. The easiest way to do this is to use the Custom Action Wizard.

910 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Task To create a custom action using the wizard:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI, InstallScript MSI, MSI
Database, and Transform projects) or Custom Actions (in DIM, Merge Module, and MSM Database projects).

2. Right-click the Custom Actions explorer and click Custom Action Wizard. The Custom Action Wizard opens.

3. On the Basic Information panel, specify a name and comment for your custom action and click Next.

4. On the Action Type panel, in the Type list, select Launch an executable. In the Location list, select Stored in the
Directory table. The Directory table allows you to choose from predefined folders, such as SystemFolder, which is
where Msiexec.exe is located.

5. On the Action Parameters panel, browse for the executable file (Msiexec.exe) of that you are launching. The Target
box enables you to specify the name of the executable file that you would like to launch, as well as any command-line
parameters that you would like to pass to it. For example:

msiexec.exe /i "[SOURCEDIR]AnotherSetup\SecondSetup.msi" /qb

The first part of this entry, msiexec.exe, is the name of the executable file that you would like to launch. The next
section, /i "[SOURCEDIR]AnotherSetup\SecondSetup.msi", tells Msiexec.exe which package to run. In this case, it
is pointing to a file one folder below that of the source folder of the initial installation. Finally, /qb tells the Windows
Installer service to run the installation with minimal user interface. Only a progress bar is displayed.

6. On the Additional Options panel, select the default options and click Next until you finish the wizard.

Inserting a Custom Action into a Sequence

After you have created a custom action, you need to insert it into a sequence.

Task To sequence this custom action:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI, InstallScript MSI, MSI
Database, and Transform projects) or Custom Actions (in Merge Module and MSM Database projects).

2. In the Sequences explorer, under the Installation sequence, expand the User Interface item. The actions and dialogs
that are scheduled for this sequence are listed.

3. Right-click CostFinalize and click Insert. The Insert Action dialog box opens.

4. Select the new custom action.

5. Click OK.

Next, verify that the installation package that you want to launch is located in the folder that you specified in the Action
Parameters panel, build your installation, and run it.

Note • A custom action that launches Msiexec.exe must be placed in the User Interface sequence, which means that the
custom action will not run if the end user runs the installation silently.

InstallShield 2020 User Guide ISP-2600-UG00 911

Chapter 4
Customizing Installation Behavior

See Also
Nested Installations
MsiExec.exe Command-Line Parameters

Nested Installations
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Important • Nested installations is a deprecated feature of the Windows Installer. Applications installed with nested
installations sometimes fail because they are difficult for end users to service correctly. Microsoft Corporation recommends
that you avoid using nested installations and nested-installation custom actions to install products that are intended to be
released to the public. To learn more, see Concurrent Installations in the Windows Installer Help Library.

A nested installation is a type of custom action that installs or removes another .msi package (sometimes called the child
product) from within a running installation (called the parent product).

Note • Before using nested-installation custom actions, you should be aware of the following restrictions:

• Nested installations do not display a user interface.

• A child product generally does not appear in Add or Remove Programs in Control Panel on the end user’s system, and it is
not automatically uninstalled when the parent product is uninstalled.

Creating Nested Installation Custom Actions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Important • Nested installations is a deprecated feature of the Windows Installer. Applications installed with nested
installations sometimes fail because they are difficult for end users to service correctly. Microsoft Corporation recommends

912 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

that you avoid using nested installations and nested-installation custom actions to install products that are intended to be
released to the public. To learn more, see Concurrent Installations in the Windows Installer Help Library.

Task To create a nested installation custom action using the wizard:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. Right-click the Custom Actions explorer and click Custom Action Wizard. The Custom Action Wizard opens.

3. On Basic Information panel, specify a name and comment for your custom action and click Next.

4. On the Action Type panel, in the Type list, select Launch another .msi package. In the Location list, select Included
within your main setup.

5. On the Action Parameters panel, browse for the location of the .msi file that you are launching. (For simplicity,
assume that the child product is packaged with all files compressed into the .msi package.) The Target box enables
you to specify command-line switches to pass to the child installation. For example, to install all of the features of the
child installation with their default settings, and to use the same value for the ALLUSERS property used by the parent
installation, type the following in the Target box:

ARPSYSTEMCOMPONENT=1 ADDDEFAULT=ALL ALLUSERS=[ALLUSERS]

You can use similar expressions to use the same value of INSTALLDIR in the child as in the parent.

6. Accept the default options on the Additional Options panel and click Next until you finish the wizard.

Inserting Nested Installation Custom Actions into Sequences

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Important • Nested installations is a deprecated feature of the Windows Installer. Applications installed with nested
installations sometimes fail because they are difficult for end users to service correctly. Microsoft Corporation recommends
that you avoid using nested installations and nested-installation custom actions to install products that are intended to be
released to the public. To learn more, see Concurrent Installations in the Windows Installer Help Library.

After you have created the custom action, you need to insert it into a sequence.

InstallShield 2020 User Guide ISP-2600-UG00 913

Chapter 4
Customizing Installation Behavior

Task To insert a nested installation custom action into a sequence:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Sequences explorer, under the Installation sequence, expand the User Interface item. The actions and dialogs
that are scheduled for this sequence are listed.

3. Right-click CostFinalize and click Insert. The Insert Action dialog box opens.

4. Select the new custom action.

5. In the Condition box, type Not Installed. This indicates that the nested installation should be performed only the
first time that the parent product is installed.

6. Click OK.

Removing Child Products

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Important • Nested installations is a deprecated feature of the Windows Installer. Applications installed with nested
installations sometimes fail because they are difficult for end users to service correctly. Microsoft Corporation recommends
that you avoid using nested installations and nested-installation custom actions to install products that are intended to be
released to the public. To learn more, see Concurrent Installations in the Windows Installer Help Library.

A child product is not automatically removed when the parent product is removed. However, you can create a second
nested-installation custom action that does this.

Task To create the custom action:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. Right-click the Custom Actions explorer and click Custom Action Wizard. The Custom Action Wizard opens.

3. On the Basic Information panel, specify a name and comment for your custom action and click Next.

4. On the Action Type panel, in the Type list, select Launch another .msi package. In the Location list, select An
application that is advertised or already installed.

5. On the Action Parameters panel, browse for the location of the .msi file that you want to remove. In the Target box,
leave the default properties:

ALLUSERS=[ALLUSERS] REMOVE=ALL

914 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

6. Accept the default options on the Additional Options panel and click Next until you finish the wizard.

Task To sequence this custom action:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Sequences explorer, under the Installation sequence, expand the Execute item. The actions and dialogs that
are scheduled for this sequence are listed.

3. Right-click InstallValidate and click Insert. The Insert Action dialog box opens.

4. Select the new custom action.

5. In the Condition box, type the following:

REMOVE="ALL"

6. Click OK.

This custom action will uninstall the child product when the parent product is uninstalled.

Note • When you are creating a nested-installation custom action of type Launch another .msi package with the Location
setting set to Stored on the source media, be aware of the following:

• The child installation must not be compressed inside a Setup.exe installation launcher.
• If the child installation’s files are not compressed inside the child .msi database, you must manually copy the child
installation’s files to the Disk1 folder of the parent installation’s release folder.

See Also
Using Msiexec.exe to Launch a Second Windows Installer Installation
DoInstall
Action Parameters Panel (in the Custom Action Wizard)

Calling MessageBoxA in an Installation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

Task To call the Windows API function MessageBoxA() in a custom action to display a message box:

Part A: Launch the Custom Action Wizard

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. Right-click the Custom Actions explorer and click Custom Action Wizard.

InstallShield 2020 User Guide ISP-2600-UG00 915

Chapter 4
Customizing Installation Behavior

Part B: Start a Custom Action

1. In the Basic Information panel, type CA_Example for the custom action’s name. Click Next.

2. In the Action Type panel, for the custom action’s type, select Call a function in a standard dynamic-link library.

3. Since MessageBoxA is exported in User32.dll, which is found on every supported Windows platform, select
Destination machine search path in the Location list. Click Next to continue.

Part C: Provide the Function Definition

MessageBoxA() has the following syntax:

int MessageBoxA (hWnd, lpText, lpCaption, uType);

Specify this information in the Function Definition panel:

1. In the Name box, type MessageBoxA.

2. Click the last row in the Arguments box to specify the first parameter. Edit the fields for each parameter until they
mirror the following list:

Table 4-14 • Parameters for the Arguments Box

Type Source Value

HWND Constant MsiWindowHandle

STRING in Property MESSAGEPROP

STRING in Property CAPTIONPROP

NUMBER Constant 1

In the Value list for the HWND type, select MsiWindowHandle. If you set the HWND type to this value, your message
box will not hide behind the installation window. The properties MESSAGEPROP and CAPTIONPROP are not available in
the list. When you enter these names in the Value list, they are added to the Property Manager.

3. In the Return Type list, select void. (Although MessageBoxA() does return a number, checking that value in a
property is outside the scope of this example.)

4. Click Next to proceed to the Action Parameters panel.

Part D: Specify the Source for MessageBoxA

The next significant setting in the Custom Action Wizard is the Source field in the Action Parameters panel. MessageBoxA is
found in User32.dll. Click the Browse button to locate User32.dll in your Windows system folder.

In the next panel of the wizard, click Next to accept the defaults, and then click Finish in the Summary panel to dismiss the
wizard and add CA_Example to your project.

916 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Part E: Initialize the Properties’ Values

For the string parameters in MessageBoxA(), properties were provided, as described in the above procedures. The next
step is to give those properties a value:

1. In the View List under Behavior and Logic, click Property Manager to view the installer properties in your project.
The properties MESSAGEPROP and CAPTIONPROP were created as a result of referencing these properties in the Custom
Action Wizard.

2. Locate MESSAGEPROP and click in its Value column to supply a value. Enter Can you see this text? for the value.

3. Set the CAPTIONPROP property to Custom Action Example.

Part F: Insert the Custom Action into a Sequence

In order to execute the custom action, you must either place it into a sequence or make it the result of a dialog’s control
event.

Follow the steps below to insert CA_Example into the Installation sequence of the installation project:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Sequences explorer, under the Installation sequence, expand the User Interface item. The actions and dialogs
that are scheduled for this sequence are listed.

3. Right-click the MigrateFeatureStates action (the action right before the InstallWelcome dialog) and click Insert. The
Insert Action dialog box opens.

4. In the list at the top of the dialog box, select Custom Actions (for installation projects).

5. In the list of custom actions, select CA_Example.

6. Click OK.

CA_Example is added to the Installation sequence directly after MigrateFeatureStates.

Part G: Test the Call to MessageBoxA

1. Build a release. (The Output window may show build errors if you have not added any components or files to your
project.)

2. On the Build menu, click Run.

InstallShield runs your installation. After the Welcome dialog is displayed, a Custom Action Example message box opens.

See Also
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties

Searching for Files on the Target System

InstallShield 2020

System Search View

The System Search view provides the functionality for locating a particular file, folder, registry or .ini file on a target system
before installing your application.

InstallShield 2020 User Guide ISP-2600-UG00 917

Chapter 4
Customizing Installation Behavior

Direct Editor: Basic MSI Projects

Windows Installer uses records in the Signature, AppSearch, and “locator” tables for instructions for searching for files on
the target system. The Signature table contains information about the file to be located, and the AppSearch table
specifies a property to set to the full path of the located file, if found.

For example, to search for a file called FindMe.exe, use the Direct Editor to add the following record to the Signature
table.

Table 4-15 • Sample Data for the Signature Table

Table Column Sample Data

Signature findme_sig

FileName FindMe.exe

Note that other fields in the Signature table enable you to specify optional version, size, date, and language information.

Add the following record to the AppSearch table.

Table 4-16 • Sample Data for the AppSearch Table

Table Column Sample Data Explanation

Property LOCATION_OF_FINDME Must be a public property.

Signature_ findme_sig Same name used in Signature table.

There are four locator tables in which you can specify where Windows Installer should begin searching for the file:
CompLocator, RegLocator, IniLocator, and DrLocator. To search for a file in a specific directory, use the DrLocator
table. For example, to search for FindMe.exe in the user’s Program Files directory, we add the following record to the
DrLocator table.

Table 4-17 • Sample Data for the DrLocator Table

Table Column Sample Data

Signature findme_sig

Parent

Path [ProgramFilesFolder]

Depth 2

After the AppSearch action runs, the public property LOCATION_OF_FINDME will contain the full path to FindMe.exe on the
end user’s system if it exists; if the file is not located, this property will be undefined.

918 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

InstallScript: InstallScript MSI Projects

The FindFile and FindAllFiles functions enable you to search for existing files on the target system. For example, an
implementation of the OnAppSearch event-handler function that searches for a file called FindMe.exe in the user’s
Program Files folder might appear as follows:

function OnAppSearch( )

STRING svFoundFile;

begin

FindAllFiles(PROGRAMFILES, "FindMe.exe", svFoundFile, RESET);

MessageBox("Found FindMe.exe at: " + svFoundFile, INFORMATION);

end;

See Also
System Search View
Direct Editor

Launching the Application After the Installation Is Complete

InstallShield 2020

The LaunchApplication function launches an executable file. For example, the following code launches a copy of
Program.exe in the end user’s INSTALLDIR folder, returning execution to the script when the end user closes the program’s
window.

LaunchApplication (INSTALLDIR ^ "Program.exe", "", "", SW_NORMAL,"", LAAW_OPTION_WAIT);

Project • InstallScript projects use TARGETDIR rather than INSTALLDIR.

Exiting the Installation from Within an InstallScript Custom Action

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI with InstallScript custom actions

• InstallScript MSI
• Merge Module with InstallScript custom actions

An InstallScript entry-point function that returns the value ERROR_INSTALL_FAILURE causes the installation to exit.

See Also
exit
abort

InstallShield 2020 User Guide ISP-2600-UG00 919

Chapter 4
Customizing Installation Behavior

Changing ODBC Properties Through Script

InstallShield 2020

If you want to change ODBC properties (such as DBQ and SystemDB) through script, you must configure these options to
use installer properties. Then from the script you can set those installer properties at run time. For example, you would set
SystemDB to [SYSTEM_DB_DIR]\MyDatabase in the InstallShield interface. Then from the script, you could call
MsiSetProperty to set the value of SYSTEM_DB_DIR.

Tip • Set the property value before the OnMoving event, preferably in OnFirstUIBefore. After that, it is too late because the
installer has already built up its internal script information, which cannot be modified.

• Use all uppercase letters for your property name.

• If SYSTEM_DB_DIR exists in the Directory table, omit the backslash (\) after the right bracket (]) when making your ODBC
attribute settings. If you have defined it in the Property Manager, the backslash must be included.

Using the INSTALLDIR Property in a VBScript Custom Action

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

If you need to use the INSTALLDIR property in a VBScript custom action, use the Property property of the Session object.
This object is accessible in every VBScript custom action.

Following is sample code:

szInstallDir = Session.Property("INSTALLDIR")

For more information, see Session Object in the Windows Installer Help Library.

Using Action Text

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

920 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• MSI Database
• Transform

To keep end users informed, installations commonly display text on the progress dialog to describe the installation’s
current activity. This usually accompanies the progress bar as a means of installation status. As each standard action and
custom action is encountered, a message about the action is displayed on the progress dialog. This may be especially
useful for actions that take a long time to execute. The same action text is also written to the installation’s log file if one is
created.

An action can also send action data that needs to be processed to the Windows Installer; once the data is processed, it can
be displayed on the progress dialog.

For example, when the InstallFiles action is executing, the action text “Copying new files” is displayed by default on the
progress dialog. This action text is also written to the installation’s log file. If you want to provide additional detailed
information about what is occurring as actions are encountered, you can add a control to the progress dialog to show
action details; the control would need to subscribe to the ActionData event. For the InstallFiles action, this could include
the name, directory, and size of each file as it is being installed on the target system.

Project • InstallScript MSI installations cannot display action data on the status dialog. However, the template is written to
the installation’s log file.

See Also
Specifying an Action Description and a Template for Action Data
Displaying Action Descriptions on the Progress Dialog
Displaying Action Data on the Progress Dialog

Specifying an Action Description and a Template for Action Data

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

InstallShield includes default action descriptions for standard actions and built-in InstallShield custom actions.
InstallShield also includes default templates for many of those actions where appropriate. The templates indicate the
format that should be used for the action data.

You may want to modify the default descriptions or templates of the standard actions and built-in InstallShield custom
actions in your project. In addition, you may want to specify action text and action data format for your own custom
actions.

InstallShield 2020 User Guide ISP-2600-UG00 921

Chapter 4
Customizing Installation Behavior

Task To specify a description and an action data template for an action in your project:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. Right-click the Action Text explorer and click New. InstallShield adds a new action text item.

3. For the name of the action text item, enter the name of the action.

Important • The names of the action text items under the Action Text explorer should match the names of standard and
custom actions that are in your project. If you change the name of a custom action, you must also change the name of its
action text item; otherwise, the action’s text is not displayed at run time or written to the installation’s log file. Note,
however, that you are not required to create action text for every action in your project.

4. In the right pane, specify the description and the template. For more information, see Action Text Settings.

Tip • If you want to edit the description or template of an action that is already listed under the Action Text explorer, select the
action and then specify the appropriate values in the right pane.

See Also
Displaying Action Descriptions on the Progress Dialog
Displaying Action Data on the Progress Dialog
Custom Actions and Sequences View (or Custom Actions View)

Displaying Action Descriptions on the Progress Dialog

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

In InstallScript MSI installations, the action text is automatically displayed on the progress dialog (that is, the STATUSEX
dialog) if the dialog is enabled through a call to Enable (STATUSEX). This dialog is not available for editing.

By default, if a description has been specified for an action in your installation, that description is displayed above the
progress bar on the progress dialog. Therefore, unless you have made some changes to this dialog in your project, you do
not need to perform the following steps.

Task To display action descriptions on the progress dialog:

1. On the SetupProgress dialog, add a control that will display the action description:

a. In the View List under User Interface, click Dialogs.

922 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

b. In the Dialogs explorer, expand the All Dialogs folder, and then expand the SetupProgress dialog.

c. Click a language under the SetupProgress dialog. The Dialog Editor in the center pane shows the dialog in the
selected language.

d. In the Controls toolbar, click the Text Area control.

e. Draw a rectangle on the dialog in the location where you want the action description to be displayed.

2. With the control selected, configure its settings in the right pane:

a. For the (Name) setting, enter the following:

ActionText

b. In the Text setting, delete the value.

3. Add a subscription for the ActionText event to the new control:

a. In the Dialogs explorer under the SetupProgress dialog, click the Behavior item. The grid in the center pane
shows all of the controls on the SetupProgress dialog.

b. Select the ActionText control that you just created, and then click the Subscriptions tab in the lower-right pane.

c. In the upper-right pane, add a record with the following information: For the Event field, select ActionText. For
the Attribute field, enter Text.

At run time, if the installation is run with a full or reduced user interface, the progress dialog shows the description of each
action as it is encountered. If a description has not been defined for an action, no description is displayed on the progress
dialog when that action is launched.

See Also
Displaying Action Data on the Progress Dialog
Dialogs View (Basic MSI and Other Windows Installer–Based Projects)

Displaying Action Data on the Progress Dialog

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

In InstallScript MSI installations, the action data cannot be displayed on the progress dialog (that is, the STATUSEX dialog).
However, you can call Enable (INDVFILESTATUS) in your InstallScript to achieve a similar result. If you call the INDVFILESTATUS
constant with the Enable function, the STATUSEX dialog shows the fully qualified file name of each file as it is transferred when
FeatureMoveData, CopyFile, or XCopyFile is called and the progress indicator is enabled. Note that if a template is specified
for an action in an InstallScript MSI project, the template is written to the installation’s log file.

InstallShield 2020 User Guide ISP-2600-UG00 923

Chapter 4
Customizing Installation Behavior

If you want to provide detailed information about what is occurring as actions are launched at run time, you can add a
control to the progress dialog to show action details; the control would need to subscribe to the ActionData event. For
example, when the InstallFiles action is executing, the control that shows the action details could include the name,
directory, and size of each file as it is being installed on the target system.

Task To display the action data on the progress dialog:

1. On the SetupProgress dialog, add a control that will display the action details:

a. In the View List under User Interface, click Dialogs.

b. In the Dialogs explorer, expand the All Dialogs folder, and then expand the SetupProgress dialog.

c. Click a language under the SetupProgress dialog. The Dialog Editor in the center pane shows the dialog in the
selected language.

d. In the Controls toolbar, click the Text Area control.

e. Draw a rectangle on the dialog in the location where you want the action description to be displayed.

2. With the control selected, configure its settings in the right pane:

a. For the (Name) setting, enter the following:

ActionData

b. In the Text setting, delete the value.

3. Add a subscription for the ActionData event to the new control:

a. In the Dialogs explorer under the SetupProgress dialog, click the Behavior item. The grid in the center pane
shows all of the controls on the SetupProgress dialog.

b. Select the ActionData control that you just created, and then click the Subscriptions tab in the lower-right pane.

c. In the upper-right pane, add a record with the following information: For the Event field, select ActionData. For
the Attribute field, enter Text.

At run time, if the installation is run with a full user interface, the progress dialog shows the details of each action as it is
launched. If a template has not been defined for an action, the details are not displayed on the progress dialog when that
action is launched.

See Also
Enable
Displaying Action Descriptions on the Progress Dialog
Dialogs View (Basic MSI and Other Windows Installer–Based Projects)

Removing an Action Description or a Template for Action Data

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

924 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• InstallScript MSI
• MSI Database
• Transform

Task To remove a description or an action data template for an action in your project:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Action Text explorer, select the action whose description or template you want to delete.

3. In the Description setting or the Template setting, delete the value.

Note • If you want neither the action description or the action template to be used, you can delete the action text record from
your project: In the Action Text explorer, right-click the action text item that you want to remove, and then click Delete.

Note that the action text for the following actions cannot be deleted:

• GenerateScript
• Rollback
• RollbackCleanup

In addition, the value of the Template setting for each of these actions must always be [1].

See Also
Custom Actions and Sequences View (or Custom Actions View)

Defining Sequences
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Defining the sequences of an installation is an important part of developing an installer package. Sequences specify the
order in which Windows Installer launches the standard and custom actions that control the installation process.

Project • In Basic MSI and Transform projects, sequences also specify the order in which the dialogs are displayed.

In InstallScript MSI projects, the user-interface dialogs are defined in the InstallScript code, and the InstallScript engine
controls the user interface part of the installation.

InstallShield 2020 User Guide ISP-2600-UG00 925

Chapter 4
Customizing Installation Behavior

The Custom Actions and Sequences view in InstallShield is where you define the sequences of your project. The Sequences
explorer in this view lists all of the actions and dialogs in your project in chronological order, according to when they are
launched during the applicable sequence. Each action and dialog is given a number in the sequence, and Windows Installer
runs the sequence from the lowest number to the highest number.

Rather than having to manually provide a numeric value for every custom action and dialog that you add to your project,
you can use the Custom Actions and Sequences view to insert actions or dialogs into a sequence or edit the sequence
timeline. Refer to this section of the help for information about sequences.

Project • If you create a custom action or a custom dialog in a merge module, you need to first import that module into an
installation project and then add it to a sequence through the Custom Actions and Sequences view.

See Also
Custom Actions and Sequences View (or Custom Actions View)

Installation Sequence
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The installation sequence is the series of actions that are executed when the installation runs in the default installation
mode, such as when an end user double-clicks a new .msi file. These actions are broken down into two types:

• User Interface

• Execute

Project • The User Interface dialogs described below are those for a Basic MSI project. For an InstallScript MSI project, your
InstallScript code performs the user interface of the installation.

An InstallScript MSI project automatically includes the ISVerifyScriptingRuntime custom action. For details, see
ISVerifyScriptingRuntime.

User Interface
The User Interface sequence contains all of the actions and dialogs needed to support a full user interface. This sequence is
skipped if an installation is run in silent mode.

926 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

For complete technical details about each standard action, see the Standard Actions Reference in the Windows Installer
Help Library.

Table 4-18 • User-Interface Actions and Dialogs in the Installation Sequence

Name of Action or Dialog Type of Event Description

SetupCompleteError Dialog This dialog is displayed at the end of an installation if that

installation was terminated because of a fatal error.

SetupInterrupted Dialog This dialog is displayed at the end of an installation that was
ended by the user.

SetupCompleteSuccess Dialog This dialog is displayed at the end of a successful installation.

ISSetupFilesExtract Custom action This custom action extracts any files that you have added in the
Support Files view. For more information, see Using Support
Files.

ISSetAllUsers Custom action The ISSetAllUsers custom action is inserted in the both the User
Interface and Execute installation sequences only if one or
more records are in the Upgrade table.

AppSearch Standard action This action can be used to identify and locate files on the target
system. The Signature table that this action requires is available
in the Direct Editor. Knowledge Base article Q103147 provides
detailed information on using this action.

LaunchConditions Standard action This action evaluates a set of conditions that must return True if
the installation is to continue. If any conditions fails, the user is
presented with an error message and the installation ends.
Launch conditions can be edited in the General information
view.

SetupInitialization Dialog This dialog is displayed while the setup is preparing to begin.
The default text for this dialog is "Preparing to install..."

FindRelatedProducts Standard action When this action is executed, the installer compares each
installed product’s upgrade code to that listed in the package’s
Upgrade table. If a match is found, the installed package’s
product code is added to the ActionProperty column of the
Upgrade table.

CCPSearch Standard action The CCPSearch action allows you to check the end user’s
system for products qualifying for upgrade. The Signature table
that this action requires is available in the Direct Editor.

InstallShield 2020 User Guide ISP-2600-UG00 927

Chapter 4
Customizing Installation Behavior

Table 4-18 • User-Interface Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

RMCCPSearch Standard action The RMCCPSearch action allows you to check an end user’s
system for products qualifying for competitive upgrade. The
Signature table that this action requires is available in the
Direct Editor.

ValidateProductID Standard action Use the Validate Product ID action to set the ProductID property
to the complete product identifier. This validation allows you to
protect your software from illegal use by requiring users to
enter the product ID.

CostInitialize Standard action This action is the first step in determining how much disk space
is required by the current configuration of the installation. In
order to complete costing, you need to use the CostInitialize
action in conjunction with the CostFinalize action.

FileCost Standard action The FileCost action determines how much disk space is
required by the current configuration of the installation. It
checks to see if any files will be overwritten with later versions,
and it calculates how overwriting those files affects disk space.
To complete costing, you need to use the CostInitialize action in
conjunction with the CostFinalize action.

IsolateComponents Standard action This action installs a component—usually a DLL file—into an

isolated location so that it is used by only your application.

setUserProfileNT Custom action This custom action initializes the USERPROFILE directory
identifier.

SetAllUsersProfileNT Custom action This custom action initializes the ALLUSERSPROFILE directory
identifier.

setAllUsersProfile2K Custom action This custom action initializes the ALLUSERSPROFILE directory
identifier.

ResolveSource Standard action Finds the location of the source and sets the SourceDir
property.

CostFinalize Standard action The Calculate Disk Space action determines the total amount of
disk space required by the installation in its current
configuration. This action also verifies that all target directories
are writable. The actions Initialize Disk Space Calculations and
Initialize Dynamic Disk Space Calculations must be called
before the Calculate Disk Space action; otherwise, the action
will fail.

928 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-18 • User-Interface Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

SetARPReadme Custom action The SetARPReadme custom action resolves the directory
identifier used in the Read Me setting in the General
Information view. This custom action is required because
ARPREADME is a Windows Installer property and these
properties do not format automatically.

MigrateFeatureStates Standard action This action is used during application upgrade. The feature
states of the original installation are read from the target
machine and applied to the upgraded features.

PatchWelcome Dialog The PatchWelcome dialog is displayed when a patch package is

applied with a full user interface. It includes control events to
set REINSTALL and REINSTALLMODE with the correct options.
However, when the user interface is suppressed, you must set
the properties at the command line.

InstallWelcome Dialog The InstallWelcome dialog displays your Welcome panel when
an InstallScript MSI installation is run.

SetupResume Dialog This dialog opens when a previously canceled installation is

resumed.

MaintenanceWelcome Dialog This dialog opens when the end user tries to change a
program’s installed features, remove the program, reinstall the
program, run an installation for the second time, or select the
current product in Add or Remove Programs.

SetupProgress Dialog This dialog displays the installation’s progress.

ExecuteAction Standard action This action queries the EXECUTEACTION property to determine
which top-level action should be called first, and then calls that
top-level action. Top-level actions include the INSTALL,
ADVERTISE, and ADMIN actions. Typically, this action starts the
Installation Execute sequence.

ISSetupFilesCleanup Custom action This custom action appears when you add a file in the Support
Files view. For more information, see Using Support Files.

InstallShield 2020 User Guide ISP-2600-UG00 929

Chapter 4
Customizing Installation Behavior

Execute
The Execute sequence contains all of the actions that can change the machine’s state and do not rely upon the user
interface in order to function properly. These actions include file transfer, publishing components and features, and
registering COM servers. Most of the Execute sequence is skipped when you run your installation in test mode, except for
custom actions that have been inserted into the sequence.

Table 4-19 • Execute Actions and Dialogs in the Installation Sequence

Name of Action or Dialog Type of Event Description

ISSetupFilesExtract Custom action This custom action extracts any files that you have added in the
Support Files view. For more information, see Using Support
Files.

ISSetAllUsers Custom action The ISSetAllUsers custom action is inserted in the both the
User Interface and Execute installation sequences only if one or
more records are in the Upgrade table.

AppSearch Standard action This action can be used to identify and locate earlier versions of
your product. The Signature table that this action requires is
available in the Direct Editor. Knowledge Base article Q103147
provides detailed information on using this action.

LaunchConditions Standard action This action evaluates a set of conditions that must return True
if the installation is to continue. If any condition fails, the
installation displays an error message and the installation
ends. You can edit launch conditions in the General
Information view.

FindRelatedProducts Standard action When this action is executed, the installer compares each
installed product’s upgrade code to that listed in the package’s
Upgrade table (supported in the Direct Editor). If a match is
found, the installed package’s product code is added to the
ActionProperty column of the Upgrade table.

CCPSearch Standard action The CCPSearch action enables you to check the end user’s
system for products qualifying for upgrade. The Signature
table that this action requires is available in the Direct Editor.

RMCCPSearch Standard action The RMCCPSearch action enables you to check an end user’s
system for products qualifying for competitive upgrade. The
Signature table that this action requires is available in the
Direct Editor.

ValidateProductID Standard action Use the ValidateProductID action to set the ProductID property
to the complete product identifier. Validation allows you to
protect your software from illegal use by requiring end users to
enter the product ID.

930 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-19 • Execute Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

CostInitialize Standard action This action is the first step in determining how much disk space
is required by the current installation configuration.

FileCost Standard action This action determines how much disk space will be required
by the current installation configuration. This action checks to
see if any files will be overwritten with newer versions and
calculates how overwriting those files will affect disk space.

IsolateComponents Standard action This action installs a component—usually a DLL file—into an

isolated location so that it will be used by only your
application.

CostFinalize Standard action The CostFinalize action determines the total amount of disk
space required by the current installation configuration. This
action also verifies that all target directories are writable.

SetARPINSTALLLOCATION Custom action The SetARPINSTALLLOCATION custom action sets the value of
the ARPINSTALLLOCATION property to the fully qualified path
for the application’s primary folder.

SetODBCFolders Standard action The SetODBCFolders action checks for existing ODBC drivers
on the target system and sets the target directory of each new
driver to the location of an existing driver.

MigrateFeatureStatus Standard action This action is used during application upgrade. The feature
states of the original installation are read from the target
machine and applied to the upgraded features.

InstallValidate Standard action The InstallValidate action determines if there is enough disk
space available for the current installation configuration.

RemoveExistingProducts Standard action The RemoveExistingProducts action performs a silent

uninstallation of any products whose code appear in
OLDPRODUCTS.

InstallInitialize Standard action The InstallInitialize action signals the beginning of the actions
that make changes to the end user’s system.

AllocateRegistrySpace Standard action The installer makes sure that the system has at least as much
free registry space available as specified in the
AVAILABLEFREEREG property when it performs this action.

ProcessComponents Standard action The ProcessComponents action is responsible for

unregistering and registering components. This action also
registers or unregisters a component’s key path and any other
clients that the component has.

InstallShield 2020 User Guide ISP-2600-UG00 931

Chapter 4
Customizing Installation Behavior

Table 4-19 • Execute Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

UnpublishComponents Standard action This action, called during uninstallation, unpublishes

components that were published by your original installation,
even if those components have been published by other
applications.

MsiUnpublishAssemblies Standard action The MsiUnpublishAssemblies action handles uninstallation of

the assembly with the operating system.

UnpublishFeatures Standard action The UnpublishFeatures action removes all references to

features that were originally published during installation.
These references include registry entries that contain
selection-state and feature-component mapping information.

StopServices Standard action This action stops the Windows services that are configured to
be stopped. For more information, see Installing, Controlling,
and Configuring Windows Services.

DeleteServices Standard action This action removes the Windows services that are configured
to be deleted. For more information, see Installing, Controlling,
and Configuring Windows Services.

UnregisterComPlus Standard action This action unregisters COM+ applications.

SelfUnregModules Standard action This action unregisters files registered by data in the SelfReg
table.

UnregisterTypeLibraries Standard action During uninstallation, this action unregisters every file in the
TypeLib table that is marked for uninstallation. This table is
populated when you create a new TypeLib through the COM
Registration advanced setting.

RemoveODBC Standard action During uninstallation, this action queries the ODBCDataSource
table, ODBCTranslator table, and ODBCDriver table to find
which ODBC resources should be removed during
uninstallation. The resources that are marked for removal are
uninstalled.

UnregisterFonts Standard action This action unregisters information about all the fonts that are
set for uninstallation.

932 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-19 • Execute Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

RemoveRegistryValues Standard action The RemoveRegistryValues action removes values from the
end user’s registry if all of the following conditions are met:

• The values have been authored into the Registry table.

• The values are marked for uninstallation.

• The component to which the registry entry belongs is set

to run from source or is installed locally.

UnregisterClassInfo Standard action This action manages system registry information removal for
COM classes that belong to features that are being uninstalled.

UnregisterExtensionInfo Standard action This action unregisters all extension-related information from
the end user’s system during uninstallation.

UnregisterProgIdInfo Standard action This action unregisters all of the ProgIDs created in the File
Types advanced setting.

UnregisterMIMEInfo Standard action This action queries the MIME table of the current feature that is
being uninstalled, and unregisters the MIME information for
the servers found therein. This information is created through
the File Types advanced setting.

RemoveIniValues Standard action This action removes only the .ini information that has been
associated with a component in the IniFile table—or using
the INI File Changes view. After verifying the presence in the
IniFile table, this action removes all .ini files that are listed in
the RemoveIniFile table if the component with which those
files are associated is marked for uninstallation and the
component was installed locally or set to run from source. The
RemoveIniValues action also removes all .ini files that were
written with the WriteIniValues action if the components with
which they are associated are marked to be uninstalled.

RemoveShortcuts Standard action This action removes all advertised shortcuts to features that
are marked for uninstallation. It also removes all non-
advertised shortcuts to components that are marked for
uninstallation.

RemoveEnvironmentStrings Standard action When a component is removed, this action reverses any
changes made to environment variables by the
WriteEnvironmentStrings action during installation or
reinstallation. You can specify environment variable changes
using the Environment Variables view.

InstallShield 2020 User Guide ISP-2600-UG00 933

Chapter 4
Customizing Installation Behavior

Table 4-19 • Execute Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

RemoveDuplicateFiles Standard action This action removes files that were created by the
DuplicateFiles action. For this action to succeed, the
component associated with the duplicate file must be marked
for uninstallation.

RemoveFiles Standard action This action removes files that were originally installed by the
InstallFiles action, if those files were set to run from source or
installed locally, and the component with which they are
associated is marked for uninstallation.

RemoveFolders Standard action The Remove Folders action unregisters and removes any
empty folders that are associated with components that are
marked for uninstallation and run from source.

CreateFolders Standard action This action creates empty folders for components that are set
to be installed locally. These new folders are then registered
with the associated component GUID (found in the
component’s Component Code property).

MoveFiles Standard action This action enables you to move or copy files that already exist
on the target system. The MoveFiles table, used by this action,
is available in the Direct Editor.

InstallFiles Standard action The InstallFiles action copies all of the selected feature’s files
to the target machine if the component feature to which those
files belong is marked for installation. Only files that are
associated with components that are to be installed locally are
copied to the target machine.

PatchFiles Standard action This action queries the Patch table to determine which
installed files have patches available. Those files undergo the
bit-wise patching process.

DuplicateFiles Standard action The DuplicateFiles action creates copies of certain files
installed with the InstallFiles action. These files can be copied
to the same directory as the original and given a different
name, or they can be copied to a separate directory while
maintaining the original name. The DuplicateFiles table,
used by this action, is available in the Direct Editor.

BindImage Standard action Writes the virtual address of imported DLL file functions in the
file’s import address table, as specified in the BindImage table,
which is available in the Direct Editor.

934 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-19 • Execute Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

CreateShortcuts Standard action This action creates the shortcuts that you specified in the
Shortcuts explorer in the Shortcut view or the Setup Design
view.

RegisterClassInfo Standard action This action registers all of the COM class info that you specified
in the COM Registration advanced setting, or which was
extracted by the Component Wizard or a component’s COM
Extract at Build setting.

RegisterExtensionInfo Standard action The RegisterExtensionInfo action registers all the extensions
that you specified in the File Types advanced setting.

RegisterProgIdInfo Standard action This action registers all of the ProgIDs that you defined in the
Advanced Settings and that are linked to class servers or
extension servers marked for installation.

RegisterMIMEInfo Standard action This action registers all of the MIME types that you defined in
the File Types advanced setting that are linked to class servers
or extension servers marked for installation.

WriteRegistryValues Standard action This action writes registry data to the target system if the
associated component is marked for installation and set to run
from source or installed locally. This registry information is the
same data that you created in the Registry view.

WriteIniValues Standard action This action writes information to .ini files if the component
with which this action is associated is set to be installed locally
or run from source. This action and its corresponding tables are
exposed in the INI File Changes view.

WriteEnvironmentStrings Standard action When a component is installed, this action changes the
environment variables on the system specified in the
Environment table or the Environment Variables view.

RegisterFonts Standard action The RegisterFonts action registers any fonts that you included
in your installation. In most cases, they were included using the
Component Wizard.

InstallODBC Standard action This action installs all of the drivers, translators, and data
sources for the ODBC resources that you specified through the
ODBC Resources view.

RegisterTypeLibraries Standard action This action registers any type libraries that you may have
created in your installation, either through the COM
Registration advanced setting or the Component Wizard.

InstallShield 2020 User Guide ISP-2600-UG00 935

Chapter 4
Customizing Installation Behavior

Table 4-19 • Execute Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

SelfRegModules Standard action This action registers self-registering modules listed in the
SelfReg table. This action is performed with the default user
privileges.

RegisterComPlus Standard action This action registers COM+ applications.

InstallServices Standard action This action installs the Windows services that are configured to
be installed. For more information, see Installing, Controlling,
and Configuring Windows Services.

MsiConfigureServices Standard action This action configures extended customization options for
Windows services. For more information, see Installing,
Controlling, and Configuring Windows Services.

Note • This action is supported beginning with Windows

Installer 5. Earlier versions of Windows Installer ignore this
setting.

StartServices Standard action This action starts all services that are configured to be started.
For more information, see Installing, Controlling, and
Configuring Windows Services.

RegisterUser Standard action This action registers user information to identify the user of the
program.

RegisterProduct Standard action This action registers the product with the installer and saves
the installer database on the target machine.

PublishComponents Standard action This action publishes all components that are associated with
advertised features.

PublishFeatures Standard action This action registers each feature’s installation state. This state
can be absent, advertised, or installed. If the feature is
installed, the PublishFeatures action writes the feature-
component relationship to the registry.

PublishProduct Standard action This action publishes a product if it is being advertised.

ScheduleReboot Standard action Insert the ScheduleReboot action into the action sequence to
prompt the end user to reboot the system at the end of an
installation. The ScheduleReboot action is typically placed at
the end of the sequence.

InstallFinalize Standard action This action is the last transacted step.

936 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-19 • Execute Actions and Dialogs in the Installation Sequence (cont.)

Name of Action or Dialog Type of Event Description

RemoveExistingProducts Standard action This action loops through all the product codes listed in the
Upgrade table and removes those products.

ISSetupFilesCleanup Custom action This custom action appears when you add a file in the Support
Files view. For more information, see Using Support Files.

Advertisement Sequence
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The Advertisement sequence is the list of actions that occur when an end user launches your installation with the /j
command-line option for MsiExec.exe. The built-in actions in this sequence are described in the table below.

User Interface
Validation rule ICE78 requires the Advertisement User Interface sequence to be empty.

Execute
The Execute sequence contains all the actions that do not rely upon the user interface in order to function properly. These
actions include file transfer, publishing components and features, and registering COM servers.

For complete technical details about each standard action, see the Standard Actions Reference in the Windows Installer
Help Library.

Table 4-20 • Execute Actions in the Advertisement Sequence

Action Name Type of Event Description

CostInitialize Standard action The first step in determining how much disk space is required
by the current configuration of the installation.

CostFinalize Standard action Determines the total amount of disk space required by the
installation in its current configuration.

InstallValidate Standard action Determines if there is enough disk space available for the
current configuration.

InstallShield 2020 User Guide ISP-2600-UG00 937

Chapter 4
Customizing Installation Behavior

Table 4-20 • Execute Actions in the Advertisement Sequence (cont.)

Action Name Type of Event Description

InstallInitialize Standard action Marks the beginning of the actions that make changes to the
end user’s system.

CreateShortcuts Standard action Creates the shortcuts specified in the Shortcuts view or the
Setup Design view.

RegisterClassInfo Standard action Registers all of the COM class information specified in the COM
Registration advanced setting.

RegisterExtensionInfo Standard action Registers all of the extensions specified in the File Types
advanced setting.

RegisterProgIdInfo Standard action Registers all of the ProgIDs that defined in the COM
Registration advanced setting if its component is being
advertised.

RegisterMIMEInfo Standard action Registers all of the MIME types that are defined in the File Types
advanced setting if its component is being advertised.

RegisterTypeLibraries Standard action Registers any type libraries that were created in the
installation, either through the COM Registration advanced
setting or the Component Wizard.

PublishComponents Standard action Publishes all components that are associated with features
that are being advertised.

MsiPublishAssemblies Standard action Manages the advertisement of common language run-time

assemblies and Win32 assemblies. The action queries the
MsiAssembly table to determine which assemblies have
features being advertised or installed to the global assembly
cache and which assemblies have a parent component being
advertised or installed to a location isolated for a particular
application.

PublishFeatures Standard action Registers each feature’s installation state. This state can be
absent, advertised, or installed. If the feature is installed, this
action writes the feature-component relationship to the
registry.

PublishProduct Standard action Publishes a product if it is being advertised.

InstallFinalize Standard action The final step of the installation or uninstallation.

See Also
MsiExec.exe Command-Line Parameters

938 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Administration Sequence
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The Administration sequence is the list of actions that execute when a user launches your setup program with the /a
command-line option. The built-in actions and dialogs for this sequence are defined in the tables below.

User Interface
The User Interface sequence contains all of the actions and dialogs needed to support a full user interface. This sequence is
skipped if an installation is run in silent mode.

Project • The User Interface actions described below are those for a Basic MSI project. For an InstallScript MSI project, your
InstallScript code performs the user interface of the installation.

For complete technical details about each standard action, see the Standard Actions Reference in the Windows Installer
Help Library.

Table 4-21 • User-Interface Actions in the Administration Sequence

Action Name Type of Event Description

SetupCompleteError Dialog This dialog is displayed at the end of an installation if it was

terminated because of a fatal error.

SetupInterrupted Dialog This dialog is displayed at the end of an installation that was
ended by the end user.

SetupCompleteSuccess Dialog This dialog is displayed at the end of a successful installation.

SetupInitialization Dialog This dialog is displayed while the installation is preparing to

begin. The default text for this dialog is “Preparing to install...”

CostInitialize Standard action This action is the first step in determining how much disk space
is required by the current configuration of the installation.

FileCost Standard action This action determines how much disk space will be required
by the current configuration of the installation. This action
checks to see if any files will be overwritten with newer
versions, and it calculates how overwriting those files will affect
disk space.

InstallShield 2020 User Guide ISP-2600-UG00 939

Chapter 4
Customizing Installation Behavior

Table 4-21 • User-Interface Actions in the Administration Sequence (cont.)

Action Name Type of Event Description

CostFinalize Standard action The CostFinalize action determines the total amount of disk
space required by the installation in its current configuration.
This action also verifies that all target directories are writable.

AdminWelcome Dialog This is the first dialog displayed during the Administration
sequence.

SetupProgress Dialog This dialog displays the progress of the installation.

ExecuteAction Standard action This action runs the Administration Execute sequence.

Execute
The Execute sequence contains all the actions that do not rely upon the user interface in order to function properly. These
actions include file transfer, publishing components and features, and registering COM servers.

Table 4-22 • Execute Actions and Dialogs in the Administration Sequence

Action Name Type of Event Description

CostInitialize Standard action This action is the first step in determining how much disk space
is required by the current installation configuration.

FileCost Standard action This action determines how much disk space will be required
by the current installation configuration. This action checks to
see if any files will be overwritten with newer versions and
calculates how overwriting those files will affect disk space.

CostFinalize Standard action The CostFinalize action determines the total amount of disk
space required by the installation in its current configuration.
This action also verifies that all target directories are writable.

InstallValidate Standard action The InstallValidate action determines if there is enough disk
space available for the current setup configuration.

InstallInitialize Standard action The InstallInitialize action marks the beginning of the actions
that make changes to the end user’s system.

InstallAdminPackage Standard action This action copies the installation database to the
administrative installation point.

InstallFiles Standard action The InstallFiles action copies all of the files to the target
machine if the feature that those files belong to is slated for
installation. Only files that are associated with components
that are to be installed locally will be copied to the target
machine.

940 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Table 4-22 • Execute Actions and Dialogs in the Administration Sequence (cont.)

Action Name Type of Event Description

InstallFinalize Standard action This action is the final step of the installation or uninstallation.

See Also
MsiExec.exe Command-Line Parameters

User Interface Sequence

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The User Interface sequence contains all of the actions and dialogs required for the default user interface. These actions
and dialogs do not make changes to the target system. Generally, they gather information about the system environment
and the end user for use later in the installation.

By default, the Administration and Installation sequences each contain a User Interface sequence.

Project • InstallScript custom actions are not supported in the User Interface sequence for InstallScript MSI projects.

Execute Sequence
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The Execute sequence is executed after the User Interface sequence, unless your installation is run in silent mode. The
Execute sequence contains all the standard and custom actions that change the target system. For example, file transfer is
handled during the Execute sequence. Typically, this sequence is the part of the installation where changes are made to
the target machine.

Each sequence (Installation, Advertisement, and Administration) has different actions that occur in the Execute sequence.
This discrepancy is due to the fact that each of those sequences achieves different goals. For example, the Installation
sequence installs the product on the target machine. The Advertisement sequence installs the product’s advertised

InstallShield 2020 User Guide ISP-2600-UG00 941

Chapter 4
Customizing Installation Behavior

shortcuts, file-type information, and COM-server data on the target machine, but it does not transfer the product’s files
until the end user selects the shortcut, opens a registered document, or invokes an advertised COM server. As can be
gathered from the name of the sequence, the product is advertised.

See Also
Advertising Features

Inserting Actions into Sequences

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Sequences dictate when all of the actions that are associated with an installation will be executed. You can add, remove, or
reorder actions in any sequence. For example, if you want to display a readme file as part of the installation, you can add to
your installation a custom action that launches the readme file. This action must be inserted into a sequence.

Inserting actions into a sequence is governed by when actions in that sequence launch. Many actions rely on other actions
executing before they can function. For example, if you want to launch an executable file that will be installed as part of
your installation, you cannot execute the action that relies upon that executable file until the point in the sequence when
the files have been installed.

Note • InstallShield does not provide any validation on your sequences. If an action is placed in a sequence where it cannot
function properly, an error will not occur until the installation is run.

Inserting an Action

Task To insert an action into a sequence:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Sequences explorer, right-click the action or dialog that you want your action to follow and click Insert. The
Insert Action dialog box opens, providing a list of all the actions and dialogs that can be added to the sequence.

3. In the list at the top of the dialog box, select the type of action that you want to insert.

4. In the box that shows a list of actions, select the action that you want to insert.

5. Click OK.

InstallShield also includes drag-and-drop support that enables you to drag and drop custom actions from the Custom
Actions explorer to a sequence in the Sequences explorer.

942 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Task To insert a custom action into a sequence using the drag-and-drop method:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. Drag the custom action from the Custom Actions explorer to the appropriate location in a sequence under the
Sequences explorer. When you drop it, drop it onto the item that should be directly before it in the sequence.

Note • A custom action cannot be called twice in the same sequence, since the custom action name is the key in the
CustomAction table. Therefore, you cannot insert a custom action to a sequence that already contains that custom action.

Determining Where to Insert the Action

There are several categories of custom actions that you can include in your installation: calling a standard or Windows
Installer–ready DLL function, launching an executable file, running a script (JScript, VBScript, or InstallScript), setting a
property or directory, and launching a second .msi installation. All types can be called at different times depending on the
configuration of the custom action. For more information, see the following:

• Sequencing a Custom Action that Calls a Function in a DLL File

• Sequencing a Custom Action that Launches an .exe File

• Sequencing a Custom Action that Calls a Script

• Sequencing Custom Actions that Set Properties or Directory Properties

• Sequencing a Custom Action that Launches a Second .msi Package

Considerations for Custom Actions from Included Merge Modules

You can control the launch of custom actions in a merge module by modifying the ModuleInstallExecuteSequence table
in the Direct Editor. When you add the merge module to your installation project, all custom actions and dialogs included
in the merge module are available for you to insert in the installation’s sequences through the Custom Actions and
Sequences view.

Copying a Custom Action from One Sequence to Another

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

InstallShield enables you to copy a custom action in one sequence to another sequence through a drag-and-drop
operation.

InstallShield 2020 User Guide ISP-2600-UG00 943

Chapter 4
Customizing Installation Behavior

Task To copy a custom action from one sequence to another:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Sequences explorer, find the action that you want to copy.

3. Press and hold CTRL while dragging the custom action from one sequence to another sequence, and drop it onto the
action or dialog that should be directly before it.

Note • A custom action cannot be called twice in the same sequence, since the custom action name is the key in the
CustomAction table. Therefore, you cannot move or copy a custom action to a sequence that already contains that custom
action.

Dialogs and standard actions cannot be moved to a different type of sequence through a drag-and-drop operation.

See Also
Inserting Actions into Sequences
Reordering a Sequence

Reordering a Sequence
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

The actions and dialogs in the Sequences explorer in the Custom Actions and Sequences view are organized by
chronological order, according to when they are launched. Each action and item also has a number that identifies its
location in the sequence in relation to other items’ sequence numbers. The items are launched in order from the lowest
number to the highest number.

When you add a dialog (to Basic MSI, MSI Database, and Transform projects) or a custom action to your project, you can
specify when it should be launched by adding it to the appropriate place in a sequence.

Task To change the order in which actions and dialogs in a sequence execute:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. Do one of the following:

• To sequence a new custom action, drag it from the Custom Actions explorer to the appropriate location in a
sequence under the Sequences explorer. When you drop it, drop it onto the item that should be directly before it
in the sequence.

944 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• To move an action or a dialog to a different point in a sequence (or from one sequence to another), drag it from
the old location and drop it onto the item that should be directly before it in the sequence.

Note • A custom action cannot be called twice in the same sequence, since the custom action name is the key in the
CustomAction table. Therefore, you cannot move or copy a custom action to a sequence that already contains that custom
action.

Dialogs and standard actions cannot be moved to a different type of sequence through a drag-and-drop operation.

If you change a custom action after adding it to a sequence, you do not need to reassociate it with that sequence. The action
that you put in the sequence is a pointer to the real action, and it is dynamically updated whenever you make changes to the
action in the Custom Actions and Sequences view.

Tip • You can also move actions and dialogs in the Sequences explorer using any of the following methods:

• Right-click the action or dialog and click Move Up or Move Down.

• Click the action or dialog and then press CTRL+SHIFT+UP ARROW or CTRL+SHIFT+DOWN ARROW.
• Change the position of the action or dialog by editing its Sequence Number setting, which is displayed in the grid on the
right when you click the action or dialog. To move a an action or dialog to an earlier point in a sequence, give it a lower
sequence number. To move it to a later point in the sequence, give it a higher sequence number.

See Also
Displaying Dialogs During Basic MSI Installations

Removing Actions from Sequences

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Task To remove an action from a sequence:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Sequences explorer, expand the sequence that contains the action that you want to remove.

3. Right-click the action and click Remove.

The action is removed from that sequence only, not from all sequences or from the project. You can permanently remove
an action from an installation project through the Custom Actions explorer in the Custom Actions and Sequences view.

InstallShield 2020 User Guide ISP-2600-UG00 945

Chapter 4
Customizing Installation Behavior

Sequencing Rollback Custom Actions

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Any custom action that is in your installation project and that makes direct changes to the target system should have a
rollback equivalent custom action. The rollback custom action can undo those changes in the event of rollback. For
example, if you have a custom action that deletes files from the target system, and you do not include a rollback custom
action to restore those deleted files, the computer could be left in an unstable state even after rollback has completed.
Rollback custom actions behave in a similar way to deferred custom actions. That is, they do not launch when first
encountered in a sequence. Instead, they are written to the rollback script, which launches only in the event of a rollback.

When inserting a rollback custom action into a sequence, note the following:

• A rollback can occur only during the Execute sequence and not at any point during the User Interface sequence.
Therefore, the rollback action must be placed after InstallInitialize and before InstallFinalize in the Execute sequence.

• The rollback custom action must be sequenced before the action it rolls back. In all other instances, the Windows
Installer service runs through sequences from top to bottom—the lower the sequence number, the sooner the action
launches. In the rollback script, however, the service runs in the opposite direction. Therefore, to launch your rollback
action when it is needed, sequence it before the action that it rolls back.

See Also
Using Custom Actions

Sequencing a Custom Action that Launches an .exe File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

Launching an executable file as your custom action can be a little trickier than calling a DLL file function in terms of where
that action can be inserted into the sequence. You should consider things such as when the .exe file will be launched during
the installation and which sequences you want the custom action to occur in.

946 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Executable Files Stored in the .msi Package

When you are launching a .exe file that is stored in the .msi package, you can place the custom action anywhere in the
sequence.

Table 4-23 • Settings for Actions that Launch an .exe File in the .msi Package

Action Type Location Scheduling Sequence

Launch an Stored in .msi package Not applicable Anywhere in the

executable sequence

Installed Executable Files

If your .exe file is going to be installed as part of the installation, you should follow one of two sets of rules, depending on
which scheduling property (Deferred Execution or Immediate Execution) you chose. For Immediate Execution, you must
insert your action after the InstallFinalize action in order for it to work properly. For Deferred Execution, you need to insert
the action after the InstallFiles action and before the InstallFinalize action.

Table 4-24 • Settings for Actions that Launch an Installed .exe File

Action Type Location Scheduling Sequence

Launch an Installed Immediate Execution After InstallFinalize

executable

Launch an Installed Deferred Execution After InstallFiles and

executable before InstallFinalize

Local Executable Files

If the .exe file that you would like to run is already present on the system, you will need to insert your action after the
CostFinalize action is called. See the table below for a clearer view.

Table 4-25 • Settings for Actions that Launch an .exe File that Is Already Installed

Action Type Location Scheduling Sequence

Launch an Local Not applicable After CostFinalize

executable

Sequencing a Custom Action that Calls a Function in a DLL File

InstallShield 2020

If you want to sequence a custom action that calls a function in a DLL file, there are three different ways to reference the
DLL file, depending on where the DLL file is located during the installation:

• The DLL file can be streamed into the .msi file, but it is not installed.

• The DLL file can be in the target system’s path (applies to a standard DLL file but not a Windows Installer DLL file).

InstallShield 2020 User Guide ISP-2600-UG00 947

Chapter 4
Customizing Installation Behavior

• The DLL file can be installed with the rest of the installation files.

Other considerations include scheduling. The two main scheduling choices are Immediate Execution and Deferred
Execution. Immediate Execution means that Windows Installer will execute your custom action as it processes the .msi file.
Deferred Execution tells the installer to queue the action and perform it in sequence in the script.

DLL Files Stored in the .msi Package

When you are calling a function from a DLL file that is stored in the .msi package, you can place the custom action
anywhere in the sequence.

Table 4-26 • Settings for Actions that Call a Function in a DLL File that is stored in the .msi Package

Action Type Location Scheduling Sequence

DLL Function Stored in .msi package Not applicable Anywhere

DLL Files Found in the System’s Path

When you are calling a function from a DLL file that exists on the target system, there are also no restrictions on where you
can place the custom action in the sequence.

Table 4-27 • Settings for Actions that Call a Function in a DLL File that Is Found in the System’s Path

Action Type Location Scheduling Sequence

DLL Function On target system Not applicable Anywhere

Installed DLL Files

If you are calling a DLL function from a file that is going to be installed to the target machine during the installation and you
have it scheduled to run during Immediate Execution, you can place the action only after the InstallFinalize action. If you
want the action to occur during Deferred Execution, place the action after the InstallFiles action and before the
InstallFinalize action. The following table illustrates this point:

Table 4-28 • Settings for Actions that Call a Function in a DLL File that Is Already Installed

Action Type Location Scheduling Sequence

DLL Function Installed Immediate Execution After InstallFinalize

DLL Function Installed Deferred Execution Before InstallFinalize

and After InstallFiles

Sequencing a Custom Action that Calls a Script

InstallShield 2020

Project • The VBScript and JScript information applies to the following project types:

948 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

The InstallScript information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module

Using script inside your custom action enables you to perform virtually any task. For example, you can launch external
applications or create registry entries.

VBScript and JScript Code

Installed with the Product

If your script file is going to be installed as part of the installation, you should follow one of two sets of rules depending on
which scheduling property (Deferred Execution or Immediate Execution) you chose. For Immediate Execution, you must
insert your action after the InstallFinalize action in order for it to work properly. For Deferred Execution, you need to insert
the action after the InstallFiles action and before the InstallFinalize action.

Table 4-29 • Settings for Actions that Call a VBScript or JScript File that Is Installed with the Product

Action Type Location Scheduling Sequence

Run VBScript or Installed Immediate Execution After InstallFinalize

JScript Code

Run VBScript or Installed Deferred Execution After InstallFiles and

JScript Code before InstallFinalize

Stored in the Binary Table

If the script file that you are calling is stored in the Binary table, you can place the action anywhere in the sequence.

Table 4-30 • Settings for Actions that Call a VBScript or JScript File that Is Stored in the Binary Table

Action Type Location Scheduling Sequence

Run VBScript/JScript Temporary Not applicable Anywhere in the

Code sequence

InstallShield 2020 User Guide ISP-2600-UG00 949

Chapter 4
Customizing Installation Behavior

Already Present on the Target System

If the script file that you want to call is already present on the system, you need to insert your action after the CostFinalize
action is called.

Table 4-31 •

Action Type Location Scheduling Sequence

Run VBScript/JScript Local Not applicable After CostFinalize

Code

Stored Directly in the Custom Action

If you chose to place your script directly in the custom action, you can place the action anywhere in the sequence.

InstallScript Code
InstallScript custom actions differ from JScript or VBScript custom actions because the source files for InstallScript actions
are always streamed into the .msi package. Therefore, the custom action can be inserted into a sequence anywhere after
the action that has 2 as its sequence number. This limitation occurs because the script engine launches during sequence
number 2. Therefore, if you call your script before the script engine launches, the system is not able to process it.

If your custom action contains feature functions or setup type dialog functions, you must insert the custom action after the
CostInitialize, FileCost, and CostFinalize actions.

Sequencing Custom Actions that Set Properties or Directory Properties

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module
• MSI Database
• MSM Database
• Transform

When you are sequencing a custom action that sets a property or directory, the primary guideline that you need to follow is
to make sure that the custom action runs before that directory or property is needed. For example, if you want to launch an
executable file that is present on the target machine, the installation will probably need to search for it first.

Once the installation finds the executable file, its path can be added to the Directory table, and the executable file can be
launched. However, if you call the custom action after you launch the executable file, the executable file will not be found.

Some other sequencing and scheduling restrictions include:

• Validation rule ICE12 requires any type-35 custom action (called Set a directory in the Custom Action Wizard) to be
sequenced after the standard CostFinalize action in the sequences.

950 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

• Similarly, ICE12 requires any type-51 custom action (called Set a property in the Custom Action Wizard) that sets the
value of a property found in the Directory table to be scheduled before the standard CostFinalize action.

• Any custom action that sets a property should be scheduled for immediate execution.

Sequencing a Custom Action that Launches a Second .msi Package

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database
• Transform

Important • Nested installations is a deprecated feature of the Windows Installer. Applications installed with nested
installations sometimes fail because they are difficult for end users to service correctly. Microsoft Corporation recommends
that you avoid using nested installations and nested-installation custom actions to install products that are intended to be
released to the public. To learn more, see Concurrent Installations on the MSDN Web site.

When you are sequencing a nested-installation custom action (called Launch another .msi package in the Custom Action
Wizard), you must place the action in the Execute sequence after the standard CostFinalize action.

Additionally, ensure that the custom action launches before any of the files contained within the installation are needed by
your main installation, if applicable. For example, if you later want to launch an executable file that is installed as part of
the second .msi file, ensure that the package is installed before you try to launch the executable file.

See Also
Nested Installations

ISSetAllUsers Custom Action

InstallShield 2020

Why ISSetAllUsers Appears in Your Installation Package’s Sequence

If you have entered one or more records in the Upgrade table for your installation (through the Upgrades view),
InstallShield inserts a DLL custom action called ISSetAllUsers in both the User Interface and Execute portions of the
installation sequence. When your product is installed as an upgrade, the ISSetAllUsers custom action checks the value of
the ALLUSERS property in the installed version.

The ALLUSERS property is indicated in the Customer Information dialog (for Basic MSI projects) and in either the
SdCustomerInformation or SdCustomerInformationEx dialog (for InstallScript MSI projects) by the end user during the
initial installation. The ISSetAllUsers custom action compares the value in the installed version to the value in the new
version. If the values differ, then ISSetAllUsers sets the ALLUSERS property of the new version to match that of the installed
version.

Note that for upgrades, the ALLUSERS property is configurable only through a custom action.

InstallShield 2020 User Guide ISP-2600-UG00 951

Chapter 4
Customizing Installation Behavior

The new installation’s ALLUSERS property must match the installed version’s property in order for the FindRelatedProducts
action to succeed for the upgrade installation. In addition, if the previous version is installed for only one particular user
and the upgrade is installed for all users, the resulting installation is corrupted and might not uninstall properly.
ISSetAllUsers eliminates these problems by resetting the ALLUSERS property.

How ISSetAllUsers Works

The following example illustrates how the ISSetAllUsers custom action works:

1. My Application 1.0 is installed with the ALLUSERS property set to 1 (the end user selected Install for All Users in the
end-user dialog during installation).

2. My Application 2.0 is authored as an upgrade to version 1.0 and has an entry in the Upgrade table to upgrade version
1.0.

3. The end user installs version 2.0 on the target system as an upgrade.

4. During the installation, ISSetAllUsers checks the value of the ALLUSERS property in the installed version and compares
it to the new version’s property by doing the following:

a. ISSetAllUsers iterates through each entry in the Upgrade table of version 2.0.

b. For every upgrade code in the Upgrade table, ISSetAllUsers searches for the related products on the target
system.

c. If the version and language constraints in the Upgrade table match one of the installed products (found in step
4b), ISSetAllUsers checks the ALLUSERS property of the installed version.

d. If the value of ALLUSERS for the installed version differs from that of the new version, ISSetAllUsers sets the new
installation’s ALLUSERS property to this value.

Note • If no matching product is installed on the target system, ISSetAllUsers does nothing.

See Also
Upgrades View

Using Support Files

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Suite/Advanced UI

952 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Support files are files that are available on the target system only during your product’s installation process. Support files
are copied to a temporary directory on the target system when installation begins. The support files are deleted when the
installation is complete. The support directory is a dynamic file location and might be different on every target system and
even on the same system for different installation instances.

In the Support Files view (in Advanced UI, Basic MSI, InstallScript Object, and Suite/Advanced UI projects) or the Support
Files/Billboards view (in InstallScript projects and InstallScript MSI projects), you can add and remove files that you want to
be available on the target system only during installation.

See Also
SUPPORTDIR
Placing Files in the .msi Database and Extracting Them During Run Time
Support Files/Billboards View (InstallScript and InstallScript MSI Projects)
Support Files View (Advanced UI, Basic MSI, InstallScript Object, and Suite/Advanced UI Projects)

Adding Support Files

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Suite/Advanced UI

Task To add support files to your installation project:

1. In Advanced UI, Basic MSI, InstallScript Object, and Suite/Advanced UI projects: In the View List under Behavior and
Logic, click Support Files.

In InstallScript and InstallScript MSI projects: In the View List under Behavior and Logic, click Support Files/
Billboards.

2. Optionally, to create one or more subfolders for your files, in the Support Files explorer, right-click the Language
Independent node or one of the language-specific nodes in this view, and then click New Folder. InstallShield adds a
folder. Enter the name that you want to use for the folder.

3. In the Support Files explorer, click the item that should contain the support file that you are adding.

4. Right-click anywhere in the Files pane and then click Insert Files. The Open dialog box opens.

5. Browse to the file that you want to include. To select multiple files, hold down the CTRL key while clicking files.

6. Click OK.

InstallShield adds the file to the Files pane.

InstallShield 2020 User Guide ISP-2600-UG00 953

Chapter 4
Customizing Installation Behavior

Tip • You can also drag files from Windows Explorer and drop them into the Files pane.

Adding a License File

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

You can add a text file containing a license agreement in the Support Files/Billboards view.

Task To add a license file:

1. In the View List under Behavior and Logic, click Support Files/Billboards.

2. Optionally, to create one or more subfolders for your license files, in the Support Files explorer, right-click the
Language Independent node or one of the language-specific nodes in this view, and then click New Folder.
InstallShield adds a folder. Enter the name that you want to use for the folder.

3. In the Support Files explorer, click the item that should contain the license file that you are adding.

4. Right-click anywhere in the Files pane and then click Insert Files. The Open dialog box opens.

5. Browse to the file that you want to include. To select multiple files, hold down the CTRL key while clicking files.

6. Call the file in the szLicenseFile parameter in one of the SdLicense* functions in your script.

Sorting Support Files

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• Suite/Advanced UI

You can sort the files in the Files pane of the Support Files view (in Advanced UI, Basic MSI, and Suite/Advanced UI projects)
or the Support Files/Billboards view (in InstallScript projects and InstallScript MSI projects) by clicking the heading of the
column by which you want to sort the files. You can sort by any of the columns.

954 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Adding Files and Folders to the Disk1 Folder

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

The Disk1 node enables you to indicate files and folders that you want to go on Disk1 of your installation media. These files
and folders are not automatically installed to the target system when your installation is run. Rather, you can link to the
installation media from your application or from the installation.

For example, you might include a large redistributable file with your application. You may want end users to be able to
access the redistributable, but you do not want to include in the application installation. If this is the case, this file can be
placed in the Disk1 folder.

Task To add a file or folder to the Disk1 folder:

1. In Basic MSI projects: In the View List under Behavior and Logic, click Support Files.

In InstallScript and InstallScript MSI projects: In the View List under Behavior and Logic, click Support Files/
Billboards.

2. In the Support Files explorer, click Disk1.

3. Right-click anywhere in the Files pane and then click Insert Files. The Open dialog box opens.

4. Browse to the file that you want to include. To select multiple files, hold down the CTRL key while clicking files.

5. Click OK.

InstallShield adds the file to the Files pane.

See Also
Support Files/Billboards View (InstallScript and InstallScript MSI Projects)
Support Files View (Advanced UI, Basic MSI, InstallScript Object, and Suite/Advanced UI Projects)

Removing Files or Folders from the Disk1 Folder

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 955

Chapter 4
Customizing Installation Behavior

Task To remove a file or folder from the Disk1 folder:

1. In Basic MSI projects: In the View List under Behavior and Logic, click Support Files.

In InstallScript and InstallScript MSI projects: In the View List under Behavior and Logic, click Support Files/
Billboards.

2. In the Support Files explorer, click Disk1.

3. In the Files pane, right-click the file or folder and then click Delete.

Adding Files and Folders to the Last Disk Folder

InstallShield 2020

Project • This information applies to InstallScript projects.

The Last Disk node enables you to indicate files and folders that you want to go on the last disk of your installation media.
These files or folders are not automatically installed to the target system when your installation is run. Rather, you can link
to the installation media from your application or from the installation.

For example, you might include a large redistributable file with your application. You may want end users to be able to
access the redistributable, but you do not want to include in the application installation. If this is the case, this file can be
placed in the last disk folder.

Task To add a file or folder to the last disk image folder:

1. In the View List under Behavior and Logic, click Support Files/Billboards.

2. In the Support Files explorer, click Last Disk.

3. Right-click anywhere in the Files pane and then click Insert Files. The Open dialog box opens.

4. Browse to the file that you want to include. To select multiple files, hold down the CTRL key while clicking files.

5. Click OK.

InstallShield adds the file to the Files pane.

See Also
Support Files/Billboards View (InstallScript and InstallScript MSI Projects)

Removing Files or Folders from the Last Disk Folder

InstallShield 2020

Project • This information applies to InstallScript projects.

956 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Customizing Installation Behavior

Task To remove a file or folder from the last disk image folder:

1. In the View List under Behavior and Logic, click Support Files/Billboards.

2. In the Support Files explorer, click Last Disk.

3. In the Files pane, right-click the file or folder and then click Delete.

Adding Files and Folders to the Other Disk Folder

InstallShield 2020

Project • This information applies to InstallScript projects.

The Other node enables you to indicate files or folders that you want to go on a disk of your installation media other than
the first or last disk. These files or folders are not automatically installed to the target system when your installation is run.
Rather, you can link to the installation media from your application or from the installation.

Task To add a file or folder to a disk image folder:

1. In the View List under Behavior and Logic, click Support Files/Billboards.

2. In the Support Files explorer, click Other.

3. Right-click anywhere in the Files pane and then click Insert Files. The Open dialog box opens.

4. Browse to the file that you want to include. To select multiple files, hold down the CTRL key while clicking files.

5. Click OK.

InstallShield adds the file to the Files pane.

Tip • To specify the disk, run the Release Wizard; in the General Options panel, click the Other Disk Files button.

See Also
Support Files/Billboards View (InstallScript and InstallScript MSI Projects)

Removing Files or Folders from the Other Disk Folder

InstallShield 2020

Project • This information applies to InstallScript projects.

InstallShield 2020 User Guide ISP-2600-UG00 957

Chapter 4
Customizing Installation Behavior

Task To remove a file or folder from a disk image folder:

1. In the View List under Behavior and Logic, click Support Files/Billboards.

2. In the Support Files explorer, click Other.

3. In the Files pane, right-click the file or folder and then click Delete.

Removing Support Files

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Suite/Advanced UI

Task To remove support files from your project:

1. In Advanced UI, Basic MSI, InstallScript Object, and Suite/Advanced UI projects: In the View List under Behavior and
Logic, click Support Files.

In InstallScript and InstallScript MSI projects: In the View List under Behavior and Logic, click Support Files/
Billboards.

2. In the Support Files explorer, click the item that contains the support file that you want to delete.

3. In the Files pane, right-click the file or folder and then click Delete.

958 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Defining the End-User Interface

InstallShield 2020

This section of the documentation covers different features of InstallShield that enable you to define different aspects of
the end-user interface. Some portions of the “Defining the End-User Interface” section discuss how to create and work with
dialogs for the end-user interface of your installation. Others discuss topics such as strings, which let you localize your
installation.

See Also
Run-Time Language Support in InstallShield

Working with Dialogs

InstallShield 2020

This section of the documentation covers some of the basic and more advanced aspects of working with end-user dialogs
for various project types in InstallShield.

Project • In Basic MSI installations, Windows Installer typically controls the run-time user interface. In InstallScript and
InstallScript MSI installations, the InstallScript engine typically controls the run-time user interface. Therefore, some portions
of this section of the documentation apply to Basic MSI installations, some apply to InstallScript and InstallScript MSI
installations, and some apply to all three project types.

Working with Dialogs in Any Project Type

InstallShield 2020

Dialogs provide the user interface for your installation. They request information from the end user and provide feedback
about the progress of the installation process.

The way in which you work with the dialogs in your project depends on the type of installation that you are creating.
Adding dialogs to an InstallScript or InstallScript MSI project requires different steps than adding dialogs to a Basic MSI
project.

Common Operations
Some of the dialog operations are common to Basic MSI, InstallScript, and InstallScript MSI projects.

• Using the Dialog Wizard to Create a New Dialog

• Exporting a Dialog to an .isd File for Use in Other Projects

• Importing Dialogs from an .isd File

• Exporting All Dialogs to an .rc File

• Importing Dialogs from Resource .dll Files

• Exporting Dialogs to Other Projects

InstallShield 2020 User Guide ISP-2600-UG00 959

Chapter 4
Defining the End-User Interface

See Also
Working with Dialogs in InstallScript and InstallScript MSI Projects
Working with Dialogs in Basic MSI Projects

Using the Dialog Wizard to Create a New Dialog

InstallShield 2020

InstallShield provides a Dialog Wizard that enables you to add a new dialog to your installation and configure it by stepping
through the wizard panels.

Adding the Ability to Create or Set an Existing User Account

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Project-specific differences are noted where appropriate.

Many server applications require the specification of a user account during installation. Having a user account available is
often necessary because it enables a server application to access resources that are restricted to other users. InstallShield
offers support for setting an existing Windows user account or creating a new one during installation by enabling you to
add the appropriate run-time dialogs to your installation.

Table 4-1 • Project-Specific Details for Adding User Account Support

Project Type Additional Information

Basic MSI For Basic MSI projects, the specified user name, password, and group information
entered in the LogonInformation dialogs are stored in the following properties:

• IS_NET_API_LOGON_USERNAME

• IS_NET_API_LOGON_GROUP

• IS_NET_API_LOGON_PASSWORD

InstallScript For InstallScript projects, the specified user name, password, and group
information entered by the end user in the LogonInformation dialogs are stored in
the following global variables:

• IFX_NETAPI_USER_ACCOUNT

• IFX_NETAPI_PASSWORD

• IFX_NETAPI_GROUP

960 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-1 • Project-Specific Details for Adding User Account Support

Project Type Additional Information

InstallScript MSI For InstallScript MSI projects, the specified user account, group, and password
are stored in the following global variables and properties:

• IFX_NETAPI_USER_ACCOUNT

• IFX_NETAPI_GROUP

• IFX_NETAPI_PASSWORD

• IS_NET_API_LOGON_USERNAME

• IS_NET_API_LOGON_GROUP

• IS_NET_API_LOGON_PASSWORD

Adding Support for the LogonInformation Dialogs to a Basic MSI Project

Task To add the LogonInformation dialogs to a Basic MSI project:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click All Dialogs, and click New Dialog. The New Dialog Wizard opens.

3. Complete each panel of the wizard. In the Dialog Template panel, select Logon Information Panel and Associated
Child Dialogs.

When you are done completing each panel of the New Dialog Wizard, build and run your installation project. When the
dialog sequence in which the LoginInformationDialog dialog is executed, the appropriate dialogs are displayed.

Adding Support for the LogonInformation Dialogs to an InstallScript or InstallScript

MSI Project

Task To add support for the LogonInformation dialogs to either an InstallScript or InstallScript MSI project:

1. Navigate to the location in your InstallScript code where you want to insert the LogonInformation dialog set. In most
situations, you will add it within OnFirstUIBefore. For example:

Dlg_SdLogon:
nResult = SdLogonUserInformation(szTitle, szMsg, szAccount, szPassword);
if (nResult = BACK) goto Dlg_SdWelcome;

2. In InstallScript MSI projects, add the following function so that the Windows Installer properties are set to the same
value as the InstallScript global variables. You can add it after calling SdLogonUserInformation.

OnLogonUserSetMsiProperties();

3. On the Build menu, click Settings. The Settings dialog box opens.

4. Click the Compile/Link tab.

5. In the Libraries (.obl) box, enter the name of your new library file (*.obl):

InstallShield 2020 User Guide ISP-2600-UG00 961

Chapter 4
Defining the End-User Interface

NetApiRT.obl

Note • You should add the new library file name before the isrt.obl file name.

Once you have added the InstallScript code, build and run your installation. When the script is executed, the appropriate
dialogs are displayed.

Limitations of the LogonInformation Dialogs in Basic MSI, InstallScript, and

InstallScript MSI Projects
When an end user attempts to use the LogonInformation dialogs, they may encounter a blank list of domains, or they may
encounter a “Server not found” error. The following scenarios may cause this behavior:

• The target system is not on a domain.

• A firewall is configured without an exception for the Computer Browser service.

• NetBIOS over TCP/IP is not enabled on the target system.

• Broadcast traffic is disabled on the network.

See Also
Creating Predetermined User Accounts at Run Time
Settings Dialog Box
SdLogonUserInformation
SdLogonUserListGroups
SdLogonUserListServers
SdLogonUserListUsers
SdLogonUserBrowse
SdLogonUserCreateUser

Exporting a Dialog to an .isd File for Use in Other Projects

InstallShield 2020

If you want to reuse an end-user dialog in other projects, you can export the dialog as an .isd file and then import it into
other projects as needed. The .isd file contains the behavior and layout information for the dialog.

Task To export a dialog to an .isd file:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click the dialog and then click Export to Dialog File. The Save As dialog box opens.

3. Browse to the folder to which you want to save the .isd file. You can rename the file if required.

4. Click OK.

You can now use the .isd file to import the dialog into another installation project.

See Also
Reusing Project Elements
Using a Repository to Share Project Elements

962 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Importing Dialogs from an .isd File

InstallShield 2020

InstallShield enables you to import a dialog into your installation project. The file for the dialog (.isd file) can be stored in a
repository, or it can be stored in some other location.

Task To import a dialog into your project from an .isd file:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click the dialog and then click Import Dialog. The Import Dialog dialog box opens.

3. Do one of the following:

• In the Repository Items box, click the dialog that you want to add to your project.

• If the file for the dialog box (.isd file) that you want to import is not stored in the repository, click the Browse
button to select it.

4. Click OK.

InstallShield adds a copy for each supported language to your project.

Note • When you import a dialog, make sure that any string identifiers, properties, and actions referenced by the dialog are
present in the new installation project.

Resolving Conflicts
When you import a dialog, InstallShield checks to make sure that the name of the dialog and its controls are unique—as
required by Windows Installer. You cannot import a dialog with the same name as an existing dialog because InstallShield
assumes that you are trying to import an identical dialog.

If you try to import an .isd file that uses the names of controls or string identifiers that already exist in your installation
project, InstallShield asks how you want to resolve those conflicts. You can either overwrite the existing values or skip the
imported values in order to leave the existing ones.

Displaying Dialogs During Installation

Adding a dialog to a project does not mean that the dialog will be displayed in the installation. For information on inserting
the dialog into one or more of the project’s sequences, see Displaying Dialogs During Basic MSI Installations.

See Also
Using a Repository to Share Project Elements
Selecting the Installation Languages

Publishing a Dialog (.isd) File to a Repository

InstallShield 2020

If you have an existing dialog (.isd) file that you would like to reuse in other projects or share with other users, you can
publish it to a repository.

InstallShield 2020 User Guide ISP-2600-UG00 963

Chapter 4
Defining the End-User Interface

Task To publish a dialog to a repository:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click the dialog and then click Publish Wizard. The Publish Wizard opens.

3. Complete the panels in the Publish Wizard.

After you have imported a dialog from a repository into a project, there is no link between the current dialog and the
existing repository dialog. If you make a change to the dialog and then republish it to the repository, it does not affect the
dialog in the project to which it was imported. However, you can reimport the dialog from the repository into your project.

See Also
Using a Repository to Share Project Elements

Exporting All Dialogs to an .rc File

InstallShield 2020

If you would like to edit your dialogs’ resources in a resource editor such as Visual Studio, you can export the dialogs to an
.rc file.

Task To export a dialog to a resource script (.rc) file:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click All Dialogs and click Export Dialogs to Resource Script.

InstallShield copies all of the dialogs’ resources for the default language to a file named <project name>.rc in the project
location.

Every attempt is made to preserve each dialog’s layout as much as possible. However, since some information in the Dialog
Editor has no counterpart in a resource editor, InstallShield exports the resources as they appear in the Dialog Editor with
the following exceptions:

Table 4-2 • Resources that Are Not Exported to an .rc File

Exception Description

String entries All strings entries are resolved to the value of the default language.

Paths The paths, including any path variables, to any resources, such as text files or
bitmaps, are preserved to make it easier to import the dialog at a later point.

Selection trees A Windows Installer selection tree becomes a standard tree control in the .rc file.

Text style While the Dialog Editor maintains separate properties for font information (base
text style and text style) and maximum character length, these properties are
grouped together as they are in the Windows Installer tables.

964 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-2 • Resources that Are Not Exported to an .rc File (cont.)

Exception Description

Behavior Unlike .isd files, which contain complete copies of the dialog’s layout and
behavior, .rc files store only the resources.

Editing the Dialogs in a Resource Editor

You can edit the dialogs’ geometry in a resource editor—or Notepad—as you would for any Windows dialog.

Before importing the dialogs back into your project, you must compile the .rc file into a .res file and then build it into a .dll
file.

Task Assuming again that you use Visual Studio, follow the steps below to build MyProject.rc into MyProject.dll:

1. Use the Resource Compiler (Rc.exe) to compile MyProject.rc into MyProject with the following command-line
statement:

rc MyProject.rc

2. Run the Incremental Linker (Link.exe) to build a .dll file with the following command:

link /DLL /NOENTRY /NODEFAULTLIB /MACHINE:iX86 /OUT:MyProject.dll MyProject.res

See Also
Reusing Project Elements

Importing Dialogs from Resource .dll Files

InstallShield 2020

Task To import all of the dialog resources from a .dll file:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click All Dialogs and click Import Dialogs from Resource Dlls. The Open dialog box
opens.

3. Browse to the .dll file that contains the dialog resources that you want to import.

4. Click Open.

InstallShield adds each dialog to your project. Naming conflicts are resolved by adding a number to the imported dialog to
make it unique.

If an imported control displays text that is already found as a string entry, InstallShield uses the existing string entry for the
control’s Text property.

Note • When you are importing a dialog, ensure that any properties referenced by the dialog are present in the new
installation project.

InstallShield 2020 User Guide ISP-2600-UG00 965

Chapter 4
Defining the End-User Interface

Adding a dialog to a project does not mean that the dialog will be displayed during the installation run time. For
information on inserting the dialog into one or more of the installation’s sequences, see Displaying Dialogs During Basic
MSI Installations.

Even though dialogs can be exported to an .rc file, you must build the resources into a .dll file before you can import them
into InstallShield. For more information, see Exporting All Dialogs to an .rc File.

Exporting Dialogs to Other Projects

InstallShield 2020

InstallShield enables you to insert a dialog from the current project into another existing project by exporting it.

Task To export a dialog to an existing project:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click the dialog and click Export to Project File. The Export Into dialog box opens.

3. Browse to the location of an existing .ism file. It can be either an installation project or a merge module project, but
the file cannot be open in another instance of InstallShield.

4. Click Save.

A copy of this dialog is added to the specified .ism file, along with every control and all of the dialog’s behavior. Any string
entries, properties, and path variables used in the dialog are also copied to your new project.

If the target .ism file already has a dialog of that name with different properties, the Resolve Conflict dialog box opens to
offer you options for resolving the conflicting dialogs.

You can also publish dialogs to a repository and reuse them in other installation projects. For more information, see Using
a Repository to Share Project Elements.

See Also
Reusing Project Elements

Removing Dialogs from Projects

InstallShield 2020

Basic MSI Projects

Task To remove a dialog from a Basic MSI project:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click the dialog and click Delete.

Note • Right-clicking a dialog in the Custom Actions and Sequences view and clicking Remove does not delete the dialog from
your project. It only removes it from that sequence.

966 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

InstallScript and InstallScript MSI Projects

Task To remove a dialog from an InstallScript or InstallScript MSI project:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click the dialog and click Delete.

3. In the View List under Behavior and Logic, click InstallScript.

4. Delete the script that adds the dialog to your installation’s end-user interface.

Creating and Configuring Custom Dialogs

InstallShield 2020

Consider the following tips when you create and configure custom dialogs in different project types.

InstallScript and InstallScript MSI Projects

When you add a new dialog in the Dialogs view, an entry for the dialog is added to the Dialog table. You can directly modify
data in this table in the Direct Editor.

In the Direct Editor, you can specify a value for the ISResourceId field for the new dialog. This ISResourceId value is used
within the script to identify this dialog.

Once you have added the dialog to your project, you need to call functions such as EzDefineDialog and WaitOnDialog to
load this dialog in memory and display it at run time. The corresponding ISResourceId value in the Dialog table is used as
the fourth argument of EzDefineDialog to reference the custom dialog. Also, in the second argument of EzDefineDialog, it
is advantageous to specify ISUSER as opposed to a null string. The EzDefineDialog function should look like the following:

EzDefineDialog("MyCustomDialog", ISUSER, "", 12005)

In the above example, 12005 is the ISResourceId of this custom dialog, as specified in the Dialog table.

Custom dialog functions can then be called to manipulate the custom dialog to your needs. These functions are
documented in the InstallScript Language Reference.

Basic MSI Project

When you create a custom dialog in the Dialogs view of a Basic MSI project, a Windows Installer–type dialog is created.
InstallScript custom dialog functions cannot be used with this Windows Installer–type dialog. To display this dialog in your
installation, it must be placed in sequence between two dialogs by using their Next and Back controls.

See Also
Creating New Custom Dialogs in InstallScript and InstallScript MSI Projects
Creating New Dialogs in Basic MSI Projects

InstallShield 2020 User Guide ISP-2600-UG00 967

Chapter 4
Defining the End-User Interface

Undoing Changes in the Dialog Editor

InstallShield 2020

The Dialog Editor remembers up to 50 actions for each dialog and allows you to restore each change starting from the most
recent one. Additionally, you can undo changes even after saving the project. However, if you close a project and reopen it,
the undo history is purged.

Undoing Changes

Task To undo a change, do any of the following:

• Press CTRL+Z.

• On the Edit menu, click Undo.

• Click the Undo button on the toolbar.

Redoing Undone Changes

Task To place an undone change back into effect, do one of the following:

• Press CTRL+Y.

• On the Edit menu, click Redo.

• Click the Redo button on the toolbar.

The Undo and Redo buttons and menu commands are enabled while you are using the Dialog Editor. When you undo an
action, you move back through the history of actions you performed on that dialog. When you redo, you move forward.

For example, if you resized a button and then changed its Tab Index property, clicking Undo would restore the previous
value of the Tab Index property. Clicking Undo a second time returns the button to its original size. Clicking Redo twice puts
the changes back into effect on the button’s size and then its tab index.

Note • You cannot undo changes made to a string entry through the Dialog Editor.

Working with Dialogs in InstallScript and InstallScript MSI Projects

InstallShield 2020

InstallShield enables you to call specific functions in your script to display end-user dialogs. The Dialogs view contains a list
of standard dialogs as well as any custom dialogs that you have added to your project.

This section of the documentation discusses how to create and perform basic functions with dialogs in InstallScript and
InstallScript MSI projects.

968 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Displaying Dialogs During InstallScript and InstallScript MSI Installations

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Most of the user interface of an InstallScript or InstallScript MSI installation is defined in event handlers such as
OnFirstUIBefore and OnFirstUIAfter. The following sample InstallScript code in OnFirstUIBefore is for the SdWelcome
and SdLicense2 dialogs:

Dlg_SdWelcome:
szTitle = "";
szMsg = "";
nResult = SdWelcome( szTitle, szMsg );
if (nResult = BACK) goto Dlg_Start;

Dlg_SdLicense2:
szTitle = "";
szOpt1 = "";
szOpt2 = "";
szLicenseFile = SUPPORTDIR ^ "License.rtf";
nResult = SdLicense2Ex( szTitle, szOpt1, szOpt2, szLicenseFile, bLicenseAccepted, TRUE );
if (nResult = BACK) then
goto Dlg_SdWelcome;
else
bLicenseAccepted = TRUE;
endif;

Every dialog function returns a constant indicating which button the end user clicked to exit the dialog. To handle the end
user clicking the Back button on a dialog, directly after the dialog is an if statement that compares the dialog’s return value
to the constant BACK, using a goto statement to jump to a label just before the previous dialog. In the aforementioned
code example, if the end user clicks the Back button on the SdLicense2 dialog, the goto statement jumps to the
Dlg_SdWelcome label, and the SdWelcome dialog is displayed to the end user. Therefore, if you insert a dialog function
between two dialogs such as SdWelcome and SdLicense2, you need to adjust the if statements, labels, and goto
statements as appropriate.

Task To display a dialog to the end user as part of the installation’s user interface:

1. In the View List under Behavior and Logic, click InstallScript.

2. Add the dialog function to the appropriate script event handler.

3. Modify the dialog function’s parameters according to how you want the dialog to behave.

To learn about the available parameters, refer to the dialog function documentation:

• Dialog Functions

• Dialog Customization Functions

4. Use the script to direct the flow of the dialogs—for example, by using if and goto statements.

InstallShield 2020 User Guide ISP-2600-UG00 969

Chapter 4
Defining the End-User Interface

See Also
OnFirstUIBefore
OnFirstUIAfter
OnMaintUIBefore
OnMaintUIAfter
Event Handlers

Changing the Text on Dialogs in InstallScript and InstallScript MSI Projects

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Most dialog functions accept a string argument called szTitle that defines the text appearing in the title area of the dialog.
For example, the call to SdRegisterUser appears as follows:

SdRegisterUser( szTitle, szMsg, szName, szCompany );

By default, the parameter szTitle is defined as a null string (""), which indicates that the dialog should use the default title
text. For SdRegisterUser, the default title appears as shown in the following screen shot.

Figure 4-1: Default Title Text for the SdRegisterUser Dialog

To modify the title, you can enter specific strings to display for the szTitle parameter. The title is divided into two
sections—the bold text at the top of the title area, and the regular text under the main title.

To specify the two sections in the value of szTitle, place a newline character \n between the two sections.

SdRegisterUser ("New Title\nThis is a new subtitle.",

szMsg, szName, szCompany);

After recompiling the script and running the installation, the title is displayed as shown in the following sample screen
shot.

Figure 4-2: Changed Title Text for the SdRegisterUser Dialog

To change other text displayed on a dialog, there are usually one or more parameters (such as szMsg) that contain the text
to be displayed. As with dialog box titles, a null string in a message parameter indicates that the dialog should use the
default message text provided by InstallShield.

If your installation contains more than one UI language, you can use string identifiers instead of hard-coded strings in your
InstallScript. For more information, see Using String Entries in InstallShield.

970 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Background About the Default Images on Dialogs in InstallScript and InstallScript MSI Projects
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Two types of images—the default banner images on interior dialogs, as well as the computer image on the left side of the
exterior skinned dialogs such as the Welcome dialog—are used for static dialog user interface controls that have a control
identifier of 1200. The default images are .png images, which allow for transparency. The Text field for these controls uses
the following syntax by default to identify the image:

@@ResourceID;ScaleFactor

ResourceID indicates the resource identifier number that should be used to look up either a .png image (stored as resource
type PNG) or a bitmap image (stored as resource type RT_BITMAP). ScaleFactor indicates the DPI scale percentage for
which the image is intended.

For example, the scale factor can be 100% (96 DPI), 125% (120 DPI), 150% (144 DPI), or 200% (192 DPI). If the scale factor
that is specified for an image is 200, the image will be shrunk down for display on target systems that are running less than
200% DPI scaling. On a 200% target system, it will be displayed at 1:1. If the scale factor that is specified for the image is100,
the image will be scaled up for display on target systems that are running 200% DPI scaling.

The previous format for identifying bitmap images (.bmp) still works, but it does not have support for scaling, or for .png
images:

@BitmapResourceID;TransparentFlag;3-DFlag;<unused>;TransparentColorKey

BitmapResourceID indicates the resource identifier number for the bitmap image. TransparentFlag is 1 (true) or 0 (false),
indicating whether the color that is specified in the TransparentColorKey field will be transparent when the bitmap is
displayed. TransparentColorKey specifies an RGB value that is a transparent color for the bitmap.

See Also
DialogSetInfo
SdOptionsButtons

Creating New Custom Dialogs in InstallScript and InstallScript MSI Projects

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

InstallShield 2020 User Guide ISP-2600-UG00 971

Chapter 4
Defining the End-User Interface

To create a custom dialog, you need to perform the following general steps:

1. Use the New Dialog Wizard to add a new custom dialog to your project. For more information, see Using the New
Dialog Wizard to Add a New Custom Dialog to an InstallScript or InstallScript MSI Project.

2. Add controls to the dialog. For more information, see Adding a Control to a Dialog in an InstallScript or InstallScript
MSI Project.

3. Create a script function that loads the dialog into memory, displays it on the screen, handles the end user’s interaction
with the dialog’s controls, and closes the dialog when the user is finished with it. For more information, see Using
InstallScript to Implement Custom Dialogs.

See Also
Using InstallScript to Process Dialog Controls

Using the New Dialog Wizard to Add a New Custom Dialog to an InstallScript or InstallScript
MSI Project
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Task To add a new custom dialog to your project:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click All Dialogs, and click New Dialog. The New Dialog Wizard opens.

3. Follow the wizard panels to create the new dialog. In the Dialog Template panel, select the NewScriptBasedDialog
template or the NewSkinnableDialog template.

The NewScriptBasedDialog and NewSkinnableDialog templates include a hidden control that has a Control Identifier
value of 2. To enable end users to cancel the installation by clicking the close button in the upper-right corner of the
InstallScript dialog, the dialog must have a button control whose Control Identifier property is set to this value. The
Blank Dialog template does not include this control. For more information, see Using InstallScript to Implement
Custom Dialogs.

Once you have added a new custom dialog to your project, you can add dialog controls.

See Also
Creating New Custom Dialogs in InstallScript and InstallScript MSI Projects
Editing Dialog Behavior in an InstallScript or InstallScript MSI Project
Using InstallScript to Implement Custom Dialogs

972 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Editing the Layout of a Dialog in an InstallScript or InstallScript MSI Project

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

You can use the Dialog Editor to add, remove, and rearrange controls on a selected dialog. You can also use the Dialog
Editor to modify the properties of the dialog or its controls. The InstallShield Dialog Editor functions much in the same way
as other resource editors.

When you use the Dialog Editor to change the layout or appearance of a dialog, you are changing only the current project’s
copy of the dialog; the changes do not affect any other projects.

Task To access the Dialog Editor, do one of the following:

• In the Dialogs view, click a dialog and then in the dialog preview pane on the right, click the link for the language of the
dialog that you want to edit.

• In the Dialogs view, right-click a dialog and click Edit.

InstallShield displays the Dialog Editor in the center pane.

Note • When an end user runs your installation on a Windows platform that uses a desktop display theme, the theme is used
to display your installation’s end-user dialogs.

See Also
Adding a Control to a Dialog in an InstallScript or InstallScript MSI Project
Setting a Control’s Properties
Displaying Controls on Top of a Bitmap
Reverting to the Default Dialog

Adding a Control to a Dialog in an InstallScript or InstallScript MSI Project

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

You can use the Controls toolbar in InstallShield to add controls to a dialog.

InstallShield 2020 User Guide ISP-2600-UG00 973

Chapter 4
Defining the End-User Interface

Task To add a control to a dialog:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the All Dialogs folder, and then expand the dialog item that should have the new
dialog control.

3. Click a language under the dialog item that you expanded. The Dialog Editor in the center pane shows the dialog in the
selected language.

4. In the Controls toolbar, click the control that you want to add.

5. Draw a rectangle on the dialog in the location where you want the control to be displayed.

6. In the right pane, set the control’s properties.

After adding the control in the Dialog Editor, you need to use InstallScript to process the end user’s interaction with the
control. To learn more, see Using InstallScript to Process Dialog Controls.

Note • For projects created in Microsoft Visual Studio, you can use the Toolbox to add dialog controls.

See Also
Showing or Hiding Toolbars
Configuring the Controls’ Settings
Creating InstallShield Projects in Microsoft Visual Studio
Using the Toolbox to Add Dialog Controls

Setting a Control’s Properties

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The dialog itself and every control on it has a property sheet in the Dialog Editor. These properties determine such things as
a control’s size and position, its default text (as a string identifier), or whether the dialog is modal.

To edit one of the property sheets, select the control on the dialog, or select a control’s or dialog’s name from the box
above the property sheet. The properties vary depending on the type of control:

• Dialog

• Check Box

• Push Button

• Edit Field

• Combo Box

• Text Area

974 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• List Box

• Radio Button

• Bitmap

• Group Box

• Line

• Radio Button Group

• Selection Tree

• Progress Bar

• List View

• Icon

See Also
Using an HTML Control on a Dialog

Displaying Controls on Top of a Bitmap

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

When you are setting the properties of a bitmap and other dialog controls, you can indicate that the controls should be
placed on top of the bitmap.

Task To display controls on top of a bitmap:

• The value for the Tab Index property of the bitmap must be lower than the value for the Tab Index property of any
controls that are to be placed on top of the bitmap. The easiest way to configure this is to set the bitmap control’s Tab
Index property to 0.

• All controls—including the bitmap—must have their Tab Stop properties set to True.

See Also
Setting a Control’s Properties
Editing Dialog Behavior in an InstallScript or InstallScript MSI Project
Showing or Hiding Toolbars

InstallShield 2020 User Guide ISP-2600-UG00 975

Chapter 4
Defining the End-User Interface

Using InstallScript to Implement Custom Dialogs

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The next step in creating a custom dialog is to write an InstallScript function that processes the end user’s interaction with
the dialog controls.

Task To use InstallScript to implement a custom dialog in an InstallScript project:

1. Begin by creating a new InstallScript source file to contain the custom dialog code. Name the file CustomDialog.rul.

Tip • To be able to use the dialog script in other projects, copy the .rul file to another location. In your other projects,
open the InstallScript view, right-click the Files item in the InstallScript explorer, and click Insert Script Files.

2. Inside CustomDialog.rul, place the prototype and implementation for your custom dialog function. Add the
following code to CustomDialog.rul.

prototype NUMBER CustomDialog( );

function NUMBER CustomDialog( )
begin
end;

3. When you compile your script, indicate that the main script Setup.rul should include the code for your CustomDialog
function by inserting the following line near the top of Setup.rul:

#include "CustomDialog.rul"

4. In the CustomDialog.rul script, define the constants that store the numeric IDs of the controls that you added to the
dialog. If you copied the Back, Next, and Cancel buttons from a standard dialog, you can add the following lines near
the top of CustomDialog.rul:

// control identifiers
#define BUTTON_NEXT 1
#define BUTTON_BACK 12

In general, the numeric ID of a control on a dialog is the number listed in the control’s Control Identifier property,
displayed in the property list when you select the control in the Dialog Editor.

Important • To enable end users to cancel the installation by clicking the close button in the upper-right corner of the
InstallScript dialog, the dialog must have a button control with a value of 2 for the Control Identifier property. You can
place this button anywhere on the dialog, and if necessary, you can make this button invisible. This is necessary because
the InstallScript engine passes the WM_CLOSE message to the script only if it comes from a valid control in the dialog. If
the dialog does not have a button with this identifier, the installation does not pass through the message that is
generated when the dialog’s close button is clicked.

976 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

You need to define additional constants for every other control (for example, check box, edit field, or list box) with
which the end user can interact.

5. Your CustomDialog function loads the custom dialog into memory using the EzDefineDialog function:

EzDefineDialog(
"CustomDialog", // nickname for dialog
ISUSER, // DLL containing the dialog’s resources
"CustomDialog", // name of dialog in Dialogs view
0); // numeric resource ID for dialog; not used here

To learn which arguments you use with EzDefineDialog, see EzDefineDialog.

Tip • The resource ID of a dialog is the dialog’s name, as it appears in the Dialog Editor. If you need to specify a numeric
resource ID, you can add a numeric ID to the ISResourceId column in the Dialog table for the custom dialog. You can
access the Dialog table in the Direct Editor.

6. Create a message loop in your script for the custom dialog. The message loop repeatedly calls the function
WaitOnDialog, which returns the numeric control ID for the control with which user interacts with. A typical message
loop appears as follows.

// repeatedly call WaitOnDialog until the user exits the dialog

// with the Next, Back, or Cancel button
while (!bDone)

// wait for the user to interact with a control,

// then return its ID
nCtrl = WaitOnDialog("CustomDialog");

// use a switch statement to handle the different controls

switch (nCtrl)

case CONTROL1:
// do something when user clicks CONTROL1

case CONTROL2:
// do something when user clicks CONTROL2

// case statements for other controls

endswitch;

endwhile;

For example, CustomDialog currently contains Next, Back, and Cancel buttons. Its message loop might appear as
follows:

while (!bDone)

nControl = WaitOnDialog("CustomDialog");

switch (nControl)

case DLG_INIT:
// Initialize the back, next, and cancel button enable/disable
// states for this dialog and replace %P, %VS, %VI with

InstallShield 2020 User Guide ISP-2600-UG00 977

Chapter 4
Defining the End-User Interface

// IFX_PRODUCT_DISPLAY_NAME, IFX_PRODUCT_DISPLAY_VERSION, and

// IFX_INSTALLED_DISPLAY_VERSION, respectively, on control IDs 700-724 and 202.
hwndDlg = CmdGetHwndDlg("CustomDialog");
SdGeneralInit("CustomDialog", hwndDlg, 0, "");

case BUTTON_BACK:
// user clicked Back
nReturn = BUTTON_BACK;
bDone = TRUE;

case BUTTON_NEXT:
// user clicked Next
nReturn = BUTTON_NEXT;
bDone = TRUE;

default:
// check standard control handling
if (SdIsStdButton(nControl) && SdDoStdButton(nControl)) then
bDone = TRUE;
endif;

endswitch;

endwhile;

7. When the end user exits the dialog by clicking Back or Next, you should remove the dialog from the screen and from
memory using EndDialog and ReleaseDialog:

EndDialog("CustomDialog");
ReleaseDialog("CustomDialog");

To use the dialog in the main script, add a call to the CustomDialog function in, for example, the OnFirstUIBefore
event handler of Setup.rul.

Dlg_SdWelcome:
szTitle = "";
szMsg = "";
nResult = SdWelcome(szTitle, szMsg);

Dlg_CustomDlg:
nResult = CustomDialog( );
if (nResult = BUTTON_BACK) goto Dlg_SdWelcome;

// etc.

If the end user clicks Back or Next, the script displays the previous or following dialog. If the user clicks Cancel, the
standard confirmation dialog (handled by the OnCanceling event handler) is displayed.

Note • For information on implementing dialog control functionality, see Using InstallScript to Process Dialog Controls.

Special Messages
In addition to returning control identifiers, the WaitOnDialog function returns some special messages.

978 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• Immediately before the dialog is displayed on the screen, WaitOnDialog returns the message constant DLG_INIT. In
the DLG_INIT case statement, you can set the default states of check boxes and radio buttons, populate and set the
current selection in a list box or combo box control, or set the initial text of an edit field.

• If an error occurs, WaitOnDialog returns the constant DLG_ERR.

Using InstallScript to Process Dialog Controls

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

In InstallScript and InstallScript MSI installation projects, you use InstallScript to process the controls that you add to your
custom dialogs.

Using Check Box Controls

In addition to handling button clicks, a custom dialog generally needs to be able to retrieve the end user’s selections in
dialog controls such as check boxes.

Note • InstallShield has a standard dialog called AskOptions. This dialog displays up to nine check boxes or radio buttons,
and therefore it is not necessary to create a custom dialog to display only check boxes to the end user.

As with push buttons, for each check box control that you add to a dialog, you generally add a #define statement to your
script that assigns a symbolic name to the numeric control ID. For example, if you add a check box control to a custom
dialog, the control’s numeric ID will appear in the Control Identifier property of the control. If the numeric ID is 1302, you
would add the following line to your script.

#define MYCHECKBOX1 1302

For most types of controls, InstallScript defines CtrlGet and CtrlSet functions with which you can get or set the current
state or data for a control. For example, you can get and set the current state of a check box control using CtrlGetState and
CtrlSetState. In the DLG_INIT case of your dialog’s message loop, you can call CtrlSetState to set the initial selection state
of the check box. The following code causes the check box to appear initially selected.

case DLG_INIT:
// Initialize the back, next, and cancel button enable/disable states for this dialog
// and replace %P, %VS, %VI with IFX_PRODUCT_DISPLAY_NAME, IFX_PRODUCT_DISPLAY_VERSION,
// and IFX_INSTALLED_DISPLAY_VERSION, respectively, on control IDs 700-724 and 202.
hwndDlg = CmdGetHwndDlg("CustomDialog");
SdGeneralInit("CustomDialog", hwndDlg, 0, "");
CtrlSetState("CustomDialog", MYCHECKBOX1, BUTTON_CHECKED);

Similarly, you can add the following code outside the dialog’s message loop to detect the final selection state of the check
box.

nState = CtrlGetState("CustomDialog", MYCHECKBOX1);

if (nState = BUTTON_CHECKED) then
// check box selected

InstallShield 2020 User Guide ISP-2600-UG00 979

Chapter 4
Defining the End-User Interface

else
// check box unselected
endif;

Using Edit Fields

You can also add edit controls to a custom dialog, which allow the end user to enter a single line of text. InstallShield has
standard dialogs called SdShowDlgEdit1, SdShowDlgEdit2, and SdShowDlgEdit3, which display one, two, or three edit
fields in which the end user can enter text.

You can read the text stored in an Edit control with CtrlGetText. For example, to read the text from an Edit control with
resource ID 10000 into a string variable called svEdit, you can use the following code:

CtrlGetText("CustomDialog", 10000, svEdit);

Similarly, you can set the initial text stored in an Edit control (in the DLG_INIT block of the message-loop’s switch
statement) with CtrlSetText.

Tip • You can use the Password attribute of an edit control to hide the characters that the end user types into the edit field.
You can use the Number attribute to allow the end user to enter only numbers in the edit field.

Using List Box and Combo Box Controls

List box and combo box controls need to be associated with a variable of type LIST. Before displaying the list box control,
you should populate a string-list variable, and associate it with the list box or combo box control using CtrlSetList in the
dialog’s DLG_INIT handler. (For a combo box control, you will usually set the Drop-Down List property to True, and set the
Height property to the height of the drop-down-list portion of the control.)

To set the initial selection in a list box or combo box control, you can call CtrlSetCurSel in the dialog’s DLG_INIT handler;
and to retrieve the user’s current selection call CtrlGetCurSel. For example, the following code populates a list variable
with the drive letters of every available drive (using GetValidDrivesList), associates the list with a combo-box control, and
then reads the end user’s selection from the combo box before exiting the dialog.

function NUMBER CustomDialog( )

NUMBER nReturn;
NUMBER nControl;
BOOL bDone;
// variables for combo box list and current selection
LIST listDrives;
STRING svDrive;
begin
nReturn = EzDefineDialog("CustomDialog", ISUSER, "CustomDialog", 0);

bDone = FALSE;

// create the list containing the combo box items

listDrives = ListCreate(STRINGLIST);
// fill the list with all available drive letters
GetValidDrivesList(listDrives, -1, -1);

while (!bDone)

nControl = WaitOnDialog("CustomDialog");

980 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

switch (nControl)

case DLG_INIT:
// Initialize the back, next, and cancel button enable/disable states
// for this dialog and replace %P, %VS, %VI with IFX_PRODUCT_DISPLAY_NAME,
// IFX_PRODUCT_DISPLAY_VERSION, and IFX_INSTALLED_DISPLAY_VERSION,
// respectively, on control IDs 700-724 and 202.
hwndDlg = CmdGetHwndDlg("CustomDialog");
SdGeneralInit("CustomDialog", hwndDlg, 0, "");
CtrlSetState("CustomDialog", MYCHECKBOX1, BUTTON_CHECKED);
// associate the list with the combo box
CtrlSetList("CustomDialog", MYCOMBOBOX1, listDrives);
// get the first drive letter from the list...
ListGetFirstString(listDrives, svDrive);
// ...and make it the current selection
CtrlSetCurSel("CustomDialog", MYCOMBOBOX1, svDrive);
// ...cases for other controls...

endswitch;

endwhile;

// get the end user's selection, and display it in a message box

CtrlGetCurSel("CustomDialog", MYCOMBOBOX1, svDrive);
MessageBox("You selected drive " + svDrive, INFORMATION);

EndDialog("CustomDialog");
ReleaseDialog("CustomDialog");

return nReturn;
end;

List box and combo box controls have a Sorted property, which you can set to Yes to sort the contents of the list controls by
the items’ display names.

Editing Dialog Behavior in an InstallScript or InstallScript MSI Project

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

To change the behavior of a dialog, you can modify the dialog function’s parameters according to how you want the dialog
to behave. To learn about the available parameters, refer to the dialog function documentation:

• Dialog Functions

• Dialog Customization Functions

InstallShield 2020 User Guide ISP-2600-UG00 981

Chapter 4
Defining the End-User Interface

See Also
OnFirstUIBefore
OnFirstUIAfter
OnMaintUIBefore
OnMaintUIAfter
Event Handlers

Adding a Field That Contains a Product Name, Product Version, or Installed Version in Sd
Dialog Static Text Fields
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

InstallShield enables you to place your product name, product version, or installed version globally in Sd dialog static text
fields containing the placeholder %P, %VS, or %VI (sometimes appearing as an extra space). At run time, the values of the
system variables IFX_PRODUCT_DISPLAY_NAME, IFX_PRODUCT_DISPLAY_VERSION, and
IFX_INSTALLED_DISPLAY_VERSION are displayed in place of %P, %VS, and %VI in the static text fields.

If you are adding a static text field containing a placeholder, give the static text field a unique (to that dialog) ID in the range
of 701 through 799. IDs in the 701 through 799 range instruct InstallShield to scan the static text field for the existence of
the placeholders. If a placeholder is found, InstallShield replaces it with the value of the corresponding system variable.

Using an HTML Control on a Dialog

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

InstallShield includes support for HTML controls on dialogs in InstallScript and InstallScript MSI projects. HTML controls
enable you to use HTML markup for dialog controls. You can include on dialogs links to Web pages, installed HTML files,
and HTML support files. If an end user clicks the hyperlink on the run-time dialog, you can have the HTML page open in an
Internet browser, or you can trigger other behavior that you have defined through your InstallScript code. The HTML
control lets you use any valid HTML markup, including styles to control their appearance.

The HTML control also lets you display the HTML content directly on a dialog if the content is an installed HTML file or HTML
support file.

To create an HTML control, you need to start with a static text control. Once you have placed the static text control on a
dialog, you can convert it to be an HTML control.

982 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Task To convert any static text control on a dialog to be an HTML control, do one of the following:

• In the Dialogs view, set the Text property of the control as follows:

[html] HTML Markup

• Use InstallScript to set the text of a control to be [html], followed by the HTML markup.

At run time, the InstallScript engine converts the control to an HTML control.

Example
The following example demonstrates how to convert a static text control to an HTML control. The sample HTML code
enables you to set the colors and fonts of the control so that they match those of the dialog.

Task To convert a static text control to an HTML control by using the control’s Text property:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click the dialog that you want to contain the HTML control, and then click Edit.
InstallShield displays the dialog in the Dialog Editor, using the project’s default language.

3. Click the static text control that you want to convert to an HTML control. InstallShield displays its properties in the
right pane.

4. In the Text property, click the ellipsis button (...). InstallShield displays a list of all of the current strings in the project.

5. Click the Edit button.

6. Set the value of the string identifier as follows:

[html]<style type="text/css">html,body {padding:0; margin:0; background-color:ButtonFace} * {font-

size: 8pt; font-family: "MS Sans Serif";} </style> <a href="http://www.MyWebSite.com">Visit my Web
site</a>

At run time, the installation uses the default InstallScript dialog font (8 point MS Sans Serif) and sets the background color
to the Windows dialog color, which is usually gray. If the content is on a dialog area that is white, you can omit the
background-color:ButtonFace style part so that the background of the HTML control becomes white.

Tip • As an alternative to converting the static control through the Dialogs view, you could edit the dialog’s script function in
the InstallScript view. For example, add the following code to the DLG_INIT case in the dialog message loop:

CtrlSetText( szDlg, HTML_CTRL_ID, "[html]<style type=\"text/css\">html,body {padding:0; margin:0;

background-color:ButtonFace} * {font-size: 8pt; font-family: "MS Sans Serif";} </style><a href=\"http:/
/www.MyWebSite.com\">Visit my Web site</a>" );

For sample script, see CtrlGetUrlForLinkClicked Example.

Handling Click Events for Links in HTML Controls

If you use the CtrlSetText function to set HTML control content at run time and the control creation succeeds, CtrlSetText
returns 0. If it fails, CtrlSetText returns ISERR_GEN_FAILURE.

InstallShield 2020 User Guide ISP-2600-UG00 983

Chapter 4
Defining the End-User Interface

To handle click events for links in HTML controls, the WaitOnDialog function returns the control ID of the HTML control
(which is also the control ID of the original static text control). A custom dialog script function can contain a case statement
that handles the HTML control ID, and then calls the CtrlGetUrlForLinkClicked function to obtain the URL for the link that
was clicked. With this link, the script can take any action (such as launching an Internet browser to navigate to the link).

The following behavior occurs when an end user clicks a link for an HTML control that uses the anchor tag:

• If the anchor tag does not include the target attribute, or if the target value does not result in a new window, the
control ID is returned to the dialog script. This allows for the script to handle link clicks itself.

• If the anchor tag does include the target attribute and its value is _blank or some other equivalent value that results in
a new window, no message is sent to the script, and the URL is automatically launched.

Special Considerations for HTML Controls

If you are adding HTML controls to dialogs, note the following details.

Run-Time Requirements for HTML Controls

The HTML control requires Internet Explorer 5.5 or later for full functionality. If an earlier version is present on a target
system, the only way to set the content for the HTML control is to provide an HTML file to CtrlSetText. Note that Internet
Explorer does not need to be the default browser on the target system.

HTML Control Support for HTML Files

If you using an HTML file with an HTML control, you must specify the full path to the file through the CtrlSetText function.
Otherwise, the InstallScript engine will not know where the file is located. Following is sample InstallScript:

CtrlSetText(szDlg, HTML_CTRL_ID, "[html]file://" + SUPPORTDIR^"aboutpage.htm");

Using an HTML Control for an Email Address

If you want to add a hyperlink that points to an email address, you can use code such as the following:

CtrlSetText(szDlg, HTML_CTRL_ID, "[html]<a

href=\"mailto:[email protected]?Subject=Example%20Line\">Send email to Support</a>");

When an end user clicks such a link, a new email message is automatically opened in the target system’s email application.
Note that with the mailto link, no message is sent to the script.

HTML Text Content Is Not Formatted

Any content set in an HTML control is passed as is. No formatting of the content is performed. If you need to format any of
the content, you can manipulate the content string in script and then pass the content string to CtrlSetText.

Character Count Limits for the Text Property of Static Text Controls
The Text property of static text controls has a maximum limit of 256 characters. Therefore, if you convert a static text
control to an HTML control by adding [html] to the beginning of the text content for a control, the maximum number of
characters that you can enter is 256; this includes the hyperlinked text as well as all characters for any HTML markup that
you specify. If you need to enter more than 256 characters for the content, use the CtrlSetText function to create the
control.

984 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Adding Support Files
CtrlSetText
CtrlGetUrlForLinkClicked

Reverting to the Default Dialog

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

If you have edited a dialog and you later decide that you want to undo all of your changes, you can revert back to the
original default dialog.

Task To revert to the default dialog:

1. In the View List under User Interface, click Dialogs.

2. Right-click the edited dialog and click Revert.

Resource Compiler and Resource Linker

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

To modify dialogs in InstallScript or InstallScript MSI projects, you must have a resource compiler and resource linker
installed on your system. InstallShield includes both of these types of tools.

Task To view the location of the compiler and linker:

1. On the Tools menu, click Options. The Options dialog box opens.

2. Click the Resource tab.

The Resource tab lists the locations of the compiler and linker.

InstallShield 2020 User Guide ISP-2600-UG00 985

Chapter 4
Defining the End-User Interface

Task To replace the resource compiler or resource linker with one that is already on your system:

1. On the Tools menu, click Options. The Options dialog box opens.

2. Click the Resources tab.

3. Click the Browse button next to the Resource compiler location box or the Resource linker location box to navigate
to the program file.

Dialog Sampler
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The Dialog Sampler is an InstallShield wizard that displays samples of all built-in dialogs as well as dialogs called by script
dialog (sd) functions in InstallScript and InstallScript MSI projects. You can launch two different varieties of the Dialog
Sampler.

Task To launch the Dialog Sampler:

On the Tools menu, point to InstallScript, and then click either Standard Dialog Sampler or Skinned Dialog Sampler.

You can also launch these samplers using the shortcut in the InstallShield program folder on the Programs menu.

Dialog Skins
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Overview
Dialog skins enable you to display end-user dialogs with a different look and color scheme. Skinned dialogs are slightly
larger than standard dialogs, and the controls are located differently. For skinned dialogs to display properly, the desktop
area on the target machine must be at least 800 by 600 pixels (or if large fonts are used, 1024 by 768 pixels), and the system
must display at least 16-bit color.

Limitations
There are limitations when using dialog skins in your project:

986 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• A dialog skin cannot be applied to or removed from a standard dialog once you have edited that dialog in the Dialog
Editor. Therefore, if you want to specify skins for dialogs that you want to modify, specify the skin first, and then edit it.

• The location of the standard navigation buttons (Next, Cancel, Back, Finish) are the same for all skins. The .skin file
controls their position. Moving them in the Dialog Editor has no effect on the run-time positioning. There are also
some Browse buttons on a few dialogs (for example, SdAskDestPath) that cannot be repositioned.

• Skinned dialogs cannot use windowed billboards. To learn more about the windowed style of billboard, see Billboard
Styles and File Types for InstallScript and InstallScript MSI Projects.

• If you add custom dialogs to your project, the new dialogs should be the same size as the other end-user dialogs. If the
custom dialogs are a different size, they may not be displayed correctly; for example, the navigation buttons might not
be visible to the end user during run time, due to the positioning issue described above.

Note • If you want to specify a dialog skin for a custom dialog, you must set the skin before creating the custom dialog in the
Dialog Editor in order for the skin to appear properly.

Specifying Dialog Skins

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

You can use a dialog skin to change the look of the end-user dialogs in your installation. You can specify one skin per
installation project. All of the dialogs in your project are displayed using the selected skin.

Note • A dialog skin cannot be applied to or removed from a standard dialog once you have edited that dialog in the Dialog
Editor. Therefore, if you want to specify skins for dialogs that you want to modify, specify the skin first, and then edit it.

If you want to specify a dialog skin for a custom dialog, you must set the skin before creating the custom dialog in the Dialog
Editor in order for the skin to appear properly.

Selecting a Dialog Skin

Task To select a dialog skin:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the Skins item to see the available dialog skin options.

3. Click a skin to see a preview dialog displayed in the right pane.

4. To select a displayed skin, click Select in the preview pane. A red check mark appears on the selected skin’s icon in the
Dialogs explorer.

InstallShield 2020 User Guide ISP-2600-UG00 987

Chapter 4
Defining the End-User Interface

All of the dialog skins use .gif files for the fade graphic, with the exception of the Blue skin. The Blue skin uses a .bmp file,
which results in a larger file size. The Blue skin’s appearance on a 16-bit color system is not as clean as the other colors
when a .gif file is used. If you want to use a Blue skin that supports 16-bit color systems and file size is not an issue, select
the Blue option. For a smaller file size, select the BlueTC (True Color) option, which uses a .gif file for the graphic.

Clearing Dialog Skin Selections

Task To clear the dialog skin selection:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the Skins item to see the available dialog skin options, and select the <None> item.

3. Click Select in the preview panel.

See Also
Dialog Skins

Working with Dialogs in Basic MSI Projects

InstallShield 2020

The information in this section of the documentation explains how to create and perform other basic functions with
dialogs in Basic MSI projects.

Task The process of creating a new dialog and displaying it in your installation can be broken down into the following tasks:

1. Add the dialog to the project.

2. Edit the dialog’s layout.

3. Define the controls’ behavior (under what conditions they should be displayed, the events that their interaction
should trigger, and the events that they should subscribe to).

4. Display the dialog with a NewDialog or SpawnDialog event in another dialog’s control or by inserting the dialog into
your project’s sequences.

See Also
Dialogs View (Basic MSI and Other Windows Installer–Based Projects)

Displaying Dialogs During Basic MSI Installations

InstallShield 2020

You can display an end-user dialog in one of two ways, as described below:

• Insert the dialog into a User Interface sequence.

• Launch the dialog through another dialog’s behavior.

988 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Inserting Dialogs into Sequences

Project • When you create a dialog in a merge module, you cannot insert it into a sequence until you associate that module
with an installation project.

Task To schedule a dialog in a sequence:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences.

2. In the Sequences explorer, expand one of the two high-level sequences in which dialogs are usually displayed—
Installation, Advertisement, or Administration—to view its User Interface sequence.

3. Expand the User Interface sequence to see how the existing actions, dialogs, and custom actions are ordered.

4. Right-click the existing action or dialog that you want your dialog to follow in the sequence, and then click Insert. The
Insert Action dialog box opens.

5. In the list, select Dialogs.

6. Select your new dialog from the list of dialogs.

7. Click OK.

When your installation runs with a full user interface (determined by the /q command-line parameter) and all conditions
are met for this dialog, it will be displayed within the selected sequences.

While InstallShield lets you insert a dialog into an Execute sequence, doing so violates ICE13.

Launching a Dialog Through Another Dialog’s Behavior

Most dialogs are displayed as a result of the NewDialog (displays another dialog in the wizard) or SpawnDialog (shows a
modal dialog) control event. By selecting this event in a dialog’s behavior, usually for a Next button, you can specify the
dialog that succeeds it. By adding a condition to the control event, you could present different dialogs depending on the
result of a selection in the preceding dialog.

Task For example, to display a WelcomeBitmap dialog after the InstallWelcome dialog:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the InstallWelcome dialog, and then click its Behavior subnode.

3. In the pane that contains a list of controls and the corresponding control types, select the Next button.

4. In the Events setting, click the New Event button, and then click NewDialog. InstallShield adds some NewDialog
subsettings under the Event setting.

5. In the NewDialog setting, enter the following: 1

A condition of 1 indicates that the dialog should be created under all conditions.

6. In the Dialog Name setting, enter the following: WelcomeBitmap

InstallShield 2020 User Guide ISP-2600-UG00 989

Chapter 4
Defining the End-User Interface

Note • If the InstallWelcome dialog had launched a different dialog from the Next button, you would repeat the above
procedure for the WelcomeBitmap’s Next button to show the next dialog.

To learn about viewing your new dialog in the Custom Actions and Sequences view, see Viewing End-User Dialog Order in
the Custom Actions and Sequences view (Basic MSI Projects).

Creating New Dialogs in Basic MSI Projects

InstallShield 2020

Task To create a new dialog in a Basic MSI project:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, right-click All Dialogs and click New Dialog. The Dialog Wizard launches to help you create a
new dialog.

The next step is to edit the dialog’s layout and the controls’ behavior.

Tip • You can also add a dialog by importing one from another project.

Displaying a Dialog in the End-User Interface

Adding a dialog to a project does not mean that the dialog will be displayed in the installation. For information on inserting
the dialog into one or more of the project’s sequences, see Displaying Dialogs During Basic MSI Installations.

See Also
Removing Dialogs from Projects

Editing Dialog Layout in Basic MSI Projects

InstallShield 2020

Using the Dialog Editor, you can modify a dialog, edit its controls, and set display properties for the dialog and its controls,
all in a visual environment.

Note • When an end user runs your installation on a Windows platform that uses a desktop display theme, the theme is used
to display your installation’s end-user dialogs.

The Dialogs view manages versions of the dialog for each of your project’s supported languages. You must select a
language-specific version in order to edit the layout. These versions remain identical except for changes you make to a
control’s size. For more information, see Modifying Dialogs for Each Language.

990 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Opening the Dialog Editor

InstallShield 2020

Task To open a dialog in the Dialog Editor, do any of the following:

• Select the language-specific version of the dialog under the dialog’s name in the Dialogs view.

• In the Custom Actions and Sequences view, right-click the dialog and click Edit Layout.

The Dialog Editor opens in the right pane of the Dialogs view.

Adding a Control to a Dialog in a Basic MSI Project

InstallShield 2020

You can use the Controls toolbar in InstallShield to add controls to a dialog.

Task To add a control to a dialog:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the All Dialogs folder, and then expand the dialog item that should have the new
dialog control.

3. Click a language under the dialog item that you expanded. The Dialog Editor in the center pane shows the dialog in the
selected language.

4. In the Controls toolbar, click the control that you want to add.

5. Draw a rectangle on the dialog in the location where you want the control to be displayed.

6. In the right pane, set the control’s properties.

Tip • If you are editing an InstallShield project from within Microsoft Visual Studio, you can use the Toolbox to add controls.

See Also
Showing or Hiding Toolbars
Creating InstallShield Projects in Microsoft Visual Studio
Using the Toolbox to Add Dialog Controls

Configuring the Controls’ Settings

InstallShield 2020

The dialog itself and every control on it has a grid of settings in the Dialog Editor. These settings determine characteristics
such as a control’s size and position, its default text (as a string identifier), or whether the dialog is modal.

To edit the settings of a control, select the control on the dialog. The settings vary depending on the type of control:

• Bitmap

• Dialog

InstallShield 2020 User Guide ISP-2600-UG00 991

Chapter 4
Defining the End-User Interface

• Check Box

• Push Button

• Edit Field

• Combo Box

• Text Area

• List Box

• Radio Button

• Bitmap

• Group Box

• Billboard

• Line

• Radio Button Group

• Selection Tree

• Progress Bar

• List View

• Scrollable Text

• Icon

• Directory List

• Directory Combo

• Volume Cost List

• Volume Select Combo

• Masked Edit

• Path Edit

Displaying Controls on Top of a Bitmap

InstallShield 2020

Task To display controls on top of a bitmap:

• The value for the Tab Index property of the bitmap must be lower than the value for the Tab Index property of any
controls that are to be placed on top of the bitmap. The easiest way to configure this is to set the bitmap control’s Tab
Index property to 0.

• All controls—including the bitmap—must have their Tab Stop properties set to True.

992 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Copying and Pasting Controls
Undoing Changes in the Dialog Editor

Editing Dialog Behavior in Basic MSI Projects

InstallShield 2020

In the Dialogs view, you can configure settings to specify how controls will behave at run time. The behavior-related
settings for a control enable you to configure the following types of functionality:

• Events that an end user interacting with the control will trigger

• Windows Installer events to which a control needs to subscribe

• Conditions under which the control will be displayed

Task To access the behavior settings for a control:

1. Do one of the following:

• In the Dialogs view, expand the dialog node for the dialog that you want to modify, and then click its Behavior
subnode.

• In the Custom Actions and Sequences view, right-click the dialog and click Edit Behavior.

2. In the center pane, which shows a list of all of the controls on the selected dialog, click the control that you want to
configure. Its settings are displayed in the right pane.

3. Configure the Events, Subscriptions, and Conditions settings as needed.

See Also
Using Control Events in Basic MSI Dialogs
Using Subscriptions in Basic MSI Dialogs
Triggering Control Events in Basic MSI Dialogs
Reordering a Dialog Control’s Events

Using Control Events in Basic MSI Dialogs

InstallShield 2020

Control events enable you to provide custom functionality for each control on your dialogs. With control events, you can
launch custom actions, spawn new dialogs, or display a progress bar. Many control events make use of published
information. In some cases, your controls must subscribe to control-event information in order to make use of it.

To associate an event with a control, use the Behavior area for a dialog in the Dialogs view. For more information, see
Editing Dialog Behavior in Basic MSI Projects. To learn about subscriptions for controls, see Using Subscriptions in Basic
MSI Dialogs.

To specify a condition for any event, click the ellipsis button (...) in the event setting.

InstallShield 2020 User Guide ISP-2600-UG00 993

Chapter 4
Defining the End-User Interface

Following is a list of the available control events:

Table 4-3 • Types of Events for Controls

Control Event Description

AddLocal Sets the specified feature (or all features, if ALL is specified) to be installed locally.

To specify the feature, configure this setting's subsetting.

AddSource Sets the specified feature (or all features, if ALL is specified) to be installed to run from
source.

To specify the feature, configure this setting's subsetting.

CheckExistingTargetPat Verifies that the specified path can be written to, and prevents additional control events
h from being triggered unless the specified path exists.

To specify the property that contains the path, configure this setting's subsetting.

CheckTargetPath Prevents additional control events from being triggered unless the specified value is a valid
path.

To specify the property that contains the path, configure this setting’s subsetting.

DirectoryListNew Notifies the directory list control that a new folder must be created. The installer then
creates a new folder and allows the user to enter a new name for the folder.

DirectoryListOpen Notifies the directory list control to open the selected directory. If none is selected, it
prevents additional control events from being triggered.

DirectoryListUp Notifies the directory list control to go up a level, selecting the parent of the current
directory.

DoAction Triggers a custom action when the selected control is activated.

To specify the custom action, configure this setting’s subsetting.

EnableRollback Enables or disables rollback functionality for the installation.

To specify whether you want the event to enable rollback, configure this setting’s
subsetting. A value of True enables rollback; False disables it.

994 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-3 • Types of Events for Controls (cont.)

Control Event Description

EndDialog Dismisses a modal dialog. You can use this event for a push button control or a selection
tree control.

To specify the behavior that should occur for this event, configure this setting’s subsetting.

For regular dialogs, available options are:

• Exit—The dialog sequence closes and control is returned to the installer with the
UserExit value. This option cannot be used with child windows.

• Retry—The dialog sequence closes and control is returned to the installer with the
Suspend value. This option cannot be used with child windows.

• Ignore—The dialog sequence closes and control is returned to the installer with the
Finished value. This option cannot be used with child windows.

• Return—The dialog exits and control is returned to the parent window. If no parent
exists, control is returned to the installer with the Success value.

For error dialogs, available options are:

• ErrorOK

• ErrorCancel

• ErrorAbort

• ErrorRetry

• ErrorIgnore

• ErrorYes

• ErrorNo

MsiLaunchApp

Note • Windows Installer 5 includes support for this event. Earlier versions of Windows
Installer ignore this event. Therefore, if your installation is run on a system that has Windows
Installer 4.5 or earlier and you want to use this event, add a condition to the dialog control so
that it is not displayed on systems that have Windows Installer 4.5 or earlier.

Runs a specified file.

This event is typically used for a check box control on the SetupCompleteSuccess dialog.
The check box enables end users to choose whether to run the application at the end of the
installation. The check box control should include a condition that prevents the control
from being displayed during uninstallation.

To specify the command line for launching the file, configure this setting’s subsetting.

InstallShield 2020 User Guide ISP-2600-UG00 995

Chapter 4
Defining the End-User Interface

Table 4-3 • Types of Events for Controls (cont.)

Control Event Description

MsiPrint

Note • Windows Installer 5 includes support for this event. Earlier versions of Windows
Installer ignore this event. Therefore, if your installation is run on a system that has Windows
Installer 4.5 or earlier and you want to use this event, add a condition to the dialog control so
that it is not displayed on systems that have Windows Installer 4.5 or earlier.

Enables end users to print the contents of the control.

You can add this event to a push button control that is on a dialog that has a scrollable text
control. When an end user clicks the push button control, the contents of the scrollable text
control are printed.

NewDialog Advances to another dialog.

To specify the new dialog, configure this setting’s subsetting.

Reinstall Reinstalls the specified feature (or all features, if ALL is specified).

To specify the feature, configure this setting’s subsetting.

Remove Indicates that the specified feature (or all features, if ALL is specified) is selected for
removal.

To specify the feature, configure this setting’s subsetting.

Reset Resets all of the property changes that all of the controls on the dialog have performed to
their original values.

RMShutdownAndRestart Indicates that the Restart Manager should shut down all applications that have files in use
and restart them at the end of the installation.

SelectionBrowse Launches the specified Browse dialog that enables the end user to modify the path of the
highlighted item.

To specify the dialog, configure this setting’s subsetting.

SetInstallLevel Sets the INSTALLLEVEL property to the specified value.

To specify the appropriate installation level, configure this setting’s subsetting.

SetProperty Sets the value of a property.

To specify the property and value, configure this setting’s subsettings.

SetTargetPath Checks and sets the selected path.

To specify the property that contains the path, configure this setting’s subsetting.

SpawnDialog Launches the specified dialog of a modal dialog without closing the current dialog.

996 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-3 • Types of Events for Controls (cont.)

Control Event Description

SpawnWaitDialog Launches a dialog that waits until the conditional expression evaluates as True; then the
dialog closes.

ValidateProductID Sets the ProductID property.

See Also
Adding New Events to a Dialog Control
Reordering a Dialog Control’s Events
Using Subscriptions in Basic MSI Dialogs
Triggering Control Events in Basic MSI Dialogs

Using Subscriptions in Basic MSI Dialogs

InstallShield 2020

The Windows Installer service provides volumes of information to the installation during the run time. One of the most
useful ways to gather information during installation is to use subscriptions. To subscribe to something is commonly
defined as entering one’s name for a publication or service. In Windows Installer terms, actions generally publish
information, and dialog controls generally subscribe to information.

Examples of Common Uses for Subscriptions

The best example of this relationship centers around progress bars. The InstallFiles action publishes information on the
percentage of files moved and the percentage remaining to be moved. When a progress bar subscribes to this information,
it is able to accurately display the progress of the installation’s file transfer process.

Windows Installer tracks progress through what are called ticks. When your progress bar subscribes to this information, it is
passed the ticksSoFar and totalTicks values. The progress bar uses this information to display the total progress of the
installation.

Subscriptions are not used only for progress bars. You might have a custom action that validates a serial number as part of
your installation. This action could publish the failure or success of validation. On a dialog, you could have a Next button
that subscribes to this information. If the action publishes the failure of the validation, the button remains disabled. If the
action publishes success, the button is enabled.

Types of Subscriptions
To set up a subscription for a control, use the Behavior area for a dialog in the Dialogs view. For more information, see
Editing Dialog Behavior in Basic MSI Projects.

InstallShield 2020 User Guide ISP-2600-UG00 997

Chapter 4
Defining the End-User Interface

Following is a list of the available events to which controls can subscribe:

Table 4-4 • Types of Events to Which Controls Can Subscribe

Event Description

ActionData Displays information about the latest action.

A text control can subscribe to this event to display information such as the names of files
that are being copied during the installation.

ActionProgress Displays progress information about an action that is being monitored.

A progress bar control can subscribe to this event.

To specify the action, configure this setting’s subsetting.

ActionText Displays the name of the present action.

A text control can subscribe to this event to display a description of the current action that
is being performed during the installation.

IgnoreChange Highlights a folder in the current directory without opening the folder.

ScriptInProgress Displays informational text while Windows Installer is compiling the installation's
execution script.

SelectionAction Displays a UI string that describes the highlighted item.

A text control can subscribe this event to display the UI string.

SelectionDescription Displays a UI string in a text control. The UI string describes the feature that is selected in
the selection tree control.

SelectionNoItems Removes description text or disables an unnecessary button.

SelectionPath Publishes the path of the item that is selected in the selection tree control.

A text control can subscribe this event to display the path.

SelectionPathOn Publishes a Boolean value that indicates whether a selection path is associated with the
currently selected feature.

SelectionSize Publishes the size of the highlighted item.

SetProgress Publishes information about the installation’s progress.

TimeRemaining Publishes the approximate number of seconds that remain for the current progress
sequence.

A text control can subscribe this event to display the remaining time.

998 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Using Action Text
Using Control Events in Basic MSI Dialogs

Triggering Control Events in Basic MSI Dialogs

InstallShield 2020

An event is a predefined action that occurs when an end user interacts with a control. Events are defined in the Behavior
area of the Dialogs view. For more information on each of the events that are available, see Using Control Events in Basic
MSI Dialogs.

To view a control’s events, select it in the list of control names and then configure the Events setting in the right pane.

Adding New Events to a Dialog Control

InstallShield 2020

Task To add a new event to a dialog control:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the dialog node for the dialog that you want to modify, and then click its Behavior
subnode.

3. In the center pane, which shows a list of all of the controls on the selected dialog, click the control that you want to
configure. Its settings are displayed in the right pane.

4. In the Events setting, click the New Event button, and then select the type of event that you want to add. InstallShield
adds a new set of rows under the Events setting.

5. To specify a condition for the event, click the ellipsis button (...) in the new event setting. The Condition Builder
dialog box opens, enabling you to specify the conditions that must be met for the action.

If you want the event to be triggered under any conditions, enter the following condition:

6. If the event setting has a subsetting, configure the subsetting as needed.

Reordering a Dialog Control’s Events

InstallShield 2020

The events that are configured for a user interface control are launched at run time in the order in which they are displayed
for that control’s Events setting.

Task To move an event:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the dialog node for the dialog that you want to modify, and then click its Behavior
subnode.

InstallShield 2020 User Guide ISP-2600-UG00 999

Chapter 4
Defining the End-User Interface

3. In the center pane, which shows a list of all of the controls on the selected dialog, click the control that has the events
that you want to reorder. Its settings are displayed in the right pane.

4. In the Events area of the grid of settings, find the event setting of an event that you want to move.

5. In the event setting for an event that you want to move, click the Move Event button, and then click Move Up or Move
Down.

Removing an Event from a Dialog Control

InstallShield 2020

Task To remove an event from a control:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the dialog node for the dialog that you want to modify, and then click its Behavior
subnode.

3. In the center pane, which shows a list of all of the controls on the selected dialog, click the control that has the event
that you want to remove. Its settings are displayed in the right pane.

4. In the Events area of the grid of settings, find the event setting of the event that you want to remove.

5. In the event setting, click the Delete Event button.

Launching Custom Actions from Dialog Buttons

InstallShield 2020

To launch a custom action from a button on a dialog, use the button control’s DoAction event. Before you can set up a
DoAction event, you need to create a custom action.

When you have created a custom action, you can set up a DoAction event to launch this action.

Task To launch a custom action from a push button control:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the dialog node for the dialog that you want to modify, and then click its Behavior
subnode.

3. In the center pane, which shows a list of all of the controls on the selected dialog, click the push button control that
you want to trigger the custom action. Its settings are displayed in the right pane.

4. In the Events setting, click the New Event button, and then click DoAction. InstallShield adds a new set of rows under
the Events setting.

5. To specify a condition for the event: In the DoAction setting, click the ellipsis button (...). The Condition Builder
dialog box opens, enabling you to specify the conditions that must be met for the action.

6. In the Action subsetting, specify the name of the action that you want to associate with the control.

Build and test your installation to ensure that it works as expected.

1000 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Viewing End-User Dialog Order in the Custom Actions and Sequences view (Basic MSI Projects)
InstallShield 2020

Project • This information applies to Basic MSI projects. To view the order of your end-user dialogs in an InstallScript project
or an InstallScript MSI project, use the InstallScript view to review your script.

In the Custom Actions and Sequences view, you can view primary and next dialogs in the order in which they appear to the
end user during the run time of your installation. Primary dialogs are top-level dialogs that have been inserted into the
installation sequence. You can change the order of a primary dialog within the Custom Actions and Sequences view.

Next dialogs are dialogs that are triggered by the action of a previous dialog’s Next button control events. Although you can
view next dialogs in the Custom Actions and Sequences view, they are not a part of the installation sequence, and you
cannot change their order in the Custom Actions and Sequences view. To change the order of a next dialog, you must use
the Behavior node under a dialog in the Dialogs view. To learn more, see Editing Dialog Behavior in Basic MSI Projects.

Initial Sequences Explorer

When you first open the Custom Actions and Sequences view, the Sequences explorer lists all primary dialogs and actions
in the order in which they will be executed during your installation. Many of the next dialogs have plus signs (+) next to
them.

Expanded Sequences Explorer

In addition to viewing the order of primary dialogs that have been inserted into the installation sequence, you can also
view next dialog order in the Sequences explorer.

When you click the plus sign (+) next to a primary dialog, the list expands to display the order in which the primary dialog’s
next dialogs—if any—will appear during the run time. If a particular dialog has more than one Next button control event, all
possible next dialogs are displayed under the dialog.

Figure 4-3: Viewing the Order of Dialogs in the Sequence

Next Dialog Information Panel

When you click a next dialog, the right pane displays information about the dialog. The right pane also has hyperlinks to the
behavior and layout editors, as well as help information. More detailed information about the selected dialog is available in
the Dialogs view.

InstallShield 2020 User Guide ISP-2600-UG00 1001

Chapter 4
Defining the End-User Interface

Context Menu Commands

When you right-click a primary dialog, a context menu displays commands for you to edit the sequence, refresh the dialog
sequence view, or edit the dialog’s layout or behavior. When you right-click a next dialog, a context menu displays
commands for you to edit the dialog’s layout or behavior.

Edit Behavior

Task To move to the Dialog Behavior Editor from within the Sequences explorer in the Custom Actions and Sequences view,
do either of the following:

• Right-click the next dialog that you want to edit and click Edit Behavior.

• Click the name of the dialog that you want to edit. Then, in the Action Items section of the right pane, click Edit dialog
behavior.

For more information, see Editing Dialog Behavior in Basic MSI Projects.

Edit Layout

Task To move to the Dialog Layout Editor from within the Sequences explorer in the Custom Actions and Sequences view, do
either of the following:

• Right-click the next dialog that you want to edit and click Edit Layout.

• Click the name of the dialog that you want to edit. Then, in the Action Items section of the right pane, click Edit dialog
layout.If you have written your installation in more than one language, you must select the appropriate language in
the list.

For more information, see Editing Dialog Layout in Basic MSI Projects.

CustomSetup Dialog Options

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• MSI Database
• Transform

The CustomSetup dialog has a sophisticated end-user interface that is tightly integrated with information about the target
system, the features in your installation, and Windows Installer installation options. It provides the end user with the most
control over the installation.

Many of the options and information it offers are determined by the feature properties that you set in your setup design, as
described below.

1002 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Advertisement Option
Feature advertisement enables files to be installed on demand after the installation has initially run. In the CustomSetup
dialog, when end users click a feature, they can specify that they want it installed later by selecting the Will be installed
when required option.

However, that default option is present only if you select Allow Advertise or Favor Advertise for the feature’s Advertised
setting. To prevent Windows Installer from displaying the option to advertise the feature, select Disallow Advertise for this
setting.

Hiding Features
When you set a feature’s Display setting to Not Visible, the end user cannot see the feature or its subfeatures in the
CustomSetup dialog and therefore cannot change any of its installation options.

Displaying All Subfeatures

The feature’s Display setting also governs whether its subfeatures are expanded when the dialog first appears with the
following options:

Table 4-5 • Options for the Display Setting of a Feature

Option Description

Visible and Collapsed The feature is displayed in the CustomSetup dialog with its subfeatures collapsed
by default.

Visible and Expanded The feature is displayed in the CustomSetup dialog with its subfeatures expanded
by default.

Setting Default Destination Folders for Features

An end user can view and edit the folder to which a feature will be installed by selecting the feature in the CustomSetup
dialog and clicking the Details button. The feature’s Destination setting is the default value that appears, and it is
reassigned to a new value if the end user enters or browses to a new path in the resulting Feature Details dialog.

For a complete discussion of the factors that affect where a feature is installed, see Setting a Feature’s Destination.

Naming Features
Specify a different name to appear in the CustomSetup dialog by setting its Display Name.

Displaying Feature Descriptions

The description that is shown at the bottom of the CustomSetup dialog when you select a feature is taken from its
Description setting.

Changing the Feature Order

You can change the order in which the features appear to the end user in the CustomSetup dialog. The order in which
features are displayed is dictated by the order in the Setup Design view. For more information, see Reordering Features.

InstallShield 2020 User Guide ISP-2600-UG00 1003

Chapter 4
Defining the End-User Interface

Requiring Features To Be Installed

If you set a feature’s Required setting to Yes, the end user does not see the Will not be available option, meaning that the
feature must be installed.

See Also
Advertising Features

Dialog Themes
InstallShield 2020

Project • Dialog themes are available in Basic MSI projects.

Dialog themes are predefined sets of images that give your end-user dialogs a unified and distinctive look.

With the click of a button, you can select one of the available themes for your project, and InstallShield applies that theme
to all of the interior and exterior dialogs, as well as the Setup.exe initialization dialog, in your project. You can easily
preview each dialog from within the Dialogs view to see how it looks with the selected theme.

Note • InstallShield does not currently let you create your own dialog themes. However, InstallShield includes many themes.
For more information, see Available Themes and Corresponding Dialog Sizes.

See Also
Dialogs View (Basic MSI and Other Windows Installer–Based Projects)

Run-Time Requirements for the Wide Dialog Themes

InstallShield 2020

Project • Dialog themes are available in Basic MSI projects.

If you use one of the wide dialog themes, the screen resolution on target systems must be a minimum of 800×600 pixels (or,
if large fonts are used, 1024×768 pixels). If the resolution is lower than that, a horizontal scrollbar is added at run time to the
bottom of each of the dialogs that is displayed with the wide theme.

See Also
Available Themes and Corresponding Dialog Sizes
Circles Theme (Wide)
Cooperation Theme (Wide)
Filmstrip Theme (Wide)
InstallShield Blue Theme (Wide)
Theater Theme (Wide)

1004 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Previewing a Dialog Theme

InstallShield 2020

Project • Dialog themes are available in Basic MSI projects.

When you select a different theme for your project, InstallShield applies that theme to all of the interior and exterior
dialogs in the Dialogs view. You do not need to build and run your installation in order to view the dialogs.

Task To preview a theme before selecting it for your project:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the Themes folder.

3. Click one of the themes under the Themes folder.

In the right pane, InstallShield shows a screen shot of a sample exterior dialog with the selected theme.

Task To preview how a dialog in your project looks with the selected theme:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the All Dialogs folder, and then expand the dialog item that you want to preview.

3. Click a language under the dialog item that you expanded.

In the center pane, InstallShield displays a preview of the dialog with the selected theme applied.

See Also
Dialogs View (Basic MSI and Other Windows Installer–Based Projects)

Selecting or Changing a Dialog Theme

InstallShield 2020

Project • Dialog themes are available in Basic MSI projects.

You can use a dialog theme to change the look of the end-user dialogs in your installation. You can select one theme per
project.

Tip • If you switch from one of the wide-style themes to a standard-width theme, the positions of any controls that are placed
along the far left or far right sides of the dialog may change.

If you want to change the theme for your project and you also want to add a custom exterior dialog, change the theme first,
and then add the custom exterior dialog. Otherwise, the dialog may not appear properly.

InstallShield 2020 User Guide ISP-2600-UG00 1005

Chapter 4
Defining the End-User Interface

Task To change the dialog theme used for a project:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the Themes folder.

3. Right-click the theme that you want to use, and then click Select.

InstallShield applies the selected theme to the dialogs in your project. In addition, InstallShield displays a red check mark
on the selected theme’s icon in the Dialogs explorer.

Tip • You can also change the theme by clicking a button: In the Dialogs explorer, click the theme that you want to use. Then,
in the right pane, click the Select button.

Background Information on How InstallShield Applies Themes

If you switch from one dialog theme to another, InstallShield applies the theme to any dialogs in your project that match a
specific width and height. Therefore, if you change the width or height of any of the dialogs in your project, and then you
change the theme, InstallShield does not apply the theme to any dialogs that have a custom width or height.

For example, if you switch from a standard width theme to any other theme, InstallShield applies the theme to any dialogs
that have a standard width and height: 374×266. If you switch from a wide theme to any other theme, InstallShield applies
the theme to any dialogs that are 584×274.

Background Information on Which Dialogs Use the Exterior Dialog Style

By default, InstallShield uses the same style of dialog for all exterior dialogs: this style has an image on the left side of the
dialogs. The InstallWelcome and SetupCompleteSuccess dialogs are examples of exterior dialogs.

If you add a custom exterior dialog to your project after you have selected a theme, InstallShield uses the selected theme
for the new custom exterior dialog. However, if you later change the theme for your project, the theme may not be
displayed properly in your custom exterior dialog. To resolve this type of issue, see Applying a Theme to a Custom Exterior
Dialog.

See Also
Available Themes and Corresponding Dialog Sizes
Dialogs View (Basic MSI and Other Windows Installer–Based Projects)

Applying a Theme to a Custom Exterior Dialog

InstallShield 2020

Project • Dialog themes are available in Basic MSI projects.

If you want to change the theme for your project and you also want to add a custom exterior dialog, it is easier to change
the theme first, and then add the custom exterior dialog. Otherwise, the dialog may not appear properly; parts of newly
selected theme’s interior dialog images are added to your custom exterior dialog.

1006 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

If you want to change the theme after you have added a custom exterior dialog to your project, you must add the name of
your custom exterior dialog to the appropriate .theme file that is installed in the InstallShield Program Files folder. Then
you can apply the theme to your project.

Task To change the theme after you have added a custom exterior dialog to your project:

1. Close InstallShield.

2. In the InstallShield Program Files folder, find the .theme file for the theme that you want your dialogs to use. The
default location is:

C:\Program Files\InstallShield\2020\Support\Themes

3. Open the .theme file in a text editor such as Notepad. For example, if you want to use the Global theme, open the
Global.theme file.

4. In the <Include> and <Exclude> sections of the file, add the following line:

<Name>NameOfDialog</Name>

where NameOfDialog represents the name of your dialog.

5. Open your project in InstallShield.

6. In the View List under User Interface, click Dialogs.

7. In the Dialogs explorer, expand the Themes folder.

8. Right-click the theme that you want to use, and then click Select.

See Also
Available Themes and Corresponding Dialog Sizes

Adding a Logo or Other Image to the Exterior Dialogs

InstallShield 2020

Project • Dialog themes are available in Basic MSI projects.

Exterior dialogs are dialogs that are displayed first and last by an installation—typically, the Welcome and Completion
dialogs. The exterior dialogs for some themes have places for you to put the logo of your company or product. For example,
the exterior dialogs of the Monitor theme and the Circles theme have a blank area on the left side of the dialog; you can add
a bitmap control to these dialogs to customize your end-user interface.

Task To add an image to an exterior dialog:

1. In the View List under User Interface, click Dialogs.

2. In the Dialogs explorer, expand the All Dialogs folder, and then expand the dialog item for a dialog that should have
the image.

3. Click a language under the dialog item that you expanded. The Dialog Editor in the center pane shows the dialog in the
selected language.

InstallShield 2020 User Guide ISP-2600-UG00 1007

Chapter 4
Defining the End-User Interface

4. In the Controls toolbar, click the Bitmap button.

5. In the Dialog Editor, click where you want the bitmap control to start, and holding the left mouse button down, drag
the mouse to the place where you want it to end. Then release the left mouse button.

6. Configure the bitmap control’s properties in the right pane.

Click the File Name property, and then click the ellipsis button (...) to browse to the bitmap file that you want to use.

You may want to repeat the procedure for each language and each exterior dialog in your project. The exterior dialogs that
are available by default in all new Basic MSI projects are:

• AdminWelcome

• InstallWelcome

• MaintenanceWelcome

• PatchWelcome

• SetupCompleteError

• SetupCompleteSuccess

• SetupInitialization

• SetupInterrupted

• SetupResume

• SplashBitmap

Available Themes and Corresponding Dialog Sizes

InstallShield 2020

Project • Some of the themes are available in both the Premier and Professional editions of InstallShield, and some are
available in only the Premier edition.

Some of the themes set the size of the dialogs to a standard width and height: 374×266. The wide themes set the dialog size
to 584×274. The following table shows the size of each dialog, plus which editions of InstallShield contain the theme.

Table 4-6 • Dialog Themes in InstallShield

Name InstallShield Edition Dialog Width Dialog Height

Circles Theme (Wide) Premier and Professional 584 274

Classic Theme Premier and Professional 374 266

Cooperation Theme Premier 584 274

(Wide)

Filmstrip Theme (Wide) Premier 584 274

1008 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-6 • Dialog Themes in InstallShield (cont.)

Name InstallShield Edition Dialog Width Dialog Height

Global Theme Premier and Professional 374 266

InstallShield Blue Theme Premier and Professional 374 266

InstallShield Blue Theme Premier and Professional 584 274

(Wide)

InstallShield Silver Theme Premier 374 266

Monitor Theme Premier 374 266

Pastel Wheat Theme Premier 374 266

Theater Theme (Wide) Premier 584 274

Circles Theme (Wide)

InstallShield 2020

Following are sample exterior and interior dialogs with the Circle Theme (Wide).

Figure 4-4: Sample Exterior Dialog with the Circle Theme (Wide)

InstallShield 2020 User Guide ISP-2600-UG00 1009

Chapter 4
Defining the End-User Interface

Figure 4-5: Sample Interior Dialog with the Circle Theme (Wide)

To learn how to add your company or product logo to the exterior dialogs, see Adding a Logo or Other Image to the Exterior
Dialogs.

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

Classic Theme

InstallShield 2020

Following are sample exterior and interior dialogs with the Classic Theme.

1010 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Figure 4-6: Sample Exterior Dialog with the Classic Theme

Figure 4-7: Sample Interior Dialog with the Classic Theme

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

InstallShield 2020 User Guide ISP-2600-UG00 1011

Chapter 4
Defining the End-User Interface

Cooperation Theme (Wide)

InstallShield 2020

Edition • This theme is available in the Premier edition of InstallShield.

Following are sample exterior and interior dialogs with the Cooperation Theme (Wide).

Figure 4-8: Sample Exterior Dialog with the Cooperation Theme (Wide)

Figure 4-9: Sample Interior Dialog with the Cooperation Theme (Wide)

1012 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

Filmstrip Theme (Wide)

InstallShield 2020

Edition • This theme is available in the Premier edition of InstallShield.

Following are sample exterior and interior dialogs with the Filmstrip Theme (Wide).

Figure 4-10: Sample Exterior Dialog with the Filmstrip Theme (Wide)

InstallShield 2020 User Guide ISP-2600-UG00 1013

Chapter 4
Defining the End-User Interface

Figure 4-11: Sample Interior Dialog with the Filmstrip Theme (Wide)

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

Global Theme

InstallShield 2020

Following are sample exterior and interior dialogs with the Global Theme.

Figure 4-12: Sample Exterior Dialog with the Global Theme

1014 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Figure 4-13: Sample Interior Dialog with the Global Theme

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

InstallShield Blue Theme

InstallShield 2020

Following are sample exterior and interior dialogs with the InstallShield Blue Theme.

Figure 4-14: Sample Exterior Dialog with the InstallShield Blue Theme

InstallShield 2020 User Guide ISP-2600-UG00 1015

Chapter 4
Defining the End-User Interface

Figure 4-15: Sample Interior Dialog with the InstallShield Blue Theme

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

InstallShield Blue Theme (Wide)

InstallShield 2020

Following are sample exterior and interior dialogs with the InstallShield Blue Theme (Wide).

Figure 4-16: Sample Exterior Dialog with the InstallShield Blue Theme (Wide)

1016 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Figure 4-17: Sample Interior Dialog with the InstallShield Blue Theme (Wide)

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

InstallShield Silver Theme

InstallShield 2020

Edition • This theme is available in the Premier edition of InstallShield.

Following are sample exterior and interior dialogs with the InstallShield Silver Theme.

InstallShield 2020 User Guide ISP-2600-UG00 1017

Chapter 4
Defining the End-User Interface

Figure 4-18: Sample Exterior Dialog with the InstallShield Silver Theme

Figure 4-19: Sample Interior Dialog with the InstallShield Silver Theme

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

1018 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Monitor Theme

InstallShield 2020

Edition • This theme is available in the Premier edition of InstallShield.

Following are sample exterior and interior dialogs with the Monitor Theme.

Figure 4-20: Sample Exterior Dialog with the Monitor Theme

Figure 4-21: Sample Interior Dialog with the Monitor Theme

InstallShield 2020 User Guide ISP-2600-UG00 1019

Chapter 4
Defining the End-User Interface

To learn how to add your company or product logo to the exterior dialogs, see Adding a Logo or Other Image to the Exterior
Dialogs.

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

Pastel Wheat Theme

InstallShield 2020

Edition • This theme is available in the Premier edition of InstallShield.

Following are sample exterior and interior dialogs with the Pastel Wheat Theme.

Figure 4-22: Sample Exterior Dialog with the Pastel Wheat Theme

1020 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Figure 4-23: Sample Interior Dialog with the Pastel Wheat Theme

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

Theater Theme (Wide)

InstallShield 2020

Edition • This theme is available in the Premier edition of InstallShield.

Following are sample exterior and interior dialogs with the Theater Theme (Wide).

InstallShield 2020 User Guide ISP-2600-UG00 1021

Chapter 4
Defining the End-User Interface

Figure 4-24: Sample Exterior Dialog with the Theater Theme (Wide)

Figure 4-25: Sample Interior Dialog with the Theater Theme (Wide)

To learn how to add your company or product logo to the exterior dialogs, see Adding a Logo or Other Image to the Exterior
Dialogs.

See Also
Available Themes and Corresponding Dialog Sizes
Dialog Themes

1022 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Dialog Support for Right-to-Left Languages

InstallShield 2020

Edition • The Premier edition of InstallShield includes dialog support for languages such as Arabic and Hebrew, which are
read from right to left.

Project • The following project types include dialog support for right-to-left languages:

• Basic MSI
• Merge Module

InstallShield includes support for Arabic (Saudi Arabia) and Hebrew languages, which are written and read from right to
left. All of the default end-user dialog strings are available in these languages.

Since these languages are read from right to left, InstallShield also includes support for mirroring Arabic and Hebrew
dialogs; that is, InstallShield uses a right-to-left layout for Arabic and Hebrew dialogs. Thus, for example, buttons that are
on the right side of dialogs in English and other left-to-right languages are moved to the left side of right-to-left-language
dialogs. This occurs in the Dialog Editor pane in the Dialogs view of InstallShield; it also occurs at run time.

Reversed versions of the dialog images are displayed for the built-in dialog themes if appropriate. The reversed versions
have _mirror in the image file name immediately before the .bmp or .jpg portion of the file name. For example, the name of
an image for left-to-right languages might be banner.jpg; the name of the right-to-left equivalent for that image would be
banner_mirror.jpg. These two files would be located in the same folder, and InstallShield would automatically use the
banner_mirror.jpg file for the right-to-left-language versions of the dialogs. If an image should not be reversed, a
*_mirror.jpg or *_mirror.bmp version of the image is not included, and the right-to-left versions of the dialogs do not show
mirrored versions of the images.

Tip • If you use custom images for your run-time dialogs and your project includes support for right-to-left languages, you
may need to create mirror-image versions for those right-to-left languages. You can preview the right-to-left layout of the
dialogs in the Dialogs view to see how your custom images look. Add *_mirror.jpg or *_mirror.bmp versions of your images to
the folder that contains the left-to-right versions of your custom images if appropriate.

See Also
Creating Multilingual Installations

Launching a File Open Dialog

InstallShield 2020

Project • This information applies to Basic MSI projects.

InstallShield includes support for launching the Open dialog from one of the dialogs in your Basic MSI installation. End
users click a browse button in one of your dialogs, and this launches the Open dialog. The Open dialog lets the end user
browse for a file. When the end user selects the file and clicks the Open button, the Open dialog closes, and the installation
writes the full path and file name in an edit field on the dialog. The installation also sets the value of the
IS_BROWSE_FILEBROWSED property to the path and file name of the file that the end user selected.

InstallShield 2020 User Guide ISP-2600-UG00 1023

Chapter 4
Defining the End-User Interface

When you incorporate support for the Open dialog in your installation, you can define several properties to specify the
following functionality:

• You can specify the default path that is displayed in this dialog.

• You can specify the string that should be displayed in the Files of type drop-down list on the Open dialog.

• You can specify the file extensions of the files that should be displayed when the end user is browsing through folders
to select a file. All files that have other file extensions are hidden and cannot be selected to open.

• You can specify the default file extension that the Open dialog should use. If the end user does not type an extension,
the Open dialog appends this default extension to the file name.

Note the following requirements for this dialog:

• The Open dialog does not allow end users to create a new file. That is, if a file does not exist, an end user cannot
manually type a new file name in the Open dialog.

• If the dialog that launches the Open dialog has more than one edit field control, the edit field control that will contain
the full path to the file must have the lowest value for the Tab Stop property.

Task To add the Open dialog functionality to an end-user dialog:

1. Add to your project a new MSI DLL custom action called FileBrowse:

a. In the View List under Behavior and Logic, click Custom Actions and Sequences.

b. Right-click the Custom Actions explorer, point to New MSI DLL, and then click Stored in Binary table.
InstallShield adds a new custom action called NewCustomActionN, where N is a successive number.

c. Change the name of the custom action to FileBrowse.

d. In the pane on the right, configure the following settings for this custom action:

• DLL Filename: <ISRedistPlatformDependentFolder>\FileBrowse.dll

• Function Name: FileBrowse

• Return Processing: Synchronous (Ignores exit code)

• In-Script Execution: Immediate Execution

• Execution Scheduling: Always execute

For all other settings, leave the default values. The value of the MSI Type Number setting should be 65.

2. Create or edit the dialog that should launch the Open dialog, and configure its behavior and layout:

a. In the View List under User Interface, click Dialogs.

b. In the Dialogs explorer, expand the All Dialogs folder.

c. Either select an existing dialog or create a new dialog.

Note that if you select an existing dialog and it has more than one edit field control, the edit field control that will
contain the full path to the file must have the lowest value for the Tab Stop property.

d. Under this dialog, click the language whose layout you want to configure.

1024 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

e. Add the edit field control that will contain the full path and file name that the end user selects at run time. When
InstallShield prompts you for the property name associated with the control, enter IS_BROWSE_FILEBROWSED.

f. Next to the edit field control, add a push button control. This is the button that will launch the Open dialog.

g. Select the push button control and then edit its properties in the grid on the right as needed. For example, to
specify the text that you want to be displayed on the button, add a value for the Text property.

h. In the Dialogs explorer, click the Behavior item under the dialog that you are configuring.

i. In the center pane that lists the dialog controls, click the push button control that you just created. Its settings are
displayed in the right pane.

j. In the Events setting, click the New Event button, and then click DoAction. InstallShield adds a new set of rows
under the Events setting.

k. In the DoAction setting, enter the following:

l. In the Action subsetting, specify the following action name:

FileBrowse

m. In the Events setting, click the New Event button, and then click SetProperty. InstallShield adds a new set of
rows under the Events setting.

n. In the SetProperty setting, enter the following:

o. In the Property subsetting, specify the following action name:

IS_BROWSE_FILEBROWSED

p. In the Value subsetting, specify the following action name:

[IS_BROWSE_FILEBROWSED]

Note • The SetProperty Event refreshes the MSI property value displayed in the Edit field control on the dialog, so
that the displayed MSI property value is updated after selecting a file in the file browse window.

3. Configure several properties to specify behavior of the Open dialog and the dialog that launches the Open dialog:

a. In the View List under Behavior and Logic, click Property Manager.

b. Find the IS_BROWSE_FILEBROWSED property. Its default value is 0. Do one of the following:

• To leave the edit field control blank in your dialog when the end user first displays it, right-click the row that
has the IS_BROWSE_FILEBROWSED property and then click Delete Property.

• To display a default path and file name in the edit field control, change the value of the
IS_BROWSE_FILEBROWSED property to the path and file name.

Note • If you do not manually change the value of this property or delete this property, the default value for the edit
field control on the dialog that launches the Open dialog is set to 0.

InstallShield 2020 User Guide ISP-2600-UG00 1025

Chapter 4
Defining the End-User Interface

c. Optionally, add a property called IS_BROWSE_FILEEXT, and set its value to a filter string that identifies the file
extensions that should be displayed when the end user is browsing through folders to select a file. All files that
have other file extensions are hidden and cannot be selected to open.

A filter string can be a combination of valid file name characters and the asterisk (*) as a wild-card character.

To specify multiple file extensions, separate each with a semicolon. Do not include spaces. For example, to let
end users select .exe and .dll files, enter the following string as the value of the IS_BROWSE_FILEEXT property:

*.exe;*.dll

In this example, the Open dialog lets end users select .exe and .dll files. It hides all other file types.

If you do not set this property, the Open dialog lets end users select any file type.

d. Optionally, add a property called IS_BROWSE_FILETYPE, and set its value to the string that you want to be
displayed in the Files of type drop-down list on the Open dialog. Note that only one option can be displayed in
this drop-down list.

For example, if you want end users to be able to select .txt or .doc files, enter the following string as the value of
the IS_BROWSE_FILETYPE property:

Text Files (*.txt); Word documents (*.doc)

If you do not set this property, the Files of type drop-down list in the Open dialog is blank.

e. Optionally, add a property called IS_BROWSE_DEFAULTEXTENSION, and set its value to the default file extension
that the Open dialog should use. If the end user does not type an extension, the Open dialog appends this default
extension to the file name. For example, to use .exe as the default file extension, enter the following string as the
value of the IS_BROWSE_DEFAULTEXTENSION property:

exe

f. Optionally, add a property called IS_BROWSE_INITIALDIR, and set its value to the default path that the Open
dialog should use. For example, to use C:\Program Files\My Product, enter the following string as the value of
the IS_BROWSE_INITIALDIR property:

C:\Program Files\My Product

At run time, when the end user clicks the new push button control, the Open dialog opens. The end user can browse to and
select a file. The installation sets the value of the IS_BROWSE_FILEBROWSED property to the path and file name of the file that
the end user selected, and then it displays that path and file name in the edit field control on the dialog that launched the
Open dialog.

Requiring End Users to Scroll Through the EULA in the LicenseAgreement Dialog
InstallShield 2020

Project • This information applies to Basic MSI projects.

InstallShield includes support for disabling the Next button on the LicenseAgreement dialog until the end user reaches the
end of the End-User License Agreement (EULA) text in the scrollable EULA control through one of the following methods:

• Using the scroll bar.

• Pressing PAGE DOWN when the scrollable EULA control has focus.

1026 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• Pressing CTRL+PAGE DOWN when the scrollable EULA control has focus.

• Pressing the DOWN ARROW key when the scrollable EULA control has focus.

• Right-clicking the scroll bar and then clicking Bottom.

The end user must also select the I accept the terms in the license agreement option before the Next button is enabled.

The LicenseAgreement dialog requires end users to select the I accept option by default. If you also want to require end
users to reach the end of the EULA text, perform the following task.

Task To require end users to reach the end of the EULA text in the scrollable EULA control:

1. Add to your project a new MSI DLL custom action called WatchScroll:

a. In the View List under Behavior and Logic, click Custom Actions and Sequences.

b. Right-click the Custom Actions explorer, point to New MSI DLL, and then click Stored in Binary table.
InstallShield adds a new custom action called NewCustomActionN, where N is a successive number.

c. Change the name of the custom action to WatchScroll.

d. In the pane on the right, configure the following settings for this custom action:

• DLL Filename: <ISRedistPlatformDependentFolder>\EulaScrollWatcher.dll

• Function Name: WatchScroll

• Return Processing: Asynchronous (Waits for exit code)

• In-Script Execution: Immediate Execution

• Execution Scheduling: Always execute

For all other settings, leave the default values. The value of the MSI Type Number setting should be 129.

2. Edit the LicenseAgreement dialog so that it launches the appropriate custom action:

a. In the View List under User Interface, click Dialogs.

b. In the Dialogs explorer, expand the All Dialogs folder, and expand the LicenseAgreement item, and then click
Behavior.

c. In the center pane that lists the LicenseAgreement controls, click the ScrollableText control named Memo. This is
the control that contains the text of the EULA. Its settings are displayed in the right pane.

d. In the Events setting, click the New Event button, and then click DoAction. InstallShield adds a new set of rows
under the Events setting.

e. In the DoAction setting, enter the following:

Not LicenseViewed AND Not ISLicenseWatching

f. In the Action subsetting, specify the following action name:

WatchScroll

g. In the center pane that lists the LicenseAgreement controls, click the push button control named Next.

h. In the Conditions setting, click the New Condition button, and then click Disable. InstallShield adds a Disable
setting.

InstallShield 2020 User Guide ISP-2600-UG00 1027

Chapter 4
Defining the End-User Interface

i. In the Disable setting, enter the following:

AgreeToLicense <> "Yes" OR Not LicenseViewed

j. In the Conditions setting, click the New Condition button, and then click Enable. InstallShield adds an Enable
setting.

k. In the Enable setting, enter the following:

AgreeToLicense = "Yes" AND LicenseViewed

At run time, the installation monitors the EULA control in an asynchronous custom action. While the custom action is
running, the ISLicenseWatching property is set. Once the custom action is finished, it removes the ISLicenseWatching
property. This avoids the hourglass flicker otherwise seen when end users scroll through the EULA text. Once the end user
reaches the bottom of the EULA text, the installation sets the LicenseViewed property and manually enables the Next
button if necessary according to the Next button’s conditions. The Next button is found via its text as stored in the Control
table; therefore, you can use the aforementioned procedure with any language transform as long as the control is named
Next.

See Also
License Agreements

Adding a Print Button to a Dialog

InstallShield 2020

In Basic MSI projects that are created in InstallShield X or later, the LicenseAgreement dialog includes a Print button. This
button enables the end user to print the content of the dialog’s ScrollableText control. This button’s event executes the
custom action ISPrint, which is included in a new Basic MSI project. Following are directions for adding a Print button to
another dialog, and to an existing project that was created with InstallShield DevStudio 9.0 or earlier.

Adding a Print Button to Another Dialog

For the custom action ISPrint to work correctly with a dialog other than LicenseAgreement, you must set the value of the
user-defined Windows Installer property IS_PRINT_DIALOG to the name of the dialog. (If IS_PRINT_DIALOG is not an existing
property, ISPrint prints the content of the LicenseAgreement dialog’s ScrollableText control.)

Task To add a Print button to another dialog:

1. Create a button control in the dialog and optionally set its Text property to &Print. For details, see Editing Dialog
Layout in Basic MSI Projects.

2. Add a DoAction event to the Print button, and in the event’s Action subsetting, select ISPrint. For details, see
Triggering Control Events in Basic MSI Dialogs.

3. Modify the value of IS_PRINT_DIALOG from the events of the Back and Next buttons of the dialog and its next and
previous dialogs:

a. Determine which dialog is displayed before the dialog to which you are adding a Print button. You can do this by
either checking the argument of the NewDialog event for the dialog’s Back button, or viewing next dialog order in
the expanded Custom Actions and Sequences view.

b. Add a SetProperty event. In the SetProperty setting, specify the following as the event condition:

1028 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

c. In the Property Name setting, specify the following:

IS_PRINT_DIALOG

d. In the Value setting, specify the name of the dialog to which you are adding a Print button

e. If a Print button is included on any dialog that is displayed after the dialog to which you are adding a Print button,
do the following:

i. Determine which dialog is displayed after the dialog to which you are adding a Print button. You can do this
by either checking the argument of the NewDialog event for the dialog’s Next button, or viewing the next
dialog order in the expanded Custom Actions and Sequences view.

ii. Add a SetProperty event to that next dialog’s Back button, and set its Property Name setting to
IS_PRINT_DIALOG, and its Value setting to the name of the dialog to which you are adding a Print button.

If the next dialog does not have a Print button, or if it is the LicenseAgreement dialog, add a SetProperty event to
the Next button of the dialog to which you are adding a Print button, and set its Property Name setting to
IS_PRINT_DIALOG, and its Value setting to LicenseAgreement.

f. If a Print button is included on any dialog that is displayed before the dialog to which you are adding a Print
button, and the previous dialog does not have a Print button or it is the LicenseAgreement dialog, add a
SetProperty event to the Back button of the dialog to which you are adding a Print button, and set its Property
Name setting to IS_PRINT_DIALOG, and its Value setting to LicenseAgreement.

Adding a Print Button to an Existing Project

Task To add a Print button to an existing project that was created with InstallShield DevStudio 9.0 or earlier:

1. Create the ISPrint custom action:

a. Launch the Custom Action Wizard.

b. In the Basic Information panel’s Name box, enter ISPrint.

c. In the Action Type panel’s Type box, select Call a function in a Windows Installer dynamic-link library.

d. In the Action Parameters panel, click the Browse button and browse to the file SetAllUsers.dll in the
InstallShield folder’s Redist\Language Independent\i386 subfolder. Click Open.

If your project is configured to use path variables, InstallShield uses the predefined path variable
<ISRedistPlatformDependentFolder> for part of the path.

e. In the Action Parameters panel’s Target box, enter PrintScrollableText.

f. Complete the wizard, accepting all remaining default settings.

2. Create a button control in the dialog and optionally set its Text property to &Print. For details, see Editing Dialog
Layout in Basic MSI Projects.

3. Add a DoAction event to the Print button, and in the event’s Action subsetting, select ISPrint. For details, see
Triggering Control Events in Basic MSI Dialogs.

4. Create the Windows Installer property IS_PRINT_DIALOG and set its value to the name of the dialog. For details, see
Creating Properties in Windows Installer–Based Projects.

InstallShield 2020 User Guide ISP-2600-UG00 1029

Chapter 4
Defining the End-User Interface

Note • If the ISPrint custom action is executed by a control event, the custom action’s logging information cannot be recorded
to the installer log in the usual manner (because of a Windows Installer limitation); the information is logged to the values of
properties that have the form ISPrintLogmNoten.

Minimizing Reboots on Windows Vista and Later Systems

InstallShield 2020

Windows Logo • Restarting the system after an installation is inconvenient for end users. One of the Windows logo program
requirements is that all installations must contain an option that enables end users to automatically close applications and
attempt to restart them after the installation is complete.

To support this requirement, all Basic MSI projects include the MsiRMFilesInUse dialog by default. An installation displays
the MsiRMFilesInUse dialog on a Windows Vista or later system if one or more files that need to be updated are currently in
use during the installation. The dialog contains two options to allow end users to specify how to proceed:

• End users can choose to have the installation close the applications that are using those files and then attempt to
restart the applications after the installation is complete.

• End users can avoid closing the applications. A reboot will be required at the end of the installation.

For the best end-user experience, your application should be instrumented to use the Restart Manager API; doing so allows
the Restart Manager to effectively pause and resume your application exactly where the end user left it. For detailed
information, see About Restart Manager and the other Restart Manager documentation on the MSDN Web site.

See Also
Using Windows Installer with Restart Manager (Windows Installer Help Library)
Using Windows Installer with Restart Manager (Windows Installer Help Library)

1030 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Dialog Controls
InstallShield 2020

Whether your dialog is part of a Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, or Merge Module project, you
can use many of the same controls to modify the layout and behavior of your predefined and custom dialogs.

Table 4-7 • Dialog Controls

Control Type Project Type Description

Billboard Basic MSI, Merge A billboard control is used to display data that can be updated in
Module response to control events. You can use a billboard, for example, to
display the progress of a protracted custom action.

Project • If your installation includes a Setup.exe launcher, you can

have the launcher display billboards during the file transfer process;
this is an alternative to the billboard control, which is a Windows
Installer control. This Setup.exe billboard support is available in Basic
MSI, InstallScript, and InstallScript MSI installations. To learn more
about this type of billboard, see Displaying Billboards.

Bitmap Basic MSI, A bitmap control displays an image.

InstallScript,
InstallScript MSI,
InstallScript Object,
Merge Module

Check box Basic MSI, A check box control displays a check box that end user can select or
InstallScript, clear.
InstallScript MSI,
InstallScript Object,
Merge Module

Combo box Basic MSI, A combo box control is a box that contains a drop-down list of
InstallScript, predefined values; the box is also an edit field in which an end user
InstallScript MSI, can enter a value.
InstallScript Object,
Merge Module

Dialog Basic MSI, A dialog control is associated with a series of settings that you
InstallScript, configure.
InstallScript MSI,
InstallScript Object,
Merge Module

Directory combo Basic MSI, Merge A directory combo is used in conjunction with a directory list and a
Module path edit control to create a browse dialog. The directory combo
displays the list of drives mapped on the current system.

InstallShield 2020 User Guide ISP-2600-UG00 1031

Chapter 4
Defining the End-User Interface

Table 4-7 • Dialog Controls (cont.)

Control Type Project Type Description

Directory list Basic MSI, Merge A directory list is used in conjunction with a directory combo and a
Module path edit control to create a browse dialog. The directory list displays
the folders below the drive that is selected in the directory combo
control, and it populates the value of the path edit control.

Edit Field Basic MSI, An edit field control is a text box in which end users can enter a string
InstallScript, or an integer.
InstallScript MSI,
InstallScript Object,
Merge Module

Group box Basic MSI, A group box can be used to enclose various controls in one area. A
InstallScript, group box also provides a label that you can use to express the
InstallScript MSI, relationship between the controls that are contained within it.
InstallScript Object,
Merge Module

Hyperlink Basic MSI, Merge The hyperlink control displays an HTML link; clicking the link at run
Module time opens a page in the default browser on the target system.

Important • Windows Installer 5 and later include support for the

hyperlink control.

Project • To learn how to add an HTML control to a dialog in an

InstallScript project or in an InstallScript MSI project, see Using an HTML
Control on a Dialog.

Icon Basic MSI, The icon control displays a picture of an icon.

InstallScript,
InstallScript MSI,
InstallScript Object,
Merge Module

Line Basic MSI, The line control creates lines of adjustable length and thickness. You
InstallScript, can use lines on a dialog to separate areas of the dialog or add
InstallScript MSI, graphical touches.
InstallScript Object,
Merge Module

1032 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-7 • Dialog Controls (cont.)

Control Type Project Type Description

List box Basic MSI, The list box control is a standard list box that lets end users select a
InstallScript, single option from a list of predetermined options.
InstallScript MSI,
InstallScript Object,
Merge Module

List view Basic MSI, The list view control displays a single column of options; an icon is
InstallScript, displayed next to each option.
InstallScript MSI,
InstallScript Object,
Merge Module

Masked edit Basic MSI, Merge The masked edit control is essentially an edit field control that lets
Module end users enter information in a specified format.

Path edit Basic MSI, Merge A path edit control is used in conjunction with a directory combo
Module control and a directory list control to create a browse dialog. The path
edit displays the complete path that is assembled from selections that
the end user makes in the directory combo and directory list, along
with or instead of edits that the end user makes.

Progress bar Basic MSI, A progress bar is a dynamic, graphical bar that fills up in response to
InstallScript, control events.
InstallScript MSI,
InstallScript Object,
Merge Module

Push button Basic MSI, A push button control is a button that carries out a command when an
InstallScript, end user clicks it.
InstallScript MSI,
InstallScript Object,
Merge Module

Radio button Basic MSI, A radio button control is one of two or more mutually exclusive
InstallScript, options that end users can select. A radio button must be inserted into
InstallScript MSI, a radio button group; it functions as part of that control.
InstallScript Object,
Merge Module

Radio button group Basic MSI, A radio button group control is a container for radio button controls. A
InstallScript, radio button group and its radio buttons behave as a single control.
InstallScript MSI,
InstallScript Object,
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1033

Chapter 4
Defining the End-User Interface

Table 4-7 • Dialog Controls (cont.)

Control Type Project Type Description

Scrollable text Basic MSI, Merge A scrollable text control displays a long string of text that cannot fit on
Module the dialog; the control includes scroll bars that enable end users to
scroll through the text. The LicenseAgreement dialog is an example of
a dialog that typically contains a scrollable text control.

Selection tree Basic MSI, A selection tree is a special control that lets end users change the
InstallScript, selection state of your features, like in the CustomSetup dialog.
InstallScript MSI,
InstallScript Object,
Merge Module

Text area Basic MSI, A text area control displays text.

InstallScript,
InstallScript MSI,
InstallScript Object,
Merge Module

Volume cost list Basic MSI, Merge A volume cost list control displays the disk space requirements that
Module are associated with each volume or drive.

Volume select combo Basic MSI, Merge A volume select combo control enables the end user to select from an
Module alphabetical list of volumes, or drives.

Billboard Control
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• Merge Module

If your installation includes a Setup.exe launcher, you can have the launcher display billboards during the file transfer
process; this is an alternative to the billboard control, which is a Windows Installer control. This Setup.exe billboard support is
available in Basic MSI, InstallScript, and InstallScript MSI installations. To learn more about this type of billboard, see
Displaying Billboards.

A billboard control is used to display data that can be updated in response to control events. Billboards can contain other
controls for displaying this information, but they must be static controls—including text, bitmaps, and icons—that are not
linked to a Windows Installer property. You can use a billboard, for example, to display the progress of a protracted custom
action.

Billboards are not fully supported in the Dialog Editor. In order to have the billboard interact with Windows Installer actions
and display other controls, you must make changes to the Billboard and BBControl tables in your project; you can use
the Direct Editor view to modify these tables.

1034 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

When you select a billboard control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Table 4-8 • Settings for a Billboard Control

Setting Description

Name Enter a name for this billboard. The name must be unique among all of the
controls in your project.

Base Text Style This font style is used for the control’s label if you specify nothing for the Text
Style setting.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True.
Clicking the cancel control has the same effect as pressing the ESC key or clicking
the Close button on the title bar. The Cancel or Finish button is usually the cancel
control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog
that contains this control.

Context Help This setting is reserved for future use. Windows Installer does not currently
support launching context-sensitive help topics from the installation.

Default If this is the only control on the dialog that you want to be the default control,
which means that it is activated when the end user presses the ENTER key, select
True. The Next or OK button is usually the default control.

Height Specify the height of the control in Windows Installer user interface units (1/12 of
the height of the system font).

Left Specify the distance from the left edge of the dialog to the start of the control in
installer units (1/12 of the height of the system font).

Sunken To give the control’s edges a recessed, three-dimensional appearance, select

True. To use the default visual style for the control, select False.

Tab Index Assign an integer that—along with the other controls on this dialog but excluding
controls such as static text—specifies the order in which each control on the
dialog receives focus when the end user presses the TAB key. The lowest tab index
that you can use is the number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates
that the control receives focus; False indicates that the control does not receive
focus.

InstallShield 2020 User Guide ISP-2600-UG00 1035

Chapter 4
Defining the End-User Interface

Table 4-8 • Settings for a Billboard Control (cont.)

Setting Description

Text This setting contains the text that is used for the initial value of the billboard’s
control (see the BBControl table).

When you type a value for this setting, you are creating a string entry and setting
its initial value for all of the languages that are currently in the project. As an
alternative to typing a new value, you can click the ellipsis button (...) in this
setting to select an existing string. For more information, see Using String Entries
in InstallShield.

If the billboard’s control contains a bitmap or icon, this value must be a foreign
key into the Binary table to the file that is initially displayed on the control.

Text Style Select the font style, size, and color (if available) in which you want the billboard’s
label to be displayed. Leaving the value as <Default> displays the font that is
contained in the DefaultUIFont property.

Tooltip Enter the text that you want to be displayed when the end user places the mouse
pointer over the control.

When you type a value for this setting, you are creating a string entry and setting
its initial value for all of the languages that are currently in the project. As an
alternative to typing a new value, you can click the ellipsis button (...) in this
setting to select an existing string. For more information, see Using String Entries
in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer
units (1/12 of the height of the system font).

Visible True means that the control is visible, and False means that it is hidden. You can
also make the control visible by editing its condition in the Behavior area for the
dialog.

Width Specify the width of the control in Windows Installer user interface units (1/12 of
the height of the system font).

See Also
Billboard Table (Windows Installer Help Library)
Billboard Table (Windows Installer Help Library)
BBControl Table (Windows Installer Help Library)
BBControl Table (Windows Installer Help Library)
Dialog Controls

1036 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Bitmap Control
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

A bitmap control displays an image.

When you select a bitmap control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Table 4-9 • Settings for a Bitmap Control

Setting Project Type Description

Name Basic MSI, Enter a name for this bitmap. The name must be unique among all of the
InstallScript, controls in your project.
InstallScript MSI,
InstallScript Object,
Merge Module

Cancel Basic MSI, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript MSI, key or clicking the Close button on the title bar. The Cancel or Finish button
InstallScript Object, is usually the cancel control.
Merge Module
This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not currently
Module support launching context-sensitive help topics from the installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in Visual
InstallScript Object, C++. You should not change the control identifiers for any of the controls
Merge Module that are included with a dialog by default.

Default Basic MSI, Select True if this is the only control on the dialog that you want to be the
InstallScript, default control, which means that it will be activated when the end user
InstallScript MSI, presses the ENTER key. The Next or OK button is usually the default control.
InstallScript Object,
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1037

Chapter 4
Defining the End-User Interface

Table 4-9 • Settings for a Bitmap Control (cont.)

Setting Project Type Description

File Name Basic MSI, Enter the path to and the name of the image file that you want to use for
InstallScript, this control, or click the ellipsis button (...) in this setting to browse to it.
InstallScript MSI, InstallShield adds the file to your release at build time. The file must be
InstallScript Object, stored as a binary resource in the installation.
Merge Module

Height Basic MSI, For Basic MSI and Merge Module projects: Specify the height of the control
InstallScript, in Windows Installer user interface units (1/12 of the height of the system
InstallScript MSI, font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify
Merge Module
the height of the control in dialog units.

Left Basic MSI, Specify the distance from the left edge of the dialog to the start of the
InstallScript, control in installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog box.
Styles InstallScript MSI,
InstallScript Object,
Merge Module

Stretch to Fit Basic MSI, Merge If you want the image to be resized to fill the area of the control, select True.
Module
To have the image centered if it is smaller than the control or to have the
image cropped if it is bigger than the control, select False.

Sunken Basic MSI, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript, select True. To use the default visual style for the control, select False.
InstallScript MSI,
InstallScript Object,
Merge Module

Tab Index Basic MSI, Assign an integer that—along with the other controls on this dialog but
InstallScript, excluding controls such as static text—specifies the order in which each
InstallScript MSI, control on the dialog receives focus when the end user presses the TAB key.
InstallScript Object, The lowest tab index that you can use is the number 0.
Merge Module

Tab Stop Basic MSI, Indicate whether this control receives focus within the tab order. True
InstallScript, indicates that the control receives focus; False indicates that the control
InstallScript MSI, does not receive focus.
InstallScript Object,
Merge Module

1038 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-9 • Settings for a Bitmap Control (cont.)

Setting Project Type Description

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more information,
see Using String Entries in InstallShield.

Top Basic MSI, Specify the distance from the top of the dialog to the top of the control in
InstallScript, installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Visible Basic MSI, True means that the control is visible, and False means that it is hidden. You
InstallScript, can also make the control visible by editing its condition in the Behavior
InstallScript MSI, area for the dialog.
InstallScript Object,
Merge Module

Width Basic MSI, For Basic MSI and Merge Module projects: Specify the width of the control in
InstallScript, Windows Installer user interface units (1/12 of the height of the system
InstallScript MSI, font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify
Merge Module
the width of the control in dialog units.

See Also
Dialog Controls

Check Box Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

A check box control displays a check box that end user can select or clear.

InstallShield 2020 User Guide ISP-2600-UG00 1039

Chapter 4
Defining the End-User Interface

When you select a check box control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Project • (For Basic MSI and Merge Module projects) When you first draw this type of control on a dialog, InstallShield prompts
you for the name of a Windows Installer property. InstallShield uses the name that you enter as the value for this control’s
Property setting. At run time, the installation sets the value of this property based on the end user’s selection. For more details,
see Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties.

Table 4-10 • Settings for a Check Box Control

Setting Project Type Description

Name Basic MSI, InstallScript, Enter a name for this check box. The name must be unique among all of the
InstallScript MSI, controls in your project.
InstallScript Object,
Merge Module

Base Text Basic MSI, Merge This font style is used for the control’s label if you specify nothing for the
Style Module Text Style setting.

This setting is enabled if Text is selected for the Control Style setting.

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript Object, key or clicking the Close button on the title bar. The Cancel or Finish button
Merge Module is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not currently
Module support launching context-sensitive help topics from the installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in Visual
InstallScript Object C++. You should not change the control identifiers for any of the controls
that are included with a dialog by default.

Control Style Basic MSI, Merge Specify whether this control is marked with a text label, an icon, or a
Module bitmap.

Default Basic MSI, InstallScript, If this is the only control on the dialog that you want to be the default
InstallScript MSI, control, which means that it is activated when the end user presses the
InstallScript Object, ENTER key, select True. The Next or OK button is usually the default
Merge Module control.

Enabled Basic MSI, InstallScript, Indicate whether the control is enabled. True means that this control is
InstallScript MSI, available (the end user can interact with it). False means that it is not
InstallScript Object, available (grayed out).
Merge Module

1040 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-10 • Settings for a Check Box Control (cont.)

Setting Project Type Description

File Name Basic MSI, Merge This setting is enabled if you select Bitmap or Icon for the Control Style
Module setting.

Enter the path to and the name of the image file that you want to use for
this control, or click the ellipsis button (...) in this setting to browse to it.
InstallShield adds the file to your release at build time. The file must be
stored as a binary resource in the installation.

This setting is enabled if Bitmap or Icon are selected for the Control Style
setting.

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify
the height of the control in dialog units.).

Icon Size Basic MSI, Merge Assuming that your icon file has more than one resource, specify the size of
Module the image that you want to use for the control. The Use first image option
causes the first image in the file to be displayed and makes it stretch to fit
the size of the control, regardless of what you specify for the Stretch to Fit
setting.

This setting is enabled if Bitmap or Icon are selected for the Control Style
setting.

Indirect Basic MSI, InstallScript, If the property that is associated with this control is referenced indirectly,
Property InstallScript MSI, select True; otherwise, select False.
InstallScript Object,
When True is selected for an indirect property is set to True, Windows
Merge Module
Installer resolves the referenced property at run time. For example, this
check box might use the property _BROWSE, whose value is INSTALLDIR. If
you select True for the Indirect Property setting, the value of _BROWSE will
be the current value of the INSTALLDIR property. If you select False for the
Indirect Property setting, the value of _BROWSE will contain the string
INSTALLDIR.

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog box.
Styles InstallScript MSI,
InstallScript Object

InstallShield 2020 User Guide ISP-2600-UG00 1041

Chapter 4
Defining the End-User Interface

Table 4-10 • Settings for a Check Box Control (cont.)

Setting Project Type Description

Property Basic MSI, Merge Enter the name of a property that is set when an end user selects this check
Module box. This property can be unique to this control; it does not need to be
present in the Property Manager view.

To set a default value for this control, make sure the property is a public
property by giving it a name that contains only uppercase letters, use the
Property Manager view to add the public property, and then assign to it the
Value setting.

Property Is Basic MSI, InstallScript, If the property for this control (specified in the Property setting) has an
Integer InstallScript MSI, integer value, select True. If the property’s value is a string, select False.
InstallScript Object,
Merge Module

Push Button Basic MSI, InstallScript, To turn this check box into a push button control, select True; otherwise,
InstallScript MSI, select False.
InstallScript Object,
Merge Module

Right-Aligned Basic MSI, InstallScript, The default value of False aligns the text to the left of the control. Set it to
InstallScript MSI, True to align the text to the right.
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, InstallScript, For English and other languages that are written from left to right, select
InstallScript MSI, False. For Hebrew and those languages that are read from right to left,
InstallScript Object, select True.
Merge Module

Stretch to Fit Basic MSI, Merge If you want the image to be resized to fill the area of the control, select
Module True.

To have the image centered if it is smaller than the control or to have the
image cropped if it is bigger than the control, select False.

This setting is enabled if Bitmap or Icon are selected for the Control Style
setting.

Sunken Basic MSI, InstallScript, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript MSI, select True. To use the default visual style for the control, select False.
InstallScript Object,
Merge Module

1042 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-10 • Settings for a Check Box Control (cont.)

Setting Project Type Description

Tab Index Basic MSI, InstallScript, Assign an integer that—along with the other controls on this dialog but
InstallScript MSI, excluding controls such as static text—specifies the order in which each
InstallScript Object, control on the dialog receives focus when the end user presses the TAB key.
Merge Module The lowest tab index that you can use is the number 0.

Tab Stop Basic MSI, InstallScript, Indicate whether this control receives focus within the tab order. True
InstallScript MSI, indicates that the control receives focus; False indicates that the control
InstallScript Object, does not receive focus.
Merge Module

Text Basic MSI, InstallScript, This setting contains the text that is used for the control’s label.
InstallScript MSI,
When you type a value for this setting, you are creating a string entry and
InstallScript Object,
setting its initial value for all of the languages that are currently in the
Merge Module
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more information,
see Using String Entries in InstallShield.

This setting is enabled if Text is selected for the Control Style setting.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays the
font that is contained in the DefaultUIFont property.

This setting is enabled if Text is selected for the Control Style setting.

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more information,
see Using String Entries in InstallShield.

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control in
InstallScript MSI, installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Value Basic MSI, Merge When the check box is selected, the property that is specified for the
Module Property setting is set to this value.

Visible Basic MSI, InstallScript, True means that the control is visible, and False means that it is hidden.
InstallScript MSI, You can also make the control visible by editing its condition in the
InstallScript Object, Behavior area for the dialog.
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1043

Chapter 4
Defining the End-User Interface

Table 4-10 • Settings for a Check Box Control (cont.)

Setting Project Type Description

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify
the width of the control in dialog units.

See Also
Dialog Controls

Combo Box Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

A combo box control is a box that contains a drop-down list of predefined values; the box is also an edit field in which an
end user can enter a value.

When you select a combo box control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Project • (For Basic MSI and Merge Module projects) When you first draw this type of control on a dialog, InstallShield prompts
you for the name of a Windows Installer property that identifies all of the items that belong to this combo box. InstallShield
uses the name that you enter as the value for this control’s Property setting. At run time, the installation sets the value of this
property based on the end user’s selection. For more details, see Working with Windows Installer and Advanced UI or Suite/
Advanced UI Properties. (Note that Windows Installer combo boxes allow the end user to select only a single item.)

Table 4-11 • Settings for a Combo Box Control

Setting Project Type Description

Name Basic MSI, InstallScript, Enter a name for this combo box. The name must be unique among all of
InstallScript MSI, the controls in your project.
InstallScript Object,
Merge Module

1044 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-11 • Settings for a Combo Box Control (cont.)

Setting Project Type Description

Base Text Style Basic MSI, Merge Module This font style is used for the control’s label if you specify nothing for the
Text Style setting.

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript Object, key or clicking the Close button on the title bar. The Cancel or Finish
Merge Module button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Code Page Basic MSI, Merge Module If you want the control to use fonts from the code page that is defined in
the installation’s package, select Database. If you want the control to use
fonts from the target system’s default code page, select User’s System.

Context Help Basic MSI, Merge Module This setting is reserved for future use. Windows Installer does not
currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Default Basic MSI, InstallScript, If this is the only control on the dialog that you want to be the default
InstallScript MSI, control, which means that it is activated when the end user presses the
InstallScript Object, ENTER key, select True. The Next or OK button is usually the default
Merge Module control.

Drop-Down List Basic MSI, InstallScript, If you want the control to be a drop-down list, select True. If you want the
InstallScript MSI, control to be an editable combo box, select False.
InstallScript Object,
Merge Module

Enabled Basic MSI, InstallScript, Indicate whether the control is enabled. True means that this control is
InstallScript MSI, available (the end user can interact with it). False means that it is not
InstallScript Object, available (grayed out).
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1045

Chapter 4
Defining the End-User Interface

Table 4-11 • Settings for a Combo Box Control (cont.)

Setting Project Type Description

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of the
InstallScript Object, system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the height of the control in dialog units.

Tip • Be sure to set the Height setting to a large-enough number; this

setting specifies the height of the drop-down list portion of the combo box
control.

Indirect Basic MSI, InstallScript, If the property that is associated with this control is referenced
Property InstallScript MSI, indirectly, select True; otherwise, select False.
InstallScript Object,
When True is selected for an indirect property is set to True, Windows
Merge Module
Installer resolves the referenced property at run time. For example, this
check box might use the property _BROWSE, whose value is INSTALLDIR. If
you select True for the Indirect Property setting, the value of _BROWSE will
be the current value of the INSTALLDIR property. If you select False for
the Indirect Property setting, the value of _BROWSE will contain the
string INSTALLDIR.

Items Basic MSI, InstallScript, To specify the options that you want to be listed in this control, click the
InstallScript MSI, ellipsis button (...) in this setting; this opens the List Items dialog box.
InstallScript Object,
To add a new item to the list, click the Add button on the List Items dialog
Merge Module
box. For each item, you must enter the text that is displayed in the
combo box, and a value, which is the value that is assigned to the
property if this item is selected.

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Left Scrollbar Basic MSI, InstallScript, If you want the arrow and vertical scrollbar to be displayed on the left
InstallScript MSI, side of the control, select True. This option should be selected only when
InstallScript Object, True is selected for the Right-to-Left setting.
Merge Module

Max. Length Basic MSI, Merge Module Specify how many characters the end user can enter in the combo box.

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

1046 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-11 • Settings for a Combo Box Control (cont.)

Setting Project Type Description

Property Basic MSI, Merge Module Enter the name of a property that is set when the end user enters a value
into or selects one from this combo box. This property can be unique to
this control; it does not need to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public
property by giving it a name that contains only uppercase letters, use the
Property Manager view to add the public property, and then assign to it
the value of the default selection (specified in the Items setting).

Property Is Basic MSI, InstallScript, If the property for this control (specified in the Property setting) has an
Integer InstallScript MSI, integer value, select True. If the property’s value is a string, select False.
InstallScript Object,
Make sure that all of the values in the Item setting are either integers or
Merge Module
strings, depending on the value that you select in the Property Is Integer
setting.

Right-Aligned Basic MSI, InstallScript, The default value of False aligns the text to the left of the control. Set it to
InstallScript MSI, True to align the text to the right.
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, InstallScript, For English and other languages that are written from left to right, select
InstallScript MSI, False. For Hebrew and those languages that are read from right to left,
InstallScript Object, select True.
Merge Module

Sorted Basic MSI, InstallScript, Selecting True causes the items in the combo box to be sorted
InstallScript MSI, alphabetically. A value of False makes them retain the order that you set
InstallScript Object, for each item in the List Items dialog box.
Merge Module

Sunken Basic MSI, InstallScript, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript MSI, select True. To use the default visual style for the control, select False.
InstallScript Object,
Merge Module

Tab Index Basic MSI, InstallScript, Assign an integer that—along with the other controls on this dialog but
InstallScript MSI, excluding controls such as static text—specifies the order in which each
InstallScript Object, control on the dialog receives focus when the end user presses the TAB
Merge Module key. The lowest tab index that you can use is the number 0.

Tab Stop Basic MSI, InstallScript, Indicate whether this control receives focus within the tab order. True
InstallScript MSI, indicates that the control receives focus; False indicates that the control
InstallScript Object, does not receive focus.
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1047

Chapter 4
Defining the End-User Interface

Table 4-11 • Settings for a Combo Box Control (cont.)

Setting Project Type Description

Text Style Basic MSI, Merge Module Select the font style, size, and color (if available) in which you want the
control’s label to be displayed. Leaving the value as <Default> displays
the font that is contained in the DefaultUIFont property.

Tooltip Basic MSI, Merge Module Enter the text that you want to be displayed when the end user places
the mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control in
InstallScript MSI, installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Visible Basic MSI, InstallScript, True means that the control is visible, and False means that it is hidden.
InstallScript MSI, You can also make the control visible by editing its condition in the
InstallScript Object, Behavior area for the dialog.
Merge Module

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of the
InstallScript Object, system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the width of the control in dialog units.

See Also
Dialog Controls

Dialog Control
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

1048 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

When you select a dialog in the Dialog Editor of the Dialogs view, InstallShield displays the following settings in the right
pane.

Unlike its controls, you cannot change the name of a dialog in the Dialog Editor. To change the name, right-click the dialog
in the Dialogs view and click Rename.

Table 4-12 • Settings for a Dialog Control

Setting Project Type Description

Caption Basic MSI, Merge Module Specify the name that you want to use as the title for the dialog.

When you type a value for this setting, you are creating a string entry
and setting its initial value for all of the languages that are currently in
the project. As an alternative to typing a new value, you can click the
ellipsis button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Comment Basic MSI, Merge Module Enter comments for the dialog. Your comments are saved in the project
file for your reference and are not used in the installation at any time.

Custom Palette Basic MSI, Merge Module A custom palette is necessary only if the dialog contains images that use
a color palette that is different from the default one that is created by
Windows Installer. If the dialog does not contain any images that use a
different color palette, leave this value as False.

Error Dialog Basic MSI, Merge Module If this dialog serves as an error dialog, select True.

Height Basic MSI, InstallScript, Specify the height of the dialog in installer units (1/12 of the height of
InstallScript MSI, the system font).
InstallScript Object,
Merge Module

Keep Modeless Basic MSI, Merge Module When this value is set to True and this dialog is spawned through a
DoAction event, all other dialogs remain. If the Keep Modeless setting is
False in this case, the other dialogs are not displayed.

Left Basic MSI, InstallScript, Specify the percentage from the left edge of the screen where you want
InstallScript MSI, the dialog to be placed. A value of 50 centers the dialog horizontally.
InstallScript Object,
This value is ignored if this dialog is part of an installation wizard, and
Merge Module
the previous dialog was in a different location or was moved by the end
user.

Left Scrollbar Basic MSI, InstallScript, Select True to set the scroll bar, if present, at the left side of the dialog.
InstallScript MSI, The default value, False, keeps it at the right side.
InstallScript Object,
If you want the vertical scrollbar, if present, to be displayed on the left
Merge Module
side of the dialog, select True. The default value, False, keeps the
scrollbar on the right side.

InstallShield 2020 User Guide ISP-2600-UG00 1049

Chapter 4
Defining the End-User Interface

Table 4-12 • Settings for a Dialog Control (cont.)

Setting Project Type Description

Minimize Basic MSI, InstallScript, True means that the end user can minimize this dialog. False means that
InstallScript MSI, the option is not present on the title bar.
InstallScript Object,
Merge Module

Modal Basic MSI, InstallScript, Select True if this dialog is part of the installation wizard and no other
InstallScript MSI, dialogs should be placed on top of it.
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

Resource InstallScript, This read-only setting shows the dialog’s resource ID—the unique
Identifier InstallScript MSI, numeric identifier for the dialog.
InstallScript Object

Right-Aligned Basic MSI, InstallScript, The default value of False aligns the caption to the left of the control. Set
InstallScript MSI, it to True to align the caption to the right.
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, InstallScript, For English and other languages that are written from left to right, select
InstallScript MSI, False. For Hebrew and those languages that are read from right to left,
InstallScript Object, select True.
Merge Module

Text Style InstallScript, Select a font to be used for the dialog.

InstallScript MSI

Top Basic MSI, InstallScript, Specify the percentage from the top of the screen where you want the
InstallScript MSI, dialog to be placed. A value of 50 centers the dialog vertically.
InstallScript Object,
This value is ignored if this dialog is part of an installation wizard, and
Merge Module
the previous dialog was in a different location or was moved by the end
user.

Track Disk Space Basic MSI, Merge Module Select True if this dialog has a control that alerts the end user that a
drive is out of space or that checks the value of the OutOfDiskSpace
property before performing some action.

Visible Basic MSI, InstallScript, True means that the dialog is visible, and False means that it is hidden.
InstallScript MSI,
InstallScript Object,
Merge Module

1050 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-12 • Settings for a Dialog Control (cont.)

Setting Project Type Description

Width Basic MSI, InstallScript, Specify the width of the dialog in installer units (1/12 of the height of the
InstallScript MSI, system font).
InstallScript Object,
Merge Module

See Also
Dialog Controls

Directory Combo Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• Merge Module

A directory combo is used in conjunction with a directory list and a path edit control to create a browse dialog. The
directory combo displays the list of drives mapped on the current system.

When you first draw a directory combo on a dialog, InstallShield prompts you for the name of a Windows Installer property.
This property should be the same for the accompanying directory list and path edit. At run time, the installation sets the
value of this property based on the end user’s selection. For more details, see Working with Windows Installer and
Advanced UI or Suite/Advanced UI Properties.

When you select a directory combo control in a dialog of the Dialogs view, InstallShield displays the following settings in
the right pane.

Table 4-13 • Settings for a Directory Combo Control

Setting Description

Name Enter a name for this directory combo. The name must be unique among all of the
controls in your project.

Base Text Style This font style is used for the control’s text if you specify nothing for the Text Style setting.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True. Clicking the
cancel control has the same effect as pressing the ESC key or clicking the Close button on
the title bar. The Cancel or Finish button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog that
contains this control.

Context Help This setting is reserved for future use. Windows Installer does not currently support
launching context-sensitive help topics from the installation.

InstallShield 2020 User Guide ISP-2600-UG00 1051

Chapter 4
Defining the End-User Interface

Table 4-13 • Settings for a Directory Combo Control (cont.)

Setting Description

Default If this is the only control on the dialog that you want to be the default control, which
means that it is activated when the end user presses the ENTER key, select True. The Next
or OK button is usually the default control.

Enabled Indicate whether the control is enabled. True means that this control is available (the end
user can interact with it). False means that it is not available (grayed out).

Height Specify the height of the control in Windows Installer user interface units (1/12 of the
height of the system font).

Indirect Property If the property that is associated with this control is referenced indirectly, select True;
otherwise, select False.

When True is selected for an indirect property is set to True, Windows Installer resolves
the referenced property at run time. For example, this check box might use the property
_BROWSE, whose value is INSTALLDIR. If you select True for the Indirect Property setting,
the value of _BROWSE will be the current value of the INSTALLDIR property. If you select
False for the Indirect Property setting, the value of _BROWSE will contain the string
INSTALLDIR.

Left Specify the distance from the left edge of the dialog to the start of the control in installer
units (1/12 of the height of the system font).

Left Scrollbar If you want the arrow and vertical scrollbar to be displayed on the left side of the control,
select True. This option should be selected only when True is selected for the Right-to-
Left setting.

Property Enter the name of a property that is set when an end user end user selects a value from
this directory combo. This control populates the first part of the path that is displayed in
the directory list, so you must use the same property for the directory combo, the
directory list, and path edit when using them together on a browse dialog. This property
can be unique to this control; it does not need to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public property by
giving it a name that contains only uppercase letters, use the Property Manager view to
add the public property, and then assign to it the value of the default selection.

Right-Aligned The default value of False aligns the text to the left of the control. Set it to True to align the
text to the right.

Right-to-Left For English and other languages that are written from left to right, select False. For
Hebrew and those languages that are read from right to left, select True.

Show CD-ROM To include CD-ROM volumes in the directory combo, select True.

Show Fixed To include hard drives in the directory combo, select True.

1052 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-13 • Settings for a Directory Combo Control (cont.)

Setting Description

Show Floppy To include floppy drives in the directory combo, select True.

Show RAMDisk To include RAM volumes in the directory combo, select True.

Show Remote To include mapped network drives in the directory combo, select True.

Show Removable To include removable drives in the directory combo, select True.

Sunken To give the control’s edges a recessed, three-dimensional appearance, select True. To use
the default visual style for the control, select False.

Tab Index Assign an integer that—along with the other controls on this dialog but excluding controls
such as static text—specifies the order in which each control on the dialog receives focus
when the end user presses the TAB key. The lowest tab index that you can use is the
number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates that the
control receives focus; False indicates that the control does not receive focus.

Text This setting contains the text that is used for the control’s text.

When you type a value for this setting, you are creating a string entry and setting its initial
value for all of the languages that are currently in the project. As an alternative to typing a
new value, you can click the ellipsis button (...) in this setting to select an existing string.
For more information, see Using String Entries in InstallShield.

Text Style Select the font style, size, and color (if available) in which you want the control’s label to
be displayed. Leaving the value as <Default> displays the font that is contained in the
DefaultUIFont property.

Tooltip Enter the text that you want to be displayed when the end user places the mouse pointer
over the control.

When you type a value for this setting, you are creating a string entry and setting its initial
value for all of the languages that are currently in the project. As an alternative to typing a
new value, you can click the ellipsis button (...) in this setting to select an existing string.
For more information, see Using String Entries in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer units
(1/12 of the height of the system font).

Visible True means that the control is visible, and False means that it is hidden. You can also
make the control visible by editing its condition in the Behavior area for the dialog.

Width Specify the width of the control in Windows Installer user interface units (1/12 of the
height of the system font).

InstallShield 2020 User Guide ISP-2600-UG00 1053

Chapter 4
Defining the End-User Interface

See Also
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
Dialog Controls

Directory List Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• Merge Module

A directory list is used in conjunction with a directory combo and a path edit control to create a browse dialog. The
directory list displays the folders below the drive that is selected in the directory combo control, and it populates the value
of the path edit control.

When you first draw a directory list on a dialog, InstallShield prompts you for the name of a Windows Installer property.
This property should be the same for the accompanying directory combo and path edit. At run time, the installation sets
the value of this property based on the end user’s selection. For more details, see Working with Windows Installer and
Advanced UI or Suite/Advanced UI Properties.

When you select a directory list control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Table 4-14 • Settings for a Directory List Control

Setting Description

Name Enter a name for this directory list. The name must be unique among all of the controls in
your project.

Base Text Style This font style is used for the control’s label if you specify nothing for the Text Style setting.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True. Clicking the
cancel control has the same effect as pressing the ESC key or clicking the Close button on
the title bar. The Cancel or Finish button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog that
contains this control.

Context Help This setting is reserved for future use. Windows Installer does not currently support
launching context-sensitive help topics from the installation.

Default If this is the only control on the dialog that you want to be the default control, which
means that it is activated when the end user presses the ENTER key, select True. The Next
or OK button is usually the default control.

Enabled Indicate whether the control is enabled. True means that this control is available (the end
user can interact with it). False means that it is not available (grayed out).

1054 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-14 • Settings for a Directory List Control (cont.)

Setting Description

Height Specify the height of the control in Windows Installer user interface units (1/12 of the
height of the system font).

Indirect Property If the property that is associated with this control is referenced indirectly, select True;
otherwise, select False.

When True is selected for an indirect property is set to True, Windows Installer resolves the
referenced property at run time. For example, this check box might use the property
_BROWSE, whose value is INSTALLDIR. If you select True for the Indirect Property setting,
the value of _BROWSE will be the current value of the INSTALLDIR property. If you select
False for the Indirect Property setting, the value of _BROWSE will contain the string
INSTALLDIR.

Left Specify the distance from the left edge of the dialog to the start of the control in installer
units (1/12 of the height of the system font).

Left Scrollbar If you want the arrow and vertical scrollbar to be displayed on the left side of the control,
select True. This option should be selected only when True is selected for the Right-to-Left
setting.

Property Enter the name of a property that is set when an end user selects a value from this
directory list. This control populates the path that is displayed in the path edit and
changes depending on the selection in the directory combo, so you must use the same
property for all three controls when using them together on a browse dialog. This property
can be unique to this control; it does not need to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public property by giving
it a name that contains only uppercase letters, use the Property Manager view to add the
public property, and then assign to it the value of the default selection.

Right-Aligned The default value of False aligns the text to the left of the control. Set it to True to align the
text to the right.

Right-to-Left For English and other languages that are written from left to right, select False. For Hebrew
and those languages that are read from right to left, select True.

Sunken To give the control’s edges a recessed, three-dimensional appearance, select True. To use
the default visual style for the control, select False.

Tab Index Assign an integer that—along with the other controls on this dialog but excluding controls
such as static text—specifies the order in which each control on the dialog receives focus
when the end user presses the TAB key. The lowest tab index that you can use is the
number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates that the
control receives focus; False indicates that the control does not receive focus.

InstallShield 2020 User Guide ISP-2600-UG00 1055

Chapter 4
Defining the End-User Interface

Table 4-14 • Settings for a Directory List Control (cont.)

Setting Description

Text This setting contains the text that is used for the control’s text.

When you type a value for this setting, you are creating a string entry and setting its initial
value for all of the languages that are currently in the project. As an alternative to typing a
new value, you can click the ellipsis button (...) in this setting to select an existing string.
For more information, see Using String Entries in InstallShield.

Text Style Select the font style, size, and color (if available) in which you want the control’s label to be
displayed. Leaving the value as <Default> displays the font that is contained in the
DefaultUIFont property.

Tooltip Enter the text that you want to be displayed when the end user places the mouse pointer
over the control.

When you type a value for this setting, you are creating a string entry and setting its initial
value for all of the languages that are currently in the project. As an alternative to typing a
new value, you can click the ellipsis button (...) in this setting to select an existing string.
For more information, see Using String Entries in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer units (1/
12 of the height of the system font).

Visible True means that the control is visible, and False means that it is hidden. You can also make
the control visible by editing its condition in the Behavior area for the dialog.

Width Specify the width of the control in Windows Installer user interface units (1/12 of the height
of the system font).

See Also
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
Dialog Controls

Edit Field Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

An edit field control is a text box in which end users can enter a string or an integer.

1056 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

When you select an edit field control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Project • (For Basic MSI and Merge Module projects) When you first draw this type of control on a dialog, InstallShield prompts
you for the name of a Windows Installer property. InstallShield uses the name that you enter as the value for this control’s
Property setting. At run time, the installation sets the value of this property based on the end user’s selection. For more details,
see Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties.

Table 4-15 • Settings for an Edit Field Control

Setting Project Type Description

Name Basic MSI, Enter a name for this edit field. The name must be unique among all of
InstallScript, the controls in your project.
InstallScript MSI,
InstallScript Object,
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the control’s label if you specify nothing for the
Module Text Style setting.

Cancel Basic MSI, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript MSI, key or clicking the Close button on the title bar. The Cancel or Finish
InstallScript Object, button is usually the cancel control.
Merge Module
This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not
Module currently support launching context-sensitive help topics from the
installation.

Control Identifier InstallScript, This setting contains a numeric identifier for the control that is unique
InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Default Basic MSI, If this is the only control on the dialog that you want to be the default
InstallScript, control, which means that it is activated when the end user presses the
InstallScript MSI, ENTER key, select True. The Next or OK button is usually the default
InstallScript Object, control.
Merge Module

Enabled Basic MSI, Indicate whether the control is enabled. True means that this control is
InstallScript, available (the end user can interact with it). False means that it is not
InstallScript MSI, available (grayed out).
InstallScript Object,
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1057

Chapter 4
Defining the End-User Interface

Table 4-15 • Settings for an Edit Field Control (cont.)

Setting Project Type Description

Height Basic MSI, For Basic MSI and Merge Module projects: Specify the height of the
InstallScript, control in Windows Installer user interface units (1/12 of the height of
InstallScript MSI, the system font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Merge Module
Specify the height of the control in dialog units.

Indirect Property Basic MSI, Merge If the property that is associated with this control is referenced
Module indirectly, select True; otherwise, select False.

When True is selected for an indirect property is set to True, Windows

Installer resolves the referenced property at run time. For example, this
check box might use the property _BROWSE, whose value is INSTALLDIR.
If you select True for the Indirect Property setting, the value of _BROWSE
will be the current value of the INSTALLDIR property. If you select False
for the Indirect Property setting, the value of _BROWSE will contain the
string INSTALLDIR.

Left Basic MSI, Specify the distance from the left edge of the dialog to the start of the
InstallScript, control in installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Left Scrollbar Basic MSI, If you want the arrow and vertical scrollbar to be displayed on the left
InstallScript, side of the control, select True. This option should be selected only
InstallScript MSI, when True is selected for the Right-to-Left setting.
InstallScript Object,
Merge Module

Max. Length Basic MSI, Merge Specify the maximum number of characters that the end user can enter
Module in this control.

MultiLine Basic MSI, If you want this control to be multiline control, select True.
InstallScript,
InstallScript MSI,
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

1058 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-15 • Settings for an Edit Field Control (cont.)

Setting Project Type Description

Password Basic MSI, If you want this control to behave like a password control, only showing
InstallScript, an asterisk (*) in place of each character, select True. If you want this
InstallScript MSI, control to behave like a normal edit field control, select False.
InstallScript Object,
Merge Module

Property Basic MSI, Merge Enter the name of a property that is set when an end user enters text in
Module this control. This property can be unique to this control; it does not need
to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public
property by giving it a name that contains only uppercase letters, use
the Property Manager view to add the public property, and then assign
to it the value of the default selection.

Property Is Integer Basic MSI, Merge If the property for this control (specified in the Property setting) has an
Module integer value, select True. If the property’s value is a string, select False.

Right-Aligned Basic MSI, The default value of False aligns the text to the left of the control. Set it
InstallScript, to True to align the text to the right.
InstallScript MSI,
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, For English and other languages that are written from left to right, select
InstallScript, False. For Hebrew and those languages that are read from right to left,
InstallScript MSI, select True.
InstallScript Object,
Merge Module

Sunken Basic MSI, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript, select True. To use the default visual style for the control, select False.
InstallScript MSI,
InstallScript Object,
Merge Module

Tab Index Basic MSI, Assign an integer that—along with the other controls on this dialog but
InstallScript, excluding controls such as static text—specifies the order in which each
InstallScript MSI, control on the dialog receives focus when the end user presses the TAB
InstallScript Object, key. The lowest tab index that you can use is the number 0.
Merge Module

Tab Stop Basic MSI, Indicate whether this control receives focus within the tab order. True
InstallScript, indicates that the control receives focus; False indicates that the control
InstallScript MSI, does not receive focus.
InstallScript Object,
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1059

Chapter 4
Defining the End-User Interface

Table 4-15 • Settings for an Edit Field Control (cont.)

Setting Project Type Description

Text Basic MSI, Merge This setting contains the text that is used in the control.
Module
When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays
the font that is contained in the DefaultUIFont property.

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places
Module the mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, Merge Specify the distance from the top of the dialog to the top of the control
Module in installer units (1/12 of the height of the system font).

Visible Basic MSI, Merge True means that the control is visible, and False means that it is hidden.
Module You can also make the control visible by editing its condition in the
Behavior area for the dialog.

Width Basic MSI, Merge Specify the width of the control in Windows Installer user interface units
Module (1/12 of the height of the system font).

See Also
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
Dialog Controls

Group Box Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object

1060 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• Merge Module

A group box can be used to enclose various controls in one area. To move and align the group box along with any individual
control that it encloses, hold the CTRL key as you select the group box and each control that you want to select. A group
box also provides a label that you can use to express the relationship between the controls that are contained within it.

When you select a group box control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Table 4-16 • Settings for a Group Box Control

Setting Project Type Description

Name Basic MSI, InstallScript, Enter a name for this group box. The name must be unique among all of
InstallScript MSI, the controls in your project.
InstallScript Object,
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the control’s label if you specify nothing for the
Module Text Style setting.

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript Object, key or clicking the Close button on the title bar. The Cancel or Finish
Merge Module button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not
Module currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Default Basic MSI, InstallScript, If this is the only control on the dialog that you want to be the default
InstallScript MSI, control, which means that it is activated when the end user presses the
InstallScript Object, ENTER key, select True. The Next or OK button is usually the default
Merge Module control.

Enabled Basic MSI, InstallScript, Indicate whether the control is enabled. True means that this control is
InstallScript MSI, available (the end user can interact with it). False means that it is not
InstallScript Object, available (grayed out).
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1061

Chapter 4
Defining the End-User Interface

Table 4-16 • Settings for a Group Box Control (cont.)

Setting Project Type Description

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of the
InstallScript Object, system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the height of the control in dialog units.

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

Right-Aligned Basic MSI, InstallScript, The default value of False aligns the text to the left of the control. Set it to
InstallScript MSI, True to align the text to the right.
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, InstallScript, For English and other languages that are written from left to right, select
InstallScript MSI, False. For Hebrew and those languages that are read from right to left,
InstallScript Object, select True.
Merge Module

Sunken Basic MSI, InstallScript, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript MSI, select True. To use the default visual style for the control, select False.
InstallScript Object,
Merge Module

Tab Index Basic MSI, InstallScript, Assign an integer that—along with the other controls on this dialog but
InstallScript MSI, excluding controls such as static text—specifies the order in which each
InstallScript Object, control on the dialog receives focus when the end user presses the TAB
Merge Module key. The lowest tab index that you can use is the number 0.

Tab Stop Basic MSI, InstallScript, Indicate whether this control receives focus within the tab order. True
InstallScript MSI, indicates that the control receives focus; False indicates that the control
InstallScript Object, does not receive focus.
Merge Module

1062 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-16 • Settings for a Group Box Control (cont.)

Setting Project Type Description

Text Basic MSI, InstallScript, This setting contains the text that is used for the group box label.
InstallScript MSI,
When you type a value for this setting, you are creating a string entry and
InstallScript Object,
setting its initial value for all of the languages that are currently in the
Merge Module
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays
the font that is contained in the DefaultUIFont property.

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places
Module the mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control in
InstallScript MSI, installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Visible Basic MSI, InstallScript, True means that the control is visible, and False means that it is hidden.
InstallScript MSI, You can also make the control visible by editing its condition in the
InstallScript Object, Behavior area for the dialog.
Merge Module

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of the
InstallScript Object, system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the width of the control in dialog units.

See Also
Dialog Controls

Hyperlink Control
InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 1063

Chapter 4
Defining the End-User Interface

• Basic MSI
• Merge Module

To learn how to add an HTML control to a dialog in an InstallScript project or in an InstallScript MSI project, see Using an HTML
Control on a Dialog.

Use the hyperlink control to add a hyperlink to a dialog in your project. The hyperlink control displays an HTML link;
clicking the link at run time opens a page in the default browser on the target system.

Important • Windows Installer 5 and later include support for the hyperlink control. If this control is used on a dialog that is
displayed on a system that has an earlier version of Windows Installer, run-time error 2885 occurs, and the installation aborts.
Therefore, if you want to use the hyperlink control on a dialog but your installation targets systems that have Windows
Installer 4.5 or earlier, it is recommended that you include two versions of the dialog in your project: one with the hyperlink
control, and one without it. Add conditions to the dialogs to show or hide them, depending on the version of Windows Installer
that is present.

Following is a sample condition that you could use for the dialog that contains the hyperlink control:

VersionMsi >= "5.00"

Following is a sample condition that you could use for the alternate dialog that does not contain any hyperlink control:

VersionMsi < "5.00"

When you select a hyperlink control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Table 4-17 • Settings for a Hyperlink Control

Setting Description

Name Enter a name for this hyperlink control. The name must be unique among all of the controls in
your project.

Base Text Style This font style is used for the control’s label if you specify nothing for the Text Style setting.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True. Clicking the
cancel control has the same effect as pressing the ESC key or clicking the Close button on the
title bar. The Cancel or Finish button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog that contains
this control.

Code Page If you want the control to use fonts from the code page that is defined in the installation’s
package, select Database. If you want the control to use fonts from the target system’s default
code page, select User’s System.

Context Help This setting is reserved for future use. Windows Installer does not currently support launching
context-sensitive help topics from the installation.

Default If this is the only control on the dialog that you want to be the default control, which means that
it is activated when the end user presses the ENTER key, select True. The Next or OK button is
usually the default control.

1064 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-17 • Settings for a Hyperlink Control (cont.)

Setting Description

Enabled Indicate whether the control is enabled. True means that this control is available (the end user
can interact with it). False means that it is not available (grayed out).

Format as Bytes If you want the installation to attempt to display the value that is entered in the Text setting in
bytes, select True. If you select True, the Text setting must contain only a number, without the
unit. Then, at run time, it is divided by 512 and displayed as the correct number of kilobytes,
megabytes, or gigabytes, depending on the size.

Height Specify the height of the control in Windows Installer user interface units (1/12 of the height of
the system font).

Left Specify the distance from the left edge of the dialog to the start of the control in installer units
(1/12 of the height of the system font).

No Prefix If the Text setting contains an ampersand that should be displayed as an ampersand character
(&), select True.

If you are using the ampersand in the Text setting to indicate that the letter that follows the
ampersand should be underlined (for example, &Click would be displayed as Click), select
False.

No Text Wrap Indicate whether you want to allow the text to wrap in this control. If you select True and the
text expands beyond the width of the text area, the end of the string is cut off and replaced with
an ellipsis button (...). Otherwise, the text wraps and can extend beyond the height of the text
area, if it is not long enough.

Property Enter the name of a property that is set when an end user clicks this hyperlink. This property
can be unique to this control; it does not need to be present in the Property Manager view.

Right-Aligned The default value of False aligns the text to the left of the control. Set it to True to align the text
to the right.

Right-to-Left For English and other languages that are written from left to right, select False. For Hebrew and
those languages that are read from right to left, select True.

Sunken To give the control’s edges a recessed, three-dimensional appearance, select True. To use the
default visual style for the control, select False.

Tab Index Assign an integer that—along with the other controls on this dialog but excluding controls such
as static text—specifies the order in which each control on the dialog receives focus when the
end user presses the TAB key. The lowest tab index that you can use is the number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates that the control
receives focus; False indicates that the control does not receive focus.

InstallShield 2020 User Guide ISP-2600-UG00 1065

Chapter 4
Defining the End-User Interface

Table 4-17 • Settings for a Hyperlink Control (cont.)

Setting Description

Text This setting contains the text that is used for the control. Use HTML markup in this setting for
your hyperlink. Following is a sample entry for this setting:

To learn about the latest offerings from ABC Company, visit the <a href="http://
www.abccompany.com">ABC Company Web site</a>.

For this sample, the ABC Company Web site text is displayed as a hyperlink that points to the
http://www.abccompany.com Web site.

Note that the only protocol that is supported for the hyperlink is HTML.

When you type a value for this setting, you are creating a string entry and setting its initial value
for all of the languages that are currently in the project. As an alternative to typing a new value,
you can click the ellipsis button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Text Style Select the font style, size, and color (if available) in which you want the control’s label to be
displayed. Leaving the value as <Default> displays the font that is contained in the
DefaultUIFont property.

Tooltip Enter the text that you want to be displayed when the end user places the mouse pointer over
the control.

When you type a value for this setting, you are creating a string entry and setting its initial value
for all of the languages that are currently in the project. As an alternative to typing a new value,
you can click the ellipsis button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer units (1/12 of
the height of the system font).

Transparent If you want the background to show through this control, select True.

Note that you may want to avoid making this control transparent if you are placing it on top of a
colored bitmap. The text may not be visible if end users change the color scheme of their
display. For example, the text in this control may become invisible if an end user sets the high-
contrast parameter for accessibility reasons.

Visible True means that the control is visible, and False means that it is hidden. You can also make the
control visible by editing its condition in the Behavior area for the dialog.

Width Specify the width of the control in Windows Installer user interface units (1/12 of the height of
the system font).

See Also
Dialog Controls

1066 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Icon Control
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

The icon control displays a picture of an icon.

When you select an icon control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Table 4-18 • Settings for an Icon Control

Setting Project Type Description

Name Basic MSI, InstallScript, Enter a name for this icon. The name must be unique among all of the
InstallScript MSI, controls in your project.
InstallScript Object,
Merge Module

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the
InstallScript Object, ESC key or clicking the Close button on the title bar. The Cancel or
Merge Module Finish button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not
Module currently support launching context-sensitive help topics from the
installation.

Control Identifier InstallScript, This setting contains a numeric identifier for the control that is unique
InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Default Basic MSI, InstallScript, If this is the only control on the dialog that you want to be the default
InstallScript MSI, control, which means that it is activated when the end user presses the
InstallScript Object, ENTER key, select True. The Next or OK button is usually the default
Merge Module control.

InstallShield 2020 User Guide ISP-2600-UG00 1067

Chapter 4
Defining the End-User Interface

Table 4-18 • Settings for an Icon Control (cont.)

Setting Project Type Description

File Name Basic MSI, InstallScript, Enter the path to and the name of the icon file that you want to use for
InstallScript MSI, this control, or click the ellipsis button (...) in this setting to browse to it.
InstallScript Object, InstallShield adds the file to your release at build time. The file must be
Merge Module stored as a binary resource in the installation.

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of
InstallScript Object, the system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the height of the control in dialog units.

Icon Size Basic MSI, InstallScript, Assuming that your icon file has more than one resource, specify the
InstallScript MSI, size of the image that you want to use for the control. The Use first
InstallScript Object, image option causes the first image in the file to be displayed and
Merge Module makes it stretch to fit the size of the control, regardless of what you
specify for the Stretch to Fit setting.

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

Stretch to Fit Basic MSI, Merge If you want the icon to be resized to fill the area of the control, select
Module True.

To have the icon centered if it is smaller than the control or to have the
icon cropped if it is bigger than the control, select False.

Sunken Basic MSI, InstallScript, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript MSI, select True. To use the default visual style for the control, select False.
InstallScript Object,
Merge Module

Tab Index Basic MSI, InstallScript, Assign an integer that—along with the other controls on this dialog but
InstallScript MSI, excluding controls such as static text—specifies the order in which each
InstallScript Object, control on the dialog receives focus when the end user presses the TAB
Merge Module key. The lowest tab index that you can use is the number 0.

Tab Stop Basic MSI, InstallScript, Indicate whether this control receives focus within the tab order. True
InstallScript MSI, indicates that the control receives focus; False indicates that the
InstallScript Object, control does not receive focus.
Merge Module

1068 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-18 • Settings for an Icon Control (cont.)

Setting Project Type Description

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places
Module the mouse pointer over the control.

When you type a value for this setting, you are creating a string entry
and setting its initial value for all of the languages that are currently in
the project. As an alternative to typing a new value, you can click the
ellipsis button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control
InstallScript MSI, in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Visible Basic MSI, InstallScript, True means that the control is visible, and False means that it is hidden.
InstallScript MSI, You can also make the control visible by editing its condition in the
InstallScript Object, Behavior area for the dialog.
Merge Module

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of
InstallScript Object, the system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the width of the control in dialog units.

See Also
Dialog Controls

Line Control
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

The line control creates lines of adjustable length and thickness. You can use lines on a dialog to separate areas of the
dialog or add graphical touches.

InstallShield 2020 User Guide ISP-2600-UG00 1069

Chapter 4
Defining the End-User Interface

When you select a line control in a dialog of the Dialogs view, InstallShield displays the following settings in the right pane.

Table 4-19 • Settings for a Line Control

Setting Project Type Description

Name Basic MSI, InstallScript, Enter a name for this line. The name must be unique among all of the
InstallScript MSI, controls in your project.
InstallScript Object,
Merge Module

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript Object, key or clicking the Close button on the title bar. The Cancel or Finish
Merge Module button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge Module This setting is reserved for future use. Windows Installer does not
currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Default Basic MSI, InstallScript, If this is the only control on the dialog that you want to be the default
InstallScript MSI, control, which means that it is activated when the end user presses the
InstallScript Object, ENTER key, select True. The Next or OK button is usually the default
Merge Module control.

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of
InstallScript Object, the system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the height of the control in dialog units.

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

1070 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-19 • Settings for a Line Control (cont.)

Setting Project Type Description

Sunken Basic MSI, InstallScript, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript MSI, select True. To use the default visual style for the control, select False.
InstallScript Object,
Merge Module

Tab Index Basic MSI, InstallScript, Assign an integer that—along with the other controls on this dialog but
InstallScript MSI, excluding controls such as static text—specifies the order in which each
InstallScript Object, control on the dialog receives focus when the end user presses the TAB
Merge Module key. The lowest tab index that you can use is the number 0.

Tab Stop Basic MSI, InstallScript, Indicate whether this control receives focus within the tab order. True
InstallScript MSI, indicates that the control receives focus; False indicates that the control
InstallScript Object, does not receive focus.
Merge Module

Tooltip Basic MSI, Merge Module Enter the text that you want to be displayed when the end user places
the mouse pointer over the control.

When you type a value for this setting, you are creating a string entry
and setting its initial value for all of the languages that are currently in
the project. As an alternative to typing a new value, you can click the
ellipsis button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control
InstallScript MSI, in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Visible Basic MSI, InstallScript, True means that the control is visible, and False means that it is hidden.
InstallScript MSI, You can also make the control visible by editing its condition in the
InstallScript Object, Behavior area for the dialog.
Merge Module

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of
InstallScript Object, the system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the width of the control in dialog units.

See Also
Dialog Controls

InstallShield 2020 User Guide ISP-2600-UG00 1071

Chapter 4
Defining the End-User Interface

List Box Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

The list box control is a standard list box that lets end users select a single option from a list of predetermined options.

When you select a list box control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Project • (For Basic MSI and Merge Module projects) When you first draw this type of control on a dialog, InstallShield prompts
you for the name of a Windows Installer property that identifies all of the items that are displayed in this list box. InstallShield
uses the name that you enter as the value for this control’s Property setting. At run time, the installation sets the value of this
property based on the end user’s selection. For more details, see Working with Windows Installer and Advanced UI or Suite/
Advanced UI Properties.

Table 4-20 • Settings for a List Box Control

Setting Project Type Description

Name Basic MSI, InstallScript, Enter a name for this list box. The name must be unique among all of the
InstallScript MSI, controls in your project.
InstallScript Object,
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the control’s label if you specify nothing for the
Module Text Style setting.

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript Object, key or clicking the Close button on the title bar. The Cancel or Finish
Merge Module button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Code Page Basic MSI, Merge If you want the control to use fonts from the code page that is defined in
Module the installation’s package, select Database. If you want the control to use
fonts from the target system’s default code page, select User’s System.

1072 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-20 • Settings for a List Box Control (cont.)

Setting Project Type Description

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not
Module currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Default Basic MSI, InstallScript, If this is the only control on the dialog that you want to be the default
InstallScript MSI, control, which means that it is activated when the end user presses the
InstallScript Object, ENTER key, select True. The Next or OK button is usually the default
Merge Module control.

Enabled Basic MSI, InstallScript, Indicate whether the control is enabled. True means that this control is
InstallScript MSI, available (the end user can interact with it). False means that it is not
InstallScript Object, available (grayed out).
Merge Module

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the height of the control in dialog units.

Indirect Basic MSI, InstallScript, If the property that is associated with this control is referenced indirectly,
Property InstallScript MSI, select True; otherwise, select False.
InstallScript Object,
When True is selected for an indirect property is set to True, Windows
Merge Module
Installer resolves the referenced property at run time. For example, this
check box might use the property _BROWSE, whose value is INSTALLDIR. If
you select True for the Indirect Property setting, the value of _BROWSE will
be the current value of the INSTALLDIR property. If you select False for the
Indirect Property setting, the value of _BROWSE will contain the string
INSTALLDIR.

Items Basic MSI, Merge To specify the options that you want to be listed in this control, click the
Module ellipsis button (...) in this setting; this opens the List Items dialog box.

To add a new item to the list, click the Add button on the List Items dialog
box. For each item, you must enter the text that is displayed in the list
box, and a value, which is the value that is assigned to the property if this
item is selected.

InstallShield 2020 User Guide ISP-2600-UG00 1073

Chapter 4
Defining the End-User Interface

Table 4-20 • Settings for a List Box Control (cont.)

Setting Project Type Description

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Left Scrollbar Basic MSI, InstallScript, If you want the arrow and vertical scrollbar to be displayed on the left side
InstallScript MSI, of the control, select True. This option should be selected only when True
InstallScript Object, is selected for the Right-to-Left setting.
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

Property Basic MSI, Merge Enter the name of a property that is set when an end user selects an
Module option from this control. This property can be unique to this control; it
does not need to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public
property by giving it a name that contains only uppercase letters, use the
Property Manager view to add the public property, and then assign to it
the text of the default selection.

Property Is Basic MSI, InstallScript, If the property for this control (specified in the Property setting) has an
Integer InstallScript MSI, integer value, select True. If the property’s value is a string, select False.
InstallScript Object,
Merge Module

Right-Aligned Basic MSI, InstallScript, The default value of False aligns the text to the left of the control. Set it to
InstallScript MSI, True to align the text to the right.
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, InstallScript, For English and other languages that are written from left to right, select
InstallScript MSI, False. For Hebrew and those languages that are read from right to left,
InstallScript Object, select True.
Merge Module

Sorted Basic MSI, InstallScript, Selecting True causes the items in the list box to be sorted alphabetically.
InstallScript MSI, A value of False makes them retain the order that you set for each item in
InstallScript Object, the List Items dialog box.
Merge Module

Sunken Basic MSI, InstallScript, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript MSI, select True. To use the default visual style for the control, select False.
InstallScript Object,
Merge Module

1074 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-20 • Settings for a List Box Control (cont.)

Setting Project Type Description

Tab Index Basic MSI, InstallScript, Assign an integer that—along with the other controls on this dialog but
InstallScript MSI, excluding controls such as static text—specifies the order in which each
InstallScript Object, control on the dialog receives focus when the end user presses the TAB
Merge Module key. The lowest tab index that you can use is the number 0.

Tab Stop Basic MSI, InstallScript, Indicate whether this control receives focus within the tab order. True
InstallScript MSI, indicates that the control receives focus; False indicates that the control
InstallScript Object, does not receive focus.
Merge Module

Text Basic MSI, Merge This setting contains the text that is used for screen readers.
Module
When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays
the font that is contained in the DefaultUIFont property.

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control in
InstallScript MSI, installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Visible Basic MSI, InstallScript, True means that the control is visible, and False means that it is hidden.
InstallScript MSI, You can also make the control visible by editing its condition in the
InstallScript Object, Behavior area for the dialog.
Merge Module

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the width of the control in dialog units.

InstallShield 2020 User Guide ISP-2600-UG00 1075

Chapter 4
Defining the End-User Interface

See Also
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
Dialog Controls

List View Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

The list view control displays a single column of options; an icon is displayed next to each option.

When you select a list view control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Project • (For Basic MSI and Merge Module projects) When you first draw this type of control on a dialog, InstallShield prompts
you for the name of a Windows Installer property that identifies all of the items that are displayed in this list view. InstallShield
uses the name that you enter as the value for this control’s Property setting. At run time, the installation sets the value of this
property based on the end user’s selection. For more details, see Working with Windows Installer and Advanced UI or Suite/
Advanced UI Properties.

Table 4-21 • Settings for a List View Control

Setting Project Type Description

Name Basic MSI, Enter a name for this list view. The name must be unique among all of the
InstallScript, controls in your project.
InstallScript MSI,
InstallScript Object,
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the control’s label if you specify nothing for the
Module Text Style setting.

Cancel Basic MSI, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript MSI, key or clicking the Close button on the title bar. The Cancel or Finish
InstallScript Object, button is usually the cancel control.
Merge Module
This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

1076 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-21 • Settings for a List View Control (cont.)

Setting Project Type Description

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not
Module currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Default Basic MSI, If this is the only control on the dialog that you want to be the default
InstallScript, control, which means that it is activated when the end user presses the
InstallScript MSI, ENTER key, select True. The Next or OK button is usually the default
InstallScript Object, control.
Merge Module

Enabled Basic MSI, Indicate whether the control is enabled. True means that this control is
InstallScript, available (the end user can interact with it). False means that it is not
InstallScript MSI, available (grayed out).
InstallScript Object,
Merge Module

Height Basic MSI, For Basic MSI and Merge Module projects: Specify the height of the control
InstallScript, in Windows Installer user interface units (1/12 of the height of the system
InstallScript MSI, font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Merge Module
Specify the height of the control in dialog units.

Icon Size Basic MSI, Merge Assuming that your icon file has more than one resource, specify the size
Module of the image that you want to use for the control. The Use first image
option causes the first image in the file to be displayed and makes it
stretch to fit the size of the control, regardless of what you specify for the
Stretch to Fit setting.

Indirect Basic MSI, If the property that is associated with this control is referenced indirectly,
Property InstallScript, select True; otherwise, select False.
InstallScript MSI,
When True is selected for an indirect property is set to True, Windows
InstallScript Object,
Installer resolves the referenced property at run time. For example, this
Merge Module
check box might use the property _BROWSE, whose value is INSTALLDIR. If
you select True for the Indirect Property setting, the value of _BROWSE will
be the current value of the INSTALLDIR property. If you select False for the
Indirect Property setting, the value of _BROWSE will contain the string
INSTALLDIR.

InstallShield 2020 User Guide ISP-2600-UG00 1077

Chapter 4
Defining the End-User Interface

Table 4-21 • Settings for a List View Control (cont.)

Setting Project Type Description

Items Basic MSI, Merge To specify the options that you want to be listed in this control, click the
Module ellipsis button (...) in this setting; this opens the List Items dialog box.

To add a new item to the list, click the Add button on the List Items dialog
box. For each item, you must enter the text that is displayed in the list
view control, and a value, which is the value that is assigned to the
property if this item is selected.

Left Basic MSI, Specify the distance from the left edge of the dialog to the start of the
InstallScript, control in installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Left Scrollbar Basic MSI, If you want the arrow and vertical scrollbar to be displayed on the left side
InstallScript, of the control, select True. This option should be selected only when True
InstallScript MSI, is selected for the Right-to-Left setting.
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

Property Basic MSI, Merge Enter the name of a property that is set when an end user selects a value
Module from this control. This property can be unique to this control; it does not
need to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public
property by giving it a name that contains only uppercase letters, use the
Property Manager view to add the public property, and then assign to it
the value of the default selection.

Property Is Basic MSI, If the property for this control (specified in the Property setting) has an
Integer InstallScript, integer value, select True. If the property’s value is a string, select False.
InstallScript MSI,
InstallScript Object,
Merge Module

Right-Aligned Basic MSI, The default value of False aligns the text to the left of the control. Set it to
InstallScript, True to align the text to the right.
InstallScript MSI,
InstallScript Object,
Merge Module

1078 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-21 • Settings for a List View Control (cont.)

Setting Project Type Description

Right-to-Left Basic MSI, For English and other languages that are written from left to right, select
InstallScript, False. For Hebrew and those languages that are read from right to left,
InstallScript MSI, select True.
InstallScript Object,
Merge Module

Sorted Basic MSI, Selecting True causes the items in the combo box to be sorted
InstallScript, alphabetically. A value of False makes them retain the order that you set
InstallScript MSI, for each item in the List Items dialog box.
InstallScript Object,
Merge Module

Stretch to Fit Basic MSI, Merge If you want the image to be resized to fill the area of the control, select
Module True.

To have the image centered if it is smaller than the control or to have the
image cropped if it is bigger than the control, select False.

Sunken Basic MSI, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript, select True. To use the default visual style for the control, select False.
InstallScript MSI,
InstallScript Object,
Merge Module

Tab Index Basic MSI, Assign an integer that—along with the other controls on this dialog but
InstallScript, excluding controls such as static text—specifies the order in which each
InstallScript MSI, control on the dialog receives focus when the end user presses the TAB
InstallScript Object, key. The lowest tab index that you can use is the number 0.
Merge Module

Tab Stop Basic MSI, Indicate whether this control receives focus within the tab order. True
InstallScript, indicates that the control receives focus; False indicates that the control
InstallScript MSI, does not receive focus.
InstallScript Object,
Merge Module

Text Basic MSI, Merge This setting contains the text that is used in the control.
Module
When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays
the font that is contained in the DefaultUIFont property.

InstallShield 2020 User Guide ISP-2600-UG00 1079

Chapter 4
Defining the End-User Interface

Table 4-21 • Settings for a List View Control (cont.)

Setting Project Type Description

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, Specify the distance from the top of the dialog to the top of the control in
InstallScript, installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Visible Basic MSI, True means that the control is visible, and False means that it is hidden.
InstallScript, You can also make the control visible by editing its condition in the
InstallScript MSI, Behavior area for the dialog.
InstallScript Object,
Merge Module

Width Basic MSI, For Basic MSI and Merge Module projects: Specify the width of the control
InstallScript, in Windows Installer user interface units (1/12 of the height of the system
InstallScript MSI, font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Merge Module
Specify the width of the control in dialog units.

See Also
Dialog Controls

Masked Edit Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• Merge Module

The masked edit control is essentially an edit field control that lets end users enter information in a specified format.

1080 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

When you select a masked edit control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Table 4-22 • Settings for a Masked Edit Control

Setting Description

Name Enter a name for this masked edit control. The name must be unique among all of the controls
in your project.

Base Text Style This font style is used for the control’s label if you specify nothing for the Text Style setting.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True. Clicking the
cancel control has the same effect as pressing the ESC key or clicking the Close button on the
title bar. The Cancel or Finish button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog that contains
this control.

Context Help This setting is reserved for future use. Windows Installer does not currently support launching
context-sensitive help topics from the installation.

Default If this is the only control on the dialog that you want to be the default control, which means that
it is activated when the end user presses the ENTER key, select True. The Next or OK button is
usually the default control.

Enabled Indicate whether the control is enabled. True means that this control is available (the end user
can interact with it). False means that it is not available (grayed out).

Height Specify the height of the control in Windows Installer user interface units (1/12 of the height of
the system font).

Indirect Property If the property that is associated with this control is referenced indirectly, select True;
otherwise, select False.

When True is selected for an indirect property is set to True, Windows Installer resolves the
referenced property at run time. For example, this check box might use the property _BROWSE,
whose value is INSTALLDIR. If you select True for the Indirect Property setting, the value of
_BROWSE will be the current value of the INSTALLDIR property. If you select False for the Indirect
Property setting, the value of _BROWSE will contain the string INSTALLDIR.

Left Specify the distance from the left edge of the dialog to the start of the control in installer units
(1/12 of the height of the system font).

Mask Enter the formatting for the mask. To learn more, see MaskedEdit Control in the Windows
Installer Help Library.

Max. Length Specify the maximum number of characters that the end user can enter in this control.

InstallShield 2020 User Guide ISP-2600-UG00 1081

Chapter 4
Defining the End-User Interface

Table 4-22 • Settings for a Masked Edit Control (cont.)

Setting Description

Property Enter the name of a property that is set with the value that an end user enters in the masked
edit control. This property can be unique to this control; it does not need to be present in the
Property Manager view.

To set a default value for this control, make sure the property is a public property by giving it a
name that contains only uppercase letters, use the Property Manager view to add the public
property, and then assign to it the value of the default selection.

Right-to-Left For English and other languages that are written from left to right, select False. For Hebrew and
those languages that are read from right to left, select True.

Sunken To give the control’s edges a recessed, three-dimensional appearance, select True. To use the
default visual style for the control, select False.

Tab Index Assign an integer that—along with the other controls on this dialog but excluding controls such
as static text—specifies the order in which each control on the dialog receives focus when the
end user presses the TAB key. The lowest tab index that you can use is the number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates that the control
receives focus; False indicates that the control does not receive focus.

Text Style Select the font style, size, and color (if available) in which you want the control’s label to be
displayed. Leaving the value as <Default> displays the font that is contained in the
DefaultUIFont property.

Tooltip Enter the text that you want to be displayed when the end user places the mouse pointer over
the control.

When you type a value for this setting, you are creating a string entry and setting its initial value
for all of the languages that are currently in the project. As an alternative to typing a new value,
you can click the ellipsis button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer units (1/12 of
the height of the system font).

Visible True means that the control is visible, and False means that it is hidden. You can also make the
control visible by editing its condition in the Behavior area for the dialog.

Width Specify the width of the control in Windows Installer user interface units (1/12 of the height of
the system font).

See Also
Dialog Controls

1082 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Path Edit Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• Merge Module

A path edit control is used in conjunction with a directory combo control and a directory list control to create a browse
dialog. The path edit displays the complete path that is assembled from selections that the end user makes in the directory
combo and directory list, along with or instead of edits that the end user makes.

When you select a path edit control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Table 4-23 • Settings for a Path Edit Control

Setting Description

Name Enter a name for this path edit control. The name must be unique among all of the
controls in your project.

Base Text Style This font style is used for the control’s label if you specify nothing for the Text
Style setting.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True.
Clicking the cancel control has the same effect as pressing the ESC key or clicking
the Close button on the title bar. The Cancel or Finish button is usually the cancel
control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog
that contains this control.

Context Help This property is reserved for future use. Windows Installer does not currently
support launching context-sensitive help topics from the installation.

Default If this is the only control on the dialog that you want to be the default control,
which means that it is activated when the end user presses the ENTER key, select
True. The Next or OK button is usually the default control.

Enabled Indicate whether the control is enabled. True means that this control is available
(the end user can interact with it). False means that it is not available (grayed out).

Height Specify the height of the control in Windows Installer user interface units (1/12 of
the height of the system font).

InstallShield 2020 User Guide ISP-2600-UG00 1083

Chapter 4
Defining the End-User Interface

Table 4-23 • Settings for a Path Edit Control (cont.)

Setting Description

Indirect Property If the property that is associated with this control is referenced indirectly, select
True; otherwise, select False.

When True is selected for an indirect property is set to True, Windows Installer
resolves the referenced property at run time. For example, this check box might
use the property _BROWSE, whose value is INSTALLDIR. If you select True for the
Indirect Property setting, the value of _BROWSE will be the current value of the
INSTALLDIR property. If you select False for the Indirect Property setting, the
value of _BROWSE will contain the string INSTALLDIR.

Left Specify the distance from the left edge of the dialog to the start of the control in
installer units (1/12 of the height of the system font).

Property Enter the name of a property that is set when an end user enters a value into this
path edit or selects one from the directory list. This property can be unique to this
control; it does not need to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public property
by giving it a name that contains only uppercase letters, use the Property Manager
view to add the public property, and then assign to it the value of the default
selection.

Right-Aligned The default value of False aligns the text to the left of the control. Set it to True to
align the text to the right.

Right-to-Left For English and other languages that are written from left to right, select False.
For Hebrew and those languages that are read from right to left, select True.

Sunken To give the control’s edges a recessed, three-dimensional appearance, select

True. To use the default visual style for the control, select False.

Tab Index Assign an integer that—along with the other controls on this dialog but excluding
controls such as static text—specifies the order in which each control on the
dialog receives focus when the end user presses the TAB key. The lowest tab index
that you can use is the number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates
that the control receives focus; False indicates that the control does not receive
focus.

Text This setting contains the text that is used for the control’s label.

When you type a value for this setting, you are creating a string entry and setting
its initial value for all of the languages that are currently in the project. As an
alternative to typing a new value, you can click the ellipsis button (...) in this
setting to select an existing string. For more information, see Using String Entries
in InstallShield.

1084 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-23 • Settings for a Path Edit Control (cont.)

Setting Description

Text Style Select the font style, size, and color (if available) in which you want the control’s
label to be displayed. Leaving the value as <Default> displays the font that is
contained in the DefaultUIFont property.

Tooltip Enter the text that you want to be displayed when the end user places the mouse
pointer over the control.

When you type a value for this setting, you are creating a string entry and setting
its initial value for all of the languages that are currently in the project. As an
alternative to typing a new value, you can click the ellipsis button (...) in this
setting to select an existing string. For more information, see Using String Entries
in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer
units (1/12 of the height of the system font).

Visible True means that the control is visible, and False means that it is hidden. You can
also make the control visible by editing its condition in the Behavior area for the
dialog.

Width Specify the width of the control in Windows Installer user interface units (1/12 of
the height of the system font).

See Also
Dialog Controls

Progress Bar Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

A progress bar is a dynamic, graphical bar that fills up in response to control events.

InstallShield 2020 User Guide ISP-2600-UG00 1085

Chapter 4
Defining the End-User Interface

When you select a progress bar control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Table 4-24 • Settings for a Progress Bar Control

Setting Project Type Description

Name Basic MSI, Enter a name for this progress bar. The name must be unique among all of
InstallScript, the controls in your project.
InstallScript MSI,
InstallScript Object,
Merge Module

Appearance Basic MSI, Select the appropriate option:

InstallScript,
• Continuous—The moving progress bar consists of a continuous bar.
InstallScript MSI,
InstallScript Object, • Segmented—The progress bar consists of a series of rectangles.
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the control if you specify nothing for the Text
Module Style setting.

Cancel Basic MSI, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript MSI, key or clicking the Close button on the title bar. The Cancel or Finish
InstallScript Object, button is usually the cancel control.
Merge Module
This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not
Module currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Default Basic MSI, If this is the only control on the dialog that you want to be the default
InstallScript, control, which means that it is activated when the end user presses the
InstallScript MSI, ENTER key, select True. The Next or OK button is usually the default
InstallScript Object, control.
Merge Module

Height Basic MSI, For Basic MSI and Merge Module projects: Specify the height of the control
InstallScript, in Windows Installer user interface units (1/12 of the height of the system
InstallScript MSI, font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Merge Module
Specify the height of the control in dialog units.

1086 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-24 • Settings for a Progress Bar Control (cont.)

Setting Project Type Description

Left Basic MSI, Specify the distance from the left edge of the dialog to the start of the
InstallScript, control in installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog box.
Styles InstallScript MSI,
InstallScript Object

Sunken Basic MSI, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript, select True. To use the default visual style for the control, select False.
InstallScript MSI,
InstallScript Object,
Merge Module

Tab Index Basic MSI, Assign an integer that—along with the other controls on this dialog but
InstallScript, excluding controls such as static text—specifies the order in which each
InstallScript MSI, control on the dialog receives focus when the end user presses the TAB
InstallScript Object, key. The lowest tab index that you can use is the number 0.
Merge Module

Tab Stop Basic MSI, Indicate whether this control receives focus within the tab order. True
InstallScript, indicates that the control receives focus; False indicates that the control
InstallScript MSI, does not receive focus.
InstallScript Object,
Merge Module

Text Basic MSI, Merge This setting contains the text that is displayed by the control.
Module
When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays the
font that is contained in the DefaultUIFont property.

InstallShield 2020 User Guide ISP-2600-UG00 1087

Chapter 4
Defining the End-User Interface

Table 4-24 • Settings for a Progress Bar Control (cont.)

Setting Project Type Description

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, Specify the distance from the top of the dialog to the top of the control in
InstallScript, installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Visible Basic MSI, True means that the control is visible, and False means that it is hidden.
InstallScript, You can also make the control visible by editing its condition in the
InstallScript MSI, Behavior area for the dialog.
InstallScript Object,
Merge Module

Width Basic MSI, For Basic MSI and Merge Module projects: Specify the width of the control
InstallScript, in Windows Installer user interface units (1/12 of the height of the system
InstallScript MSI, font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Merge Module
Specify the width of the control in dialog units.

See Also
Dialog Controls

Push Button Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

A push button control is a button that carries out a command when an end user clicks it.

1088 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

When you select a push button control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Table 4-25 • Settings for a Push Button Control

Setting Project Type Description

Name Basic MSI, InstallScript, Enter a name for this push button. The name must be unique among all of
InstallScript MSI, the controls in your project.
InstallScript Object,
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the control’s label if you specify nothing for the
Module Text Style setting.

This setting is enabled if Text is selected for the Control Style setting.

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript Object, key or clicking the Close button on the title bar. The Cancel or Finish
Merge Module button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not
Module currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

Control Style Basic MSI, Merge Specify whether this control is marked with a text label, an icon, or a
Module bitmap.

Default Basic MSI, InstallScript, If this is the only control on the dialog that you want to be the default
InstallScript MSI, control, which means that it is activated when the end user presses the
InstallScript Object, ENTER key, select True. The Next or OK button is usually the default
Merge Module control.

Enabled Basic MSI, InstallScript, Indicate whether the control is enabled. True means that this control is
InstallScript MSI, available (the end user can interact with it). False means that it is not
InstallScript Object, available (grayed out).
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1089

Chapter 4
Defining the End-User Interface

Table 4-25 • Settings for a Push Button Control (cont.)

Setting Project Type Description

File Name Basic MSI, Merge Enter the path to and the name of the image file that you want to use for
Module this control, or click the ellipsis button (...) in this setting to browse to it.
InstallShield adds the file to your release at build time. The file must be
stored as a binary resource in the installation.

This setting is enabled if you select Bitmap or Icon for the Control Style
setting.

This setting is enabled if Bitmap or Icon are selected for the Control Style
setting.

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the height of the control in dialog units.

Icon Size Basic MSI, Merge Assuming that your icon file has more than one resource, specify the size
Module of the image that you want to use for the control. The Use first image
option causes the first image in the file to be displayed and makes it
stretch to fit the size of the control, regardless of what you specify for the
Stretch to Fit setting.

This setting is enabled if Bitmap or Icon are selected for the Control Style
setting.

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog box.
Styles InstallScript MSI,
InstallScript Object

Right-to-Left Basic MSI, InstallScript, For English and other languages that are written from left to right, select
InstallScript MSI, False. For Hebrew and those languages that are read from right to left,
InstallScript Object, select True.
Merge Module

Show UAC Basic MSI, Merge If you want the control to include a User Account Control (UAC) shield icon
Shield Icon Module when end users run the installation on Windows Vista or later systems,
select True. The shield icon signals to end users that elevated privileges
may be required.

If the UAC shield icon should not be included on the control, select False.

1090 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-25 • Settings for a Push Button Control (cont.)

Setting Project Type Description

Stretch to Fit Basic MSI, Merge If you want the image to be resized to fill the area of the control, select
Module True.

To have the image centered if it is smaller than the control or to have the
image cropped if it is bigger than the control, select False.

This setting is enabled if Bitmap or Icon are selected for the Control Style
setting.

Sunken Basic MSI, InstallScript, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript MSI, select True. To use the default visual style for the control, select False.
InstallScript Object,
Merge Module

Tab Index Basic MSI, InstallScript, Assign an integer that—along with the other controls on this dialog but
InstallScript MSI, excluding controls such as static text—specifies the order in which each
InstallScript Object, control on the dialog receives focus when the end user presses the TAB
Merge Module key. The lowest tab index that you can use is the number 0.

Tab Stop Basic MSI, InstallScript, Indicate whether this control receives focus within the tab order. True
InstallScript MSI, indicates that the control receives focus; False indicates that the control
InstallScript Object, does not receive focus.
Merge Module

Text Basic MSI, InstallScript, This setting contains the text that is used on the control.
InstallScript MSI,
When you type a value for this setting, you are creating a string entry and
InstallScript Object,
setting its initial value for all of the languages that are currently in the
Merge Module
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

This setting is enabled if Text is selected for the Control Style setting.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays the
font that is contained in the DefaultUIFont property.

This setting is enabled if Text is selected for the Control Style setting.

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

InstallShield 2020 User Guide ISP-2600-UG00 1091

Chapter 4
Defining the End-User Interface

Table 4-25 • Settings for a Push Button Control (cont.)

Setting Project Type Description

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control in
InstallScript MSI, installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Visible Basic MSI, InstallScript, True means that the control is visible, and False means that it is hidden.
InstallScript MSI, You can also make the control visible by editing its condition in the
InstallScript Object, Behavior area for the dialog.
Merge Module

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the width of the control in dialog units.

See Also
Dialog Controls

Radio Button Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

A radio button control is one of two or more mutually exclusive options that end users can select. A radio button must be
inserted into a radio button group; it functions as part of that control.

A radio button group and its radio buttons behave as a single control. It is not possible to hide or disable individual buttons
within a radio button group. All the buttons in a group must be the same style—for example, either all of them have text or
all of them have bitmaps.

Note that when you delete a radio button group, all of its radio buttons are also deleted. In addition, when you change the
name of the radio button group control, all of its radio buttons are deleted.

1092 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

When you select a radio button control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Table 4-26 • Settings for a Radio Button Control

Setting Project Type Description

Base Text Style Basic MSI, Merge Module This font style is used for the control’s label if you specify nothing for the
Text Style setting.

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript Object, key or clicking the Close button on the title bar. The Cancel or Finish
Merge Module button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge Module This setting is reserved for future use. Windows Installer does not
currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

The control identifier for the first radio button in a group is the control
identifier for the radio button group. The control for each subsequent
radio button is the radio button group identifier incremented by one.

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the
InstallScript MSI, control in Windows Installer user interface units (1/12 of the height of the
InstallScript Object, system font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the height of the control in dialog units.

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Order Basic MSI, InstallScript, Specify the number that indicates the order in which this radio button is
InstallScript MSI, listed in the radio button group. This setting must contain a unique,
InstallScript Object, positive integer, but it does not need to be consecutive with the Order
Merge Module setting of the other radio buttons in this group.

InstallShield 2020 User Guide ISP-2600-UG00 1093

Chapter 4
Defining the End-User Interface

Table 4-26 • Settings for a Radio Button Control (cont.)

Setting Project Type Description

Text Basic MSI, InstallScript, This setting contains the text that is used for the radio button’s label.
InstallScript MSI,
When you type a value for this setting, you are creating a string entry and
InstallScript Object,
setting its initial value for all of the languages that are currently in the
Merge Module
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Text Style Basic MSI, Merge Module Select the font style, size, and color (if available) in which you want the
control’s label to be displayed. Leaving the value as <Default> displays
the font that is contained in the DefaultUIFont property.

Tooltip Basic MSI, Merge Module Enter the text that you want to be displayed when the end user places the
mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control in
InstallScript MSI, installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Value Basic MSI, InstallScript, Enter the value that you want to be associated with this radio button
InstallScript MSI, when end users select it.
InstallScript Object,
Merge Module
Project • For Basic MSI projects: To make one of the radio buttons selected
by default, enter the radio button group’s Windows Installer property in the
Property Manager view. Type the property in all uppercase letters if you
want it to be public in scope.Then, specify the value of the button that you
want to appear as the default. For example, if one of your radio buttons has
a value of 104 and the radio button group uses the property
GRP_PROPERTY1, enter the following information in the Property Manager
view to make this radio button the default selection.

• Name: GRP_PROPERTY1
• Value: 104

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the width of the control in dialog units.

1094 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Dialog Controls

Radio Button Group Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

Note that in Basic MSI and Merge Module projects, it is not possible to hide or disable individual buttons within a radio button
group. All the buttons in a group must be the same style—for example, either all of them have text or all of them have bitmaps.

A radio button group control is a container for radio button controls. A radio button group and its radio buttons behave as
a single control. Note that when you delete a radio button group, all of its radio buttons are also deleted. In addition, when
you change the name of the radio button group control, all of its radio buttons are deleted.

When you select a radio button group control in a dialog of the Dialogs view, InstallShield displays the following settings in
the right pane.

Project • (For Basic MSI and Merge Module projects) When you first draw this type of control on a dialog, InstallShield prompts
you for the name of a Windows Installer property that identifies all of the buttons that are displayed in this radio button group.
InstallShield uses the name that you enter as the value for this control’s Property setting. At run time, the installation sets the
value of this property based on the end user’s selection. For more details, see Working with Windows Installer and Advanced UI
or Suite/Advanced UI Properties.

Table 4-27 • Settings for a Radio Button Group Control

Setting Project Type Description

Name Basic MSI, InstallScript, Enter a name for this radio button group. The name must be unique
InstallScript MSI, among all of the controls in your project.
InstallScript Object,
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the control’s label if you specify nothing for the
Module Text Style setting.

This setting has no effect on a radio button group with an image for a
label.

InstallShield 2020 User Guide ISP-2600-UG00 1095

Chapter 4
Defining the End-User Interface

Table 4-27 • Settings for a Radio Button Group Control (cont.)

Setting Project Type Description

Cancel Basic MSI, InstallScript, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript MSI, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript Object, key or clicking the Close button on the title bar. The Cancel or Finish
Merge Module button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not
Module currently support launching context-sensitive help topics from the
installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in
InstallScript Object Visual C++. You should not change the control identifiers for any of the
controls that are included with a dialog by default.

The control identifier for the first radio button in a group is the control
identifier for the radio button group. The control for each subsequent
radio button is the radio button group identifier incremented by one.

Default Basic MSI, InstallScript, If this is the only control on the dialog that you want to be the default
InstallScript MSI, control, which means that it is activated when the end user presses the
InstallScript Object, ENTER key, select True. The Next or OK button is usually the default
Merge Module control.

Enabled Basic MSI, InstallScript, Indicate whether the control is enabled. True means that this control is
InstallScript MSI, available (the end user can interact with it). False means that it is not
InstallScript Object, available (grayed out).
Merge Module

Has Border Basic MSI, InstallScript, To display a border around the radio button group, select True. To omit a
InstallScript MSI, border, select False.
InstallScript Object,
Use the Sunken setting to further modify the appearance of the border.
Merge Module

Height Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the height of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the height of the control in dialog units.

1096 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-27 • Settings for a Radio Button Group Control (cont.)

Setting Project Type Description

Indirect Basic MSI, InstallScript, If the property that is associated with this control is referenced indirectly,
Property InstallScript MSI, select True; otherwise, select False.
InstallScript Object,
When True is selected for an indirect property is set to True, Windows
Merge Module
Installer resolves the referenced property at run time. For example, this
check box might use the property _BROWSE, whose value is INSTALLDIR. If
you select True for the Indirect Property setting, the value of _BROWSE will
be the current value of the INSTALLDIR property. If you select False for the
Indirect Property setting, the value of _BROWSE will contain the string
INSTALLDIR.

Left Basic MSI, InstallScript, Specify the distance from the left edge of the dialog to the start of the
InstallScript MSI, control in installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog
Styles InstallScript MSI, box.
InstallScript Object

Property Basic MSI, Merge Enter the name of a property that is set when an end user selects one of
Module the radio buttons in this group. This property can be unique to this
control; it does not need to be present in the Property Manager view.

For information on using this setting to set a default selection in the radio
button group, see the radio button’s Value setting.

Right-Aligned Basic MSI, InstallScript, The default value of False aligns the text to the left of the control. Set it to
InstallScript MSI, True to align the text to the right.
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, InstallScript, For English and other languages that are written from left to right, select
InstallScript MSI, False. For Hebrew and those languages that are read from right to left,
InstallScript Object, select True.
Merge Module

Sunken Basic MSI, InstallScript, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript MSI, select True. To use the default visual style for the control, select False.
InstallScript Object,
Merge Module

Tab Index Basic MSI, InstallScript, Assign an integer that—along with the other controls on this dialog but
InstallScript MSI, excluding controls such as static text—specifies the order in which each
InstallScript Object, control on the dialog receives focus when the end user presses the TAB
Merge Module key. The lowest tab index that you can use is the number 0.

InstallShield 2020 User Guide ISP-2600-UG00 1097

Chapter 4
Defining the End-User Interface

Table 4-27 • Settings for a Radio Button Group Control (cont.)

Setting Project Type Description

Tab Stop Basic MSI, InstallScript, Indicate whether this control receives focus within the tab order. True
InstallScript MSI, indicates that the control receives focus; False indicates that the control
InstallScript Object, does not receive focus.
Merge Module

Text Basic MSI, Merge This setting contains the text that is used for the radio button group’s
Module label.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

This setting has no effect on a radio button group with an image for a
label.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays
the font that is contained in the DefaultUIFont property.

This setting has no effect on a radio button group with an image for a
label.

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Basic MSI, InstallScript, Specify the distance from the top of the dialog to the top of the control in
InstallScript MSI, installer units (1/12 of the height of the system font).
InstallScript Object,
Merge Module

Visible Basic MSI, InstallScript, True means that the control is visible, and False means that it is hidden.
InstallScript MSI, You can also make the control visible by editing its condition in the
InstallScript Object, Behavior area for the dialog.
Merge Module

Width Basic MSI, InstallScript, For Basic MSI and Merge Module projects: Specify the width of the control
InstallScript MSI, in Windows Installer user interface units (1/12 of the height of the system
InstallScript Object, font).
Merge Module
For InstallScript, InstallScript MSI, and InstallScript Object projects:
Specify the width of the control in dialog units.

1098 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Dialog Controls

Scrollable Text Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• Merge Module

A scrollable text control displays a long string of text that cannot fit on the dialog; the control includes scroll bars that
enable end users to scroll through the text. The LicenseAgreement dialog is an example of a dialog that typically contains a
scrollable text control.

When you select a scrollable text control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Note • Unlike the text values for most controls, Windows Installer does not resolve property names or other values within the
Scrollable Text control. As a result, the text in the file is displayed exactly as it is written.

Table 4-28 • Settings for a Scrollable Text Control

Setting Description

Name Enter a name for this scrollable text control. The name must be unique among all
of the controls in your project.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True.
Clicking the cancel control has the same effect as pressing the ESC key or clicking
the Close button on the title bar. The Cancel or Finish button is usually the cancel
control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog
that contains this control.

Context Help This setting is reserved for future use. Windows Installer does not currently
support launching context-sensitive help topics from the installation.

Default If this is the only control on the dialog that you want to be the default control,
which means that it is activated when the end user presses the ENTER key, select
True. The Next or OK button is usually the default control.

Enabled Indicate whether the control is enabled. True means that this control is available
(the end user can interact with it). False means that it is not available (grayed out).

InstallShield 2020 User Guide ISP-2600-UG00 1099

Chapter 4
Defining the End-User Interface

Table 4-28 • Settings for a Scrollable Text Control (cont.)

Setting Description

File Name Enter the path to and the name of the .rtf file that you want to use for this control,
or click the ellipsis button (...) in this setting to browse to it. InstallShield adds the
file to your release at build time. The file must be stored as a binary resource in
the installation.

Height Specify the height of the control in Windows Installer user interface units (1/12 of
the height of the system font).

Left Specify the distance from the left edge of the dialog to the start of the control in
installer units (1/12 of the height of the system font).

Left Scrollbar If you want the arrow and vertical scrollbar to be displayed on the left side of the
control, select True. This option should be selected only when True is selected for
the Right-to-Left setting.

Right-Aligned The default value of False aligns the text to the left of the control. Set it to True to
align the text to the right.

Right-to-Left For English and other languages that are written from left to right, select False.
For Hebrew and those languages that are read from right to left, select True.

Sunken To give the control’s edges a recessed, three-dimensional appearance, select

True. To use the default visual style for the control, select False.

Tab Index Assign an integer that—along with the other controls on this dialog but excluding
controls such as static text—specifies the order in which each control on the
dialog receives focus when the end user presses the TAB key. The lowest tab index
that you can use is the number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates
that the control receives focus; False indicates that the control does not receive
focus.

Tooltip Enter the text that you want to be displayed when the end user places the mouse
pointer over the control.

When you type a value for this setting, you are creating a string entry and setting
its initial value for all of the languages that are currently in the project. As an
alternative to typing a new value, you can click the ellipsis button (...) in this
setting to select an existing string. For more information, see Using String Entries
in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer
units (1/12 of the height of the system font).

1100 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-28 • Settings for a Scrollable Text Control (cont.)

Setting Description

Visible True means that the control is visible, and False means that it is hidden. You can
also make the control visible by editing its condition in the Behavior area for the
dialog.

Width Specify the width of the control in Windows Installer user interface units (1/12 of
the height of the system font).

See Also
Dialog Controls

Selection Tree Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

A selection tree is a special control that lets end users change the selection state of your features, like in the CustomSetup
dialog.

When you select a selection tree control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Table 4-29 • Settings for a Selection Tree Control

Setting Project Type Description

Name Basic MSI, Enter a name for this selection tree. The name must be unique among all of
InstallScript, the controls in your project.
InstallScript MSI,
InstallScript Object,
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the control’s label if you specify nothing for the
Module Text Style setting.

InstallShield 2020 User Guide ISP-2600-UG00 1101

Chapter 4
Defining the End-User Interface

Table 4-29 • Settings for a Selection Tree Control (cont.)

Setting Project Type Description

Cancel Basic MSI, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript, True. Clicking the cancel control has the same effect as pressing the ESC key
InstallScript MSI, or clicking the Close button on the title bar. The Cancel or Finish button is
InstallScript Object, usually the cancel control.
Merge Module
This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not currently
Module support launching context-sensitive help topics from the installation.

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in Visual
InstallScript Object C++. You should not change the control identifiers for any of the controls
that are included with a dialog by default.

Default Basic MSI, If this is the only control on the dialog that you want to be the default
InstallScript, control, which means that it is activated when the end user presses the
InstallScript MSI, ENTER key, select True. The Next or OK button is usually the default control.
InstallScript Object,
Merge Module

Enabled Basic MSI, Indicate whether the control is enabled. True means that this control is
InstallScript, available (the end user can interact with it). False means that it is not
InstallScript MSI, available (grayed out).
InstallScript Object,
Merge Module

Height Basic MSI, For Basic MSI and Merge Module projects: Specify the height of the control in
InstallScript, Windows Installer user interface units (1/12 of the height of the system font).
InstallScript MSI,
For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify
InstallScript Object,
the height of the control in dialog units.
Merge Module

Indirect Basic MSI, If the property that is associated with this control is referenced indirectly,
Property InstallScript, select True; otherwise, select False.
InstallScript MSI,
When True is selected for an indirect property is set to True, Windows
InstallScript Object,
Installer resolves the referenced property at run time. For example, this
Merge Module
check box might use the property _BROWSE, whose value is INSTALLDIR. If
you select True for the Indirect Property setting, the value of _BROWSE will be
the current value of the INSTALLDIR property. If you select False for the
Indirect Property setting, the value of _BROWSE will contain the string
INSTALLDIR.

1102 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-29 • Settings for a Selection Tree Control (cont.)

Setting Project Type Description

Left Basic MSI, Specify the distance from the left edge of the dialog to the start of the
InstallScript, control in installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Left Scrollbar Basic MSI, If you want the arrow and vertical scrollbar to be displayed on the left side of
InstallScript, the control, select True. This option should be selected only when True is
InstallScript MSI, selected for the Right-to-Left setting.
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog box.
Styles InstallScript MSI,
InstallScript Object

Property Basic MSI, Merge Enter the name of a property for the selection tree. The end user can set the
Module property in a browse dialog (a dialog that uses a path edit, directory combo,
and directory list control).

Right-Aligned Basic MSI, The default value of False aligns the text to the left of the control. Set it to
InstallScript, True to align the text to the right.
InstallScript MSI,
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, For English and other languages that are written from left to right, select
InstallScript, False. For Hebrew and those languages that are read from right to left, select
InstallScript MSI, True.
InstallScript Object,
Merge Module

Sunken Basic MSI, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript, select True. To use the default visual style for the control, select False.
InstallScript MSI,
InstallScript Object,
Merge Module

Tab Index Basic MSI, Assign an integer that—along with the other controls on this dialog but
InstallScript, excluding controls such as static text—specifies the order in which each
InstallScript MSI, control on the dialog receives focus when the end user presses the TAB key.
InstallScript Object, The lowest tab index that you can use is the number 0.
Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1103

Chapter 4
Defining the End-User Interface

Table 4-29 • Settings for a Selection Tree Control (cont.)

Setting Project Type Description

Tab Stop Basic MSI, Indicate whether this control receives focus within the tab order. True
InstallScript, indicates that the control receives focus; False indicates that the control
InstallScript MSI, does not receive focus.
InstallScript Object,
Merge Module

Text Basic MSI, Merge This setting contains the text that is used for screen readers.
Module
When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more information,
see Using String Entries in InstallShield.

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays the
font that is contained in the DefaultUIFont property.

This setting is enabled if Text is selected for the Control Style setting.

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more information,
see Using String Entries in InstallShield.

Top Basic MSI, Specify the distance from the top of the dialog to the top of the control in
InstallScript, installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Visible Basic MSI, True means that the control is visible, and False means that it is hidden. You
InstallScript, can also make the control visible by editing its condition in the Behavior
InstallScript MSI, area for the dialog.
InstallScript Object,
Merge Module

Width Basic MSI, For Basic MSI and Merge Module projects: Specify the width of the control in
InstallScript, Windows Installer user interface units (1/12 of the height of the system font).
InstallScript MSI,
For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify
InstallScript Object,
the width of the control in dialog units.
Merge Module

1104 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Dialog Controls

Text Area Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

A text area control displays text.

When you select a text area control in a dialog of the Dialogs view, InstallShield displays the following settings in the right
pane.

Table 4-30 • Settings for a Text Area Control

Setting Project Type Description

Name Basic MSI, Enter a name for this text area. The name must be unique among all of the
InstallScript, controls in your project.
InstallScript MSI,
InstallScript Object,
Merge Module

Base Text Style Basic MSI, Merge This font style is used for the text if you specify nothing for the Text Style
Module setting.

Cancel Basic MSI, If this is the only control on the dialog that will dismiss the dialog, select
InstallScript, True. Clicking the cancel control has the same effect as pressing the ESC
InstallScript MSI, key or clicking the Close button on the title bar. The Cancel or Finish button
InstallScript Object, is usually the cancel control.
Merge Module
This value is ignored if True is selected for the ErrorDialog setting of the
dialog that contains this control.

Code Page Basic MSI, Merge If you want the control to use fonts from the code page that is defined in the
Module installation’s package, select Database. If you want the control to use fonts
from the target system’s default code page, select User’s System.

Context Help Basic MSI, Merge This setting is reserved for future use. Windows Installer does not currently
Module support launching context-sensitive help topics from the installation.

InstallShield 2020 User Guide ISP-2600-UG00 1105

Chapter 4
Defining the End-User Interface

Table 4-30 • Settings for a Text Area Control (cont.)

Setting Project Type Description

Control InstallScript, This setting contains a numeric identifier for the control that is unique
Identifier InstallScript MSI, within the dialog. This identifier is the same as a resource identifier in Visual
InstallScript Object C++. You should not change the control identifiers for any of the controls
that are included with a dialog by default.

Default Basic MSI, If this is the only control on the dialog that you want to be the default
InstallScript, control, which means that it is activated when the end user presses the
InstallScript MSI, ENTER key, select True. The Next or OK button is usually the default control.
InstallScript Object,
Merge Module

Enabled Basic MSI, Indicate whether the control is enabled. True means that this control is
InstallScript, available (the end user can interact with it). False means that it is not
InstallScript MSI, available (grayed out).
InstallScript Object,
Merge Module

Format as Bytes Basic MSI, Merge If you want the installation to attempt to display the value that is entered in
Module the Text setting in bytes, select True. If you select True, the Text setting
must contain only a number, without the unit. Then, at run time, it is
divided by 512 and displayed as the correct number of kilobytes,
megabytes, or gigabytes, depending on the size.

Height Basic MSI, For Basic MSI and Merge Module projects: Specify the height of the control
InstallScript, in Windows Installer user interface units (1/12 of the height of the system
InstallScript MSI, font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify
Merge Module
the height of the control in dialog units.

Left Basic MSI, Specify the distance from the left edge of the dialog to the start of the
InstallScript, control in installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Other Window InstallScript, Click the ellipsis button (...) to display the Other Window Styles dialog box.
Styles InstallScript MSI,
InstallScript Object

No Prefix Basic MSI, If the Text setting contains an ampersand that should be displayed as an
InstallScript, ampersand character (&), select True.
InstallScript MSI,
If you are using the ampersand in the Text setting to indicate that the letter
InstallScript Object,
that follows the ampersand should be underlined (for example, &Click
Merge Module
would be displayed as Click), select False.

1106 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-30 • Settings for a Text Area Control (cont.)

Setting Project Type Description

No Text Wrap Basic MSI, Indicate whether you want to allow the text to wrap in this control. If you
InstallScript, select True and the text expands beyond the width of the text area, the end
InstallScript MSI, of the string is cut off and replaced with an ellipsis button (...). Otherwise,
InstallScript Object, the text wraps and can extend beyond the height of the text area, if it is not
Merge Module long enough.

Property Basic MSI, Merge Enter the name of a property that can supply the initial value for the text.
Module This property can be unique to this control; it does not need to be present in
the Property Manager view.

Right-Aligned Basic MSI, The default value of False aligns the text to the left of the control. Set it to
InstallScript, True to align the text to the right.
InstallScript MSI,
InstallScript Object,
Merge Module

Right-to-Left Basic MSI, For English and other languages that are written from left to right, select
InstallScript, False. For Hebrew and those languages that are read from right to left,
InstallScript MSI, select True.
InstallScript Object,
Merge Module

Sunken Basic MSI, To give the control’s edges a recessed, three-dimensional appearance,
InstallScript, select True. To use the default visual style for the control, select False.
InstallScript MSI,
InstallScript Object,
Merge Module

Tab Index Basic MSI, Assign an integer that—along with the other controls on this dialog but
InstallScript, excluding controls such as static text—specifies the order in which each
InstallScript MSI, control on the dialog receives focus when the end user presses the TAB key.
InstallScript Object, The lowest tab index that you can use is the number 0.
Merge Module

Tab Stop Basic MSI, Indicate whether this control receives focus within the tab order. True
InstallScript, indicates that the control receives focus; False indicates that the control
InstallScript MSI, does not receive focus.
InstallScript Object,
Merge Module

Text Basic MSI, This setting contains the text that is shown inside the control.
InstallScript,
When you type a value for this setting, you are creating a string entry and
InstallScript MSI,
setting its initial value for all of the languages that are currently in the
InstallScript Object,
project. As an alternative to typing a new value, you can click the ellipsis
Merge Module
button (...) in this setting to select an existing string. For more information,
see Using String Entries in InstallShield.

InstallShield 2020 User Guide ISP-2600-UG00 1107

Chapter 4
Defining the End-User Interface

Table 4-30 • Settings for a Text Area Control (cont.)

Setting Project Type Description

Text Style Basic MSI, Merge Select the font style, size, and color (if available) in which you want the
Module control’s label to be displayed. Leaving the value as <Default> displays the
font that is contained in the DefaultUIFont property.

This setting is enabled if Text is selected for the Control Style setting.

Tooltip Basic MSI, Merge Enter the text that you want to be displayed when the end user places the
Module mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and
setting its initial value for all of the languages that are currently in the
project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more information,
see Using String Entries in InstallShield.

Top Basic MSI, Specify the distance from the top of the dialog to the top of the control in
InstallScript, installer units (1/12 of the height of the system font).
InstallScript MSI,
InstallScript Object,
Merge Module

Transparent Basic MSI, If you want the background to show through this control, select True.
InstallScript,
Note that you may want to avoid making this control transparent if you are
InstallScript MSI,
placing it on top of a colored bitmap. The text may not be visible if end
InstallScript Object,
users change the color scheme of their display. For example, the text in this
Merge Module
control may become invisible if an end user sets the high-contrast
parameter for accessibility reasons.

Visible Basic MSI, True means that the control is visible, and False means that it is hidden. You
InstallScript, can also make the control visible by editing its condition in the Behavior
InstallScript MSI, area for the dialog.
InstallScript Object,
Merge Module

Width Basic MSI, For Basic MSI and Merge Module projects: Specify the width of the control in
InstallScript, Windows Installer user interface units (1/12 of the height of the system
InstallScript MSI, font).
InstallScript Object,
For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify
Merge Module
the width of the control in dialog units.

See Also
Dialog Controls

1108 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Volume Cost List Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• Merge Module

A volume cost list control displays the disk space requirements that are associated with each volume or drive.

The list has five possible columns. The headings for each column are configurable in the UIText table, which you can
access in the Direct Editor view. The UIText table identifies the values of string entries so that localized strings are
displayed at run time when appropriate. Following is a list of the keys in the UIText table for each column, along with their
default English values:

• VolumeCostVolume—Volume

• VolumeCostSize—Disk Size

• VolumeCostAvailable—Available

• VolumeCostRequired—Required

• VolumeCostDifference—Differences

When you select a volume list cost control in a dialog of the Dialogs view, InstallShield displays the following settings in the
right pane.

Table 4-31 • Settings for a Volume Cost List Control

Setting Description

Name Enter a name for this volume cost list. The name must be unique among all of the controls
in your project.

Available Col Width Specify the default width in installer units (1/12 of the height of the system font) for the
Available column. This column is hidden if the value is the number 0 or it is left blank.

Base Text Style This font style is used for the contents of the volume cost list if you specify nothing for the
Text Style setting.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True. Clicking the
cancel control has the same effect as pressing the ESC key or clicking the Close button on
the title bar. The Cancel or Finish button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog that
contains this control.

Context Help This setting is reserved for future use. Windows Installer does not currently support
launching context-sensitive help topics from the installation.

InstallShield 2020 User Guide ISP-2600-UG00 1109

Chapter 4
Defining the End-User Interface

Table 4-31 • Settings for a Volume Cost List Control (cont.)

Setting Description

Default If this is the only control on the dialog that you want to be the default control, which
means that it is activated when the end user presses the ENTER key, select True. The Next
or OK button is usually the default control.

Differences Col Width Specify the default width in installer units (1/12 of the height of the system font) for the
Differences column. This column is hidden if the value is the number 0 or it is left blank.

Disk Size Col Width Specify the default width in installer units (1/12 of the height of the system font) for the
Disk Size column. This column is hidden if the value is the number 0 or it is left blank.

Enabled Indicate whether the control is enabled. True means that this control is available (the end
user can interact with it). False means that it is not available (grayed out).

Height Specify the height of the control in Windows Installer user interface units (1/12 of the
height of the system font).

Left Specify the distance from the left edge of the dialog to the start of the control in installer
units (1/12 of the height of the system font).

Left Scrollbar If you want the arrow and vertical scrollbar to be displayed on the left side of the control,
select True. This option should be selected only when True is selected for the Right-to-Left
setting.

Required Col Width Specify the default width in installer units (1/12 of the height of the system font) for the
Required column. This column is hidden if the value is the number 0 or it is left blank.

Right-Aligned The default value of False aligns the text to the left of the control. Set it to True to align the
text to the right.

Right-to-Left For English and other languages that are written from left to right, select False. For
Hebrew and those languages that are read from right to left, select True.

Show CD-ROM To include CD-ROM volumes in the control, select True.

Show Fixed To include hard drives in the control, select True.

Show Floppy To include floppy drives in the control, select True.

Show RAMDisk To include RAM volumes in the control, select True.

Show Remote To include mapped network drives in the control, select True.

Show Removable To include removable drives in the control, select True.

Sunken To give the control’s edges a recessed, three-dimensional appearance, select True. To use
the default visual style for the control, select False.

1110 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-31 • Settings for a Volume Cost List Control (cont.)

Setting Description

Tab Index Assign an integer that—along with the other controls on this dialog but excluding controls
such as static text—specifies the order in which each control on the dialog receives focus
when the end user presses the TAB key. The lowest tab index that you can use is the
number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates that the
control receives focus; False indicates that the control does not receive focus.

Text This setting contains the text that is used for the control’s label. Although you cannot see
the label, it is available for screen readers.

When you type a value for this setting, you are creating a string entry and setting its initial
value for all of the languages that are currently in the project. As an alternative to typing a
new value, you can click the ellipsis button (...) in this setting to select an existing string.
For more information, see Using String Entries in InstallShield.

Text Style Select the font style, size, and color (if available) in which you want the control’s label to
be displayed. Leaving the value as <Default> displays the font that is contained in the
DefaultUIFont property.

This setting is enabled if Text is selected for the Control Style setting.

Tooltip Enter the text that you want to be displayed when the end user places the mouse pointer
over the control.

When you type a value for this setting, you are creating a string entry and setting its initial
value for all of the languages that are currently in the project. As an alternative to typing a
new value, you can click the ellipsis button (...) in this setting to select an existing string.
For more information, see Using String Entries in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer units (1/
12 of the height of the system font).

Visible True means that the control is visible, and False means that it is hidden. You can also
make the control visible by editing its condition in the Behavior area for the dialog.

Volume Col Width Specify the default width in installer units (1/12 of the height of the system font) for the
Volume column. This column is hidden if the value is the number 0 or it is left blank.

Width Specify the width of the control in Windows Installer user interface units (1/12 of the
height of the system font).

See Also
String Editor View
Dialog Controls

InstallShield 2020 User Guide ISP-2600-UG00 1111

Chapter 4
Defining the End-User Interface

Volume Select Combo Control

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• Merge Module

A volume select combo control enables the end user to select from an alphabetical list of volumes, or drives.

When you select a volume select combo control in a dialog of the Dialogs view, InstallShield displays the following settings
in the right pane.

Table 4-32 • Settings for a Volume Select Combo Control

Setting Description

Name Enter a name for this volume select combo. The name must be unique among all of the
controls in your project.

Base Text Style This font style is used for the control’s text if you specify nothing for the Text Style setting.

Cancel If this is the only control on the dialog that will dismiss the dialog, select True. Clicking the
cancel control has the same effect as pressing the ESC key or clicking the Close button on the
title bar. The Cancel or Finish button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog that contains
this control.

Context Help This setting is reserved for future use. Windows Installer does not currently support launching
context-sensitive help topics from the installation.

Default If this is the only control on the dialog that you want to be the default control, which means
that it is activated when the end user presses the ENTER key, select True. The Next or OK
button is usually the default control.

Enabled Indicate whether the control is enabled. True means that this control is available (the end user
can interact with it). False means that it is not available (grayed out).

Height Specify the height of the control in Windows Installer user interface units (1/12 of the height of
the system font).

Indirect Property If the property that is associated with this control is referenced indirectly, select True;
otherwise, select False.

When True is selected for an indirect property is set to True, Windows Installer resolves the
referenced property at run time. For example, this check box might use the property _BROWSE,
whose value is INSTALLDIR. If you select True for the Indirect Property setting, the value of
_BROWSE will be the current value of the INSTALLDIR property. If you select False for the Indirect
Property setting, the value of _BROWSE will contain the string INSTALLDIR.

1112 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-32 • Settings for a Volume Select Combo Control (cont.)

Setting Description

Left Specify the distance from the left edge of the dialog to the start of the control in installer units
(1/12 of the height of the system font).

Left Scrollbar If you want the arrow and vertical scrollbar to be displayed on the left side of the control,
select True. This option should be selected only when True is selected for the Right-to-Left
setting.

Property Enter the name of a property that is set when an end user selects a value from this control. This
control populates the first part of the path that is displayed in the directory list, so you must
use the same property for the volume select combo, the directory list, and path edit when
using them together in a browse dialog. This property can be unique to this control; it does not
need to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public property by giving it a
name that contains only uppercase letters, use the Property Manager view to add the public
property, and then assign to it the value of the default selection.

Right-Aligned The default value of False aligns the text to the left of the control. Set it to True to align the text
to the right.

Right-to-Left For English and other languages that are written from left to right, select False. For Hebrew
and those languages that are read from right to left, select True.

Show CD-ROM To include CD-ROM volumes in the control, select True.

Show Fixed To include hard drives in the control, select True.

Show Floppy To include floppy drives in the control, select True.

Show RAMDisk To include RAM volumes in the control, select True.

Show Remote To include mapped network drives in the control, select True.

Show Removable To include removable drives in the control, select True.

Sunken To give the control’s edges a recessed, three-dimensional appearance, select True. To use the
default visual style for the control, select False.

Tab Index Assign an integer that—along with the other controls on this dialog but excluding controls
such as static text—specifies the order in which each control on the dialog receives focus when
the end user presses the TAB key. The lowest tab index that you can use is the number 0.

Tab Stop Indicate whether this control receives focus within the tab order. True indicates that the
control receives focus; False indicates that the control does not receive focus.

InstallShield 2020 User Guide ISP-2600-UG00 1113

Chapter 4
Defining the End-User Interface

Table 4-32 • Settings for a Volume Select Combo Control (cont.)

Setting Description

Text This setting contains the text that is used in the control.

When you type a value for this setting, you are creating a string entry and setting its initial
value for all of the languages that are currently in the project. As an alternative to typing a new
value, you can click the ellipsis button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Text Style Select the font style, size, and color (if available) in which you want the control’s label to be
displayed. Leaving the value as <Default> displays the font that is contained in the
DefaultUIFont property.

This setting is enabled if Text is selected for the Control Style setting.

Tooltip Enter the text that you want to be displayed when the end user places the mouse pointer over
the control.

When you type a value for this setting, you are creating a string entry and setting its initial
value for all of the languages that are currently in the project. As an alternative to typing a new
value, you can click the ellipsis button (...) in this setting to select an existing string. For more
information, see Using String Entries in InstallShield.

Top Specify the distance from the top of the dialog to the top of the control in installer units (1/12
of the height of the system font).

Visible True means that the control is visible, and False means that it is hidden. You can also make the
control visible by editing its condition in the Behavior area for the dialog.

Width Specify the width of the control in Windows Installer user interface units (1/12 of the height of
the system font).

See Also
Dialog Controls

Copying and Pasting Controls

InstallShield 2020

In the Dialog Editor, you can copy and paste controls within a dialog or from one dialog to another by using standard
Windows keyboard shortcuts or context menus.

Task To copy a push button from one dialog to another:

1. Open the layout for the dialog that contains the button you want to copy.

2. Select the push button and press CTRL+C.

3. Open the second dialog in the Dialog Editor and press CTRL+V to paste the control in the dialog.

1114 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

The push button is pasted with the same relative size and position as the original. Its other properties are also identical to
the original’s. The copy of the push button is given a unique name based on the type of control it is. However, you must edit
the new control’s behavior, since that information is not copied over (Basic MSI projects).

Note • Radio button groups are a special case. When you copy the group, all of its radio buttons are copied for you. You
cannot copy a radio button by itself.

See Also
Editing Dialog Behavior in Basic MSI Projects

Cutting and Pasting Controls

InstallShield 2020

In the Dialog Editor, you can move a control from one dialog to another by using standard Windows keyboard shortcuts or
context menus.

Task To cut a control from one dialog and paste in another:

1. Right-click the control and click Cut, or press CTRL+X. A Delete Control dialog box opens to inform you that deleting
the control also deletes any associated conditions and actions.

2. Click Yes to continue cutting the control from the current dialog.

3. Open the second dialog in the Dialog Editor and press CTRL+V to paste the control in the dialog.

When you are done pasting the control into the new location, specify the control’s properties and behavior.

See Also
Dialogs View (Basic MSI and Other Windows Installer–Based Projects)
Dialogs View (InstallScript, InstallScript MSI, and InstallScript Object Projects)
Exporting a Dialog to an .isd File for Use in Other Projects
Importing Dialogs from an .isd File

Working with the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield 2020 User Guide ISP-2600-UG00 1115

Chapter 4
Defining the End-User Interface

This section of the documentation covers aspects of working with the wizard interface of Advanced UI and Suite/Advanced
UI projects. The elements of the wizard interface consist of wizard pages and secondary windows (also known as pop-up
windows). InstallShield lets you define and customize various styles, brushes, and control themes to make formatting the
wizard interface efficient. InstallShield also lets you add, modify, and delete wizard pages and secondary windows, and
schedule when each should be displayed.

Elements of the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

The following two screen shots show the basic elements of the wizard interface.

Figure 4-26: Sample Wizard Page in an Advanced UI or Suite/Advanced UI Installation

1116 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Figure 4-27: Sample Secondary Window in an Advanced UI and Suite/Advanced UI Installation

InstallShield lets you use your own wizard icon, header image, and wizard caption. InstallShield also lets you define and
customize styles, brushes, and more for the header, body, and navigation areas of the user interface of an Advanced UI or
Suite/Advanced UI project.

See Also
Wizard Interface View

Using Styles, Brushes, and Control Themes to Customize the Wizard

Interface
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield lets you define and customize various user interface–related styles, brushes, and control themes to easily
change the look and feel of the wizard interface without requiring you to manually edit each user interface element
individually. Using styles, brushes, and control themes helps to ensure that the wizard interface is formatted consistently
throughout the installation.

Styles for the Wizard Interface

InstallShield contains a number of built-in text styles that define text attributes such as color, size, and font name for the
text on the wizard UI. In addition, InstallShield contains one built-in font set, which is a collection of fonts (including
attributes such as font name, size, and weight). For each font in a font set, you can specify to which language the font is
applicable. This enables you to select a different font for each language that your project supports. Font sets work in

InstallShield 2020 User Guide ISP-2600-UG00 1117

Chapter 4
Defining the End-User Interface

conjunction with text styles. Text styles reference a font set but can optionally override various font attributes that are
defined at the font set level. You can modify any of the built-in text styles and font sets and create your own as needed. To
learn more, see:

• Defining a Custom Style for the Wizard Interface

• Applying a Text Style to Text in the Wizard Interface

Brushes for the Wizard Interface

InstallShield contains several built-in brushes. A brush specifies a solid color, a gradient, or an image for various elements
of the wizard interface, such as the background of wizard pages and controls. You can modify any of the built-in brushes
and create your own as needed. To learn more, see:

• Defining a Custom Brush for the Wizard Interface

• Specifying the Background Brush for the Header, Body, and Navigation Areas of the Wizard Interface

• Overriding the Default Background Brushes for a Wizard Page or Secondary Window

Control Themes for the Wizard Interface

InstallShield enables you to define themes for wizard interface controls. A control theme is a collection of colors for various
parts of controls—text color, background color, and border color—and for various states of controls—such as clicked and
hovered. You can specify the control theme that you want to use for the controls in your user interface by default. You can
also override the theme for specific controls on wizard pages and windows in your user interface. Control themes give
buttons and other items in your installation’s user interface a flat look (without the three-dimensional effects) that is
reminiscent of the style of Windows Store apps.

The following types of controls support the use of control themes:

• Buttons, including the navigation buttons

• Check boxes

• Radio buttons

• Command links

To learn more, see:

• Defining a Custom Control Theme for the Wizard Interface

• Applying a Theme to a Control in the Wizard Interface

Customizing the Look and Feel of the Wizard Interface

The Wizard Pages node in the Wizard Interface view lets you select default project-wide styles, brushes, and control
themes. The Wizard Pages node in this view also lets you override the default values for the wizard caption, wizard icon,
header image, and Navigation Bar Height and specify other project-wide UI-related default values.

Use page-specific and control-specific settings such as the Body Background setting that is available for specific wizard
pages, secondary windows, and wizard controls if you want to override a specific use of a style. For example, the Body
Background setting for the InstallationWelcome wizard page lets you override the project’s default background on just the
InstallationWelcome wizard page.

1118 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Wizard Interface View

Defining a Custom Style for the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield lets you add custom font sets and text styles to your project and then apply those font sets and text styles to
various wizard interface elements. The use of font sets and text styles is helpful for maintaining format consistency and for
applying text formatting changes to the wizard interface globally.

Task To define a custom style:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, right-click Styles and then click Add Font Set or Add Text Style.

A font set is a collection of fonts (including attributes such as font name, size, and weight). For each font in a font set,
you can specify to which language the font is applicable. This enables you to select a different font for each language
that your project supports.

Text styles reference a font set but can optionally override various font attributes that are defined at the font set level.

InstallShield adds a a new style under Styles. Rename the style as needed.

3. Select the style and then configure its settings in the right pane.

Once you have added a font set, you can select it for the Font List setting of any of the text styles that are defined in the
Wizard Interface view. If you later want to change the list of fonts that are used for text styles that are based on that font
set, select the font set and edit its settings.

Once you have added a text style, you can select it for various style-related settings in the Wizard Interface view. If you later
want to change the appearance of the wizard interface elements that use that style, select the style and edit the values for
its settings.

Changes that you make to a style affect all of the wizard interface elements that use that style.

See Also
Applying a Text Style to Text in the Wizard Interface
Using Styles, Brushes, and Control Themes to Customize the Wizard Interface
Wizard Interface View

InstallShield 2020 User Guide ISP-2600-UG00 1119

Chapter 4
Defining the End-User Interface

Applying a Text Style to Text in the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield enables you to apply text styles to various wizard interface elements. If you later want to change the
appearance of the wizard interface elements that use that text style, you can easily make changes to the text style, rather
than separately editing each element that uses the text style.

When you are applying a text style to text, you can apply it at the global level, or you can apply it at the individual wizard
page control level.

Task To apply a text style to text globally:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, click Wizard Pages. InstallShield displays the global wizard interface settings in the
right pane.

3. In the following settings, select the appropriate text styles:

• Header Text Style

• Navigation Text Style

InstallShield changes the text style of the applicable UI elements throughout the project.

Task To apply a text style to specific text:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, expand the Wizard Pages node or the Secondary Windows node, and find the
wizard page or window that contains the text to which you want to apply a style.

3. Select the control that contains the text to which you want to apply a style.

4. In the right pane, expand the Text Style setting, and use its subsettings to specify the appropriate text styles. For
more information, see the inline help that is displayed in the bottom right pane when you select these settings.

InstallShield changes the text style of the selected control.

1120 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Defining a Custom Style for the Wizard Interface
Using Styles, Brushes, and Control Themes to Customize the Wizard Interface
Wizard Interface View

Defining a Custom Brush for the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

A brush specifies a solid color, a gradient, or an image for various elements of the wizard interface, such as the background
of wizard pages and controls. InstallShield lets you add custom brushes to your project and then apply those brushes to
various wizard interface elements.

Task To define a custom brush:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, right-click Brushes and then click Add Brush. InstallShield adds a a new brush
under Brushes. Rename the brush as needed.

3. Select the brush and then configure its settings in the right pane.

Once you have added a brush, you can select it for various background-related settings in the Wizard Interface view. For
example, to specify the brush that you want to use by default for the background of the navigation area of the wizard
pages, use the Navigation Background setting.

See Also
Specifying the Background Brush for the Header, Body, and Navigation Areas of the Wizard Interface
Overriding the Default Background Brushes for a Wizard Page or Secondary Window
Using Styles, Brushes, and Control Themes to Customize the Wizard Interface
Wizard Interface View

Specifying the Background Brush for the Header, Body, and Navigation Areas of the Wizard
Interface
InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 1121

Chapter 4
Defining the End-User Interface

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

By default, InstallShield enables you to use different brushes for the header, body, and navigation areas of your wizard
pages. In some cases, though, you may want to use only one brush (for example, a single background image or a vertical
gradient) that spans all three of those areas. The following instructions explain how to customize using three different
brushes or one brush.

Tip • For information on defining brushes, see Defining a Custom Brush for the Wizard Interface.

Using Three Different Brushes for the Header, Body, and Navigation Areas

Task To use three different brushes for the header, body, and navigation areas:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, click Wizard Pages. The global wizard interface settings are available in the right
pane.

3. In the Default Body Background setting, select the brush that you want to use as the background for the body area of
the wizard interface.

4. In the Header Background setting, select the brush that you want to use as the background for the header area of the
wizard interface.

5. In the Navigation Background setting, select the brush that you want to use as the background for the navigation
area of the wizard interface.

Important • Note that if you select a brush in the aforementioned background settings, you should delete any value in the
Full Wizard Background setting. The wizard interface supports use of a single brush for the full wizard background, or
separate brushes for the header, body, and navigation areas; it does not support specification of brushes for all four of those
areas simultaneously.

Using One Brush that Spans the Header, Body, and Navigation Areas

Task To use a single brush for the header, body, and navigation areas:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, click Wizard Pages. The global wizard interface settings are available in the right
pane.

1122 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

3. In the Full Wizard Background setting, select the brush that you want to use as the background for the navigation,
body, and navigation areas of the wizard interface.

Important • Note that if you select a brush in the aforementioned setting, you should delete any values from the other
background settings: Default Body Background, Header Background, and Navigation Background. The wizard interface
supports use of a single brush for the full wizard background, or separate brushes for the header, body, and navigation areas;
it does not support specification of brushes for all four of those areas simultaneously.

See Also
Selecting the Format for the Wizard Interface
Defining a Custom Brush for the Wizard Interface
Overriding the Default Background Brushes for a Wizard Page or Secondary Window
Wizard Interface View

Overriding the Default Background Brushes for a Wizard Page or Secondary Window
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

In most cases, each wizard page and secondary window in the user interface of an Advanced UI or Suite/Advanced UI
project has the same background. In some cases, you may want to override the default background for a specific wizard
page or secondary window in your project. You can do so by selecting a different brush for the background of that wizard
page or window.

Task To apply a brush to a specific wizard page or secondary window:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, expand the Wizard Pages node or the Secondary Windows node, and then click the
wizard page or window to which you want to apply a brush. InstallShield displays the settings for the selected wizard
page or window in the right pane.

3. In the Body Background setting, select the brush that you want to use for the selected wizard page or secondary
window.

InstallShield changes the background of the selected wizard page or secondary window.

InstallShield 2020 User Guide ISP-2600-UG00 1123

Chapter 4
Defining the End-User Interface

See Also
Selecting the Format for the Wizard Interface
Defining a Custom Brush for the Wizard Interface
Specifying the Background Brush for the Header, Body, and Navigation Areas of the Wizard Interface
Wizard Interface View

Defining a Custom Control Theme for the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield enables you to define themes for wizard interface controls. A control theme is a collection of colors for various
parts of controls—text color, background color, and border color—and for various states of controls—such as clicked and
hovered. You can specify the control theme that you want to use for the controls in your user interface by default; this is
also the theme that is used for all of the navigation buttons (for example, Back buttons and Next buttons) in your user
interface. You can also override the theme for specific controls on wizard pages and windows in your user interface.
Control themes give buttons and other items in your installation’s user interface a flat look (without the three-dimensional
effects) that is reminiscent of the style of Windows Store apps.

The following types of controls support the use of control themes:

• Buttons, including the navigation buttons

• Check boxes

• Radio buttons

• Command links

Task To define a control theme:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, right-click Control Themes and then click Add Control Theme. InstallShield adds a
a new control theme under Control Themes. Rename the control theme as needed.

3. Select the control theme and then configure its settings in the right pane.

Once you have added a control theme, you can select it for various theme-related settings in the Wizard Interface view. If
you later want to change the appearance of controls that are based on that control theme, select the control theme and
edit its settings.

Changes that you make to a control theme affect all of the wizard interface elements that use that control theme.

1124 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Applying a Theme to a Control in the Wizard Interface
Wizard Interface View

Applying a Theme to a Control in the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield enables you to apply control themes to buttons, check boxes, radio buttons, and command links. If you later
want to change the appearance of the wizard interface elements that use a control theme, you can easily make changes to
the control theme, rather than separately editing each element that uses the control theme.

You can apply a control theme to a few individual controls and leave the remaining ones alone, or you can specify a global
theme for your project and override it for a few individual controls. Changing the theme at the global level does not change
the theme of the controls that have a per-control theme specified.

Note that you can apply control themes to navigation buttons at the global project level, but not at the individual control
level.

Task To apply a control theme to controls globally:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, click Wizard Pages. InstallShield displays the global wizard interface settings in the
right pane.

3. In the Default Control Theme setting, select the appropriate theme that you want to use by default for controls such
as buttons (including navigation buttons), check boxes, radio buttons, and command links.

InstallShield changes the theme of all of the controls that do not have a per-control theme selected.

Tip • If you want the installation to use user-chosen system colors for controls instead of the colors that are defined for a
particular control theme, select the (No Theme) option in the Default Control Theme setting.

InstallShield 2020 User Guide ISP-2600-UG00 1125

Chapter 4
Defining the End-User Interface

Task To apply a theme to a control, overriding the default theme selection:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, expand the Wizard Pages node or the Secondary Windows node, and find the
wizard page or window that contains the control (button, check box, radio button, or command link) to which you
want to apply a theme.

3. Select the control to which you want to apply a theme.

4. In the right pane, find the Control Theme setting, and select the theme that you want to use for the selected control.

InstallShield changes the theme of the selected control.

Tip • To avoid overriding the default control theme for a selected control, select the (No Theme) option in the Control Theme
setting, or leave this setting blank.

Selecting the Format for the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield lets you select from several different wizard formats for your installation’s wizard interface:

• Glass—The installation uses user-chosen system colors to display the caption bar, header, and navigation areas of the
wizard interface. It also uses the glass effect (translucency) that was introduced in Windows Vista for these same areas
of the wizard interface. Note that with this format, the installation ignores any brushes that you have defined for the
caption bar, header, and navigation areas of your wizard interface.

Note that some operating systems do not fully support this format. Thus, in some cases, the installation may use the
Wizard 97 format instead of the Glass format.

This is the default option.

• Aero—This format typically has the same look and feel as the Glass format.

Note that some operating systems do not fully support this format. Thus, in some cases, the installation may use the
Wizard 97 format instead of the Aero format.

• Wizard 97—This format is the traditional wizard format. The installation uses the brushes that you have defined for
the various areas of your wizard interface.

1126 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• Wizard Lite—This format is similar to the Wizard 97 format, except that it does not include a header (the area that
shows the title, plus sometimes an image near the upper corner of the wizard page). The installation uses the brushes
that you have defined for the other areas of your wizard interface.

Note that in some scenarios, an installation uses the Wizard 97 format instead of the Glass or Aero formats:

• Windows 8 and Windows Server 2012 systems do not have translucency support. On these systems, a Glass-formatted
wizard interface uses the Wizard 97 format. However, an Aero-formatted wizard interface uses Aero, but without the
glass effect.

• Windows 7, Windows Vista, Windows Server 2008 R2, and Windows Server 2008 have translucency support that end
users can enable or disable. On these systems, Glass-formatted wizard interfaces and Aero-formatted wizard
interfaces use the Wizard 97 format if translucency is disabled. These wizard interfaces also use the Wizard 97 format if
the desktop composition feature on the target system is disabled.

• On Windows XP and Windows Server 2003, Glass-formatted wizard interfaces and Aero-formatted wizard interfaces
use the Wizard 97 format.

Note that the wizard interface editor in the Wizard Interface view in InstallShield does not use the Glass format or the Aero
format to show editable previews of the interface. If you select either of these formats for your Advanced UI or Suite/
Advanced UI project, the wizard interface editor uses the Wizard 97 format to show editable previews.

Task To select the format that you want to use for wizard pages in your wizard interface:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, click Wizard Pages.

3. In the right pane, find the Wizard Format setting and select the appropriate option.

Creating a New Blank Wizard Page in an Advanced UI or Suite/Advanced UI

Project
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield enables you to add a new blank wizard page to your project.

InstallShield 2020 User Guide ISP-2600-UG00 1127

Chapter 4
Defining the End-User Interface

Task To create a new blank wizard page in an Advanced UI or Suite/Advanced UI project:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, right-click Wizard Pages and then click Add Blank Page.

InstallShield adds a a new wizard page under Wizard Pages. Rename the wizard page as needed. Configure its settings in
the right pane, and use the center pane to preview it and modify its layout.

See Also
Sequencing Wizard Pages
Wizard Interface View

Adding a Predefined Wizard Page in an Advanced UI or Suite/Advanced UI

Project
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield enables you to add various predefined wizard pages to your Advanced UI or Suite/Advanced UI project.
Examples include:

• A page that allows end users choose the installation directory for an .msi package

• A page that lets end users enter customer information and serial numbers

• A page that shows a feature tree, as well as feature descriptions and sizes, and allows end users to select which
features to install

• A database login page that allows end users to enter database server login information (database server name,
authentication credentials, database catalog name, etc.) in order to establish a connection to the database server that
is targeted by one or more .msi packages in the suite

Task To add a predefined wizard page in an Advanced UI or Suite/Advanced UI project:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, right-click Wizard Pages and then click Add Predefined Page. The User Interface
Wizard opens.

3. Complete the panels in the wizard as needed.

1128 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

InstallShield adds the new predefined page to your project. Configure its settings in the right pane, and use the center pane
to preview it and modify its layout.

Note • When you add the browse-for-installation-folder type of wizard page (called BrowseFolder) to your project,
InstallShield adds a placeholder image control to it so that you can display a lock image on the page. Ensure that you either
configure the control’s Resource setting to indicate the file that you want to display with this control, or, to exclude an image,
delete the image control.

See Also
Sequencing Wizard Pages
User Interface Wizard
Wizard Interface View

Creating a New Blank Secondary Window in an Advanced UI or Suite/

Advanced UI Project
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield enables you to add a new blank secondary window to your project.

Task To create a new blank secondary window in an Advanced UI or Suite/Advanced UI project:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, right-click Secondary Windows and then click Add Blank Window.

InstallShield adds a new window at the end of the list of secondary windows. Rename the window as needed. Configure its
settings in the right pane, and use the center pane to preview it and modify its layout.

See Also
Wizard Interface View

InstallShield 2020 User Guide ISP-2600-UG00 1129

Chapter 4
Defining the End-User Interface

Sequencing Wizard Pages

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

Use the Wizard Interface view to indicate the order in which your Advanced UI or Suite/Advanced UI installation should
display the wizard pages at run time. The wizard pages are listed under the Wizard Pages node in this view in the order that
the installation displays them at run time.

Task To resequence a wizard page in your project:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, under the Wizard Pages node, right-click the wizard page whose order you want to
change, and then click Move Up or Move Down.

InstallShield moves the wizard page up or down in the list.

Editing the Layout and Behavior of a Wizard Page or Secondary Window

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

Use the Wizard Interface view to edit the layout and behavior of wizard pages and secondary windows in your installation.

1130 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Defining a Custom Style for the Wizard Interface
Adding a Control to a Wizard Page or Secondary Window
Changing the Tab Order of Controls on a Wizard Page or Secondary Window
Populating Combo Box and List Box Controls in the Wizard Interface
Configuring an Action for an Element in the Wizard Interface
Wizard Interface View

Adding a Control to a Wizard Page or Secondary Window

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

If you select a wizard page or secondary window in the Wizard Interface view, the toolbar that InstallShield shows directly
above the wizard interface preview pane includes several different buttons and other controls that let you add new
controls.

Task To add a control to the wizard interface:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, click the wizard page or secondary window that you want to modify. The wizard
editor in the center pane shows the page or secondary window.

3. In the toolbar above the wizard interface preview pane, click the appropriate New Control button (the Label, Text Box,
Button, or Combo Box button), or select one of the control types that are listed in the drop-down list next to the
control buttons. For information about each of the available types of controls, see Wizard Interface View Toolbar.

InstallShield adds the control near the upper-left corner of the body area of the page or secondary window. In
addition, InstallShield adds a subnode for the control under the selected wizard page or window.

4. Place the cursor in the middle of the control, and then drag it to move it to the appropriate location.

5. In the right pane, configure the control’s settings.

Tip • The order in which the controls are listed under the a wizard page’s node matches the tab order.

If you are using more than one group of radio button controls on a page, ensure that the Style setting includes WS_GROUP for
the first radio button of each group.

InstallShield 2020 User Guide ISP-2600-UG00 1131

Chapter 4
Defining the End-User Interface

See Also
Wizard Interface View Toolbar
Wizard Interface View

Available Controls for a Wizard Page or Secondary Window

Following is a list of the types of controls that you can use on a wizard page or secondary window.

Table 4-33 • Controls for a Wizard Page or Secondary Window

Control Description

Billboard A billboard control is used to display data that can be updated in response to control
events. You can use a billboard, for example, to display the progress of a protracted
custom action.

Button

Check List

Circular Progress Bar

Combo Box

Command Link Button

Feature Selection Tree

Frame

Group Box

Hyperlink

Image

Image Button

Label

List Box

Password

Progress Bar

Radio Button

1132 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-33 • Controls for a Wizard Page or Secondary Window (cont.)

Control Description

Rich Text Box

Text Box

Tree View

Changing the Tab Order of Controls on a Wizard Page or Secondary Window

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

In most cases, end users can use the TAB key to move the focus from one control on a wizard page or window to another.
By default, the tab order is the order in which the controls were added to the wizard page or window.

Task To change the tab order of the controls on a wizard page or window:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, expand the node of the wizard page or secondary window whose tab order you want
to modify.

Each control on the page or window has its own subnode. The controls are listed in tab order. That is, the first control
under a page node is the first control that receives focus on that page.

3. Right-click the control that you want to resequence in the tab order, and then click Move Up or Move Down.

4. Continue moving the controls as needed until the order that the controls are listed under the page reflects the
appropriate tab order.

Note that in some cases, a control may not be included in the tab order. For example, a disabled control would not receive
focus as an end user tabs from one control to another control.

See Also
Wizard Interface View

InstallShield 2020 User Guide ISP-2600-UG00 1133

Chapter 4
Defining the End-User Interface

Designating Keyboard Shortcuts and Using Ampersands (&) in the Wizard Interface
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

In wizard interface strings, an ampersand (&) is a special character that sometimes designates a keyboard shortcut, but
other times indicates that a literal ampersand should be displayed. For button, check box, and radio button controls, a
single ampersand always designates the keyboard shortcut that is used to click or select the control; a double ampersand
(&&) indicates that a single ampersand should be displayed. For label controls, the interpretation of an ampersand
depends on the style of the label control in which the ampersand is used.

Table 4-34 • Using Ampersands in Label Controls of the Wizard Interface

Status of SS_NOPREFIX String That Is

Sample String Entry in the Style Setting of Displayed in the
for a Label Control the Control Wizard Interface Notes

Enter your &serial SS_NOPREFIX = False Enter your serial When an end user presses the ALT key, the
number for New && number for New & “s” in the string is underlined. The
Improved Product Improved Product keyboard shortcut of ALT+s moves the
focus to the control that appears directly
after this label in the tab order.

The double ampersand between “New”

and “Improved” indicates that a single
ampersand should be displayed.

Enter your serial SS_NOPREFIX = True Enter your serial The True value for the SS_NOPREFIX
number for New & number for New & constant prevents any ampersands in the
Improved Product Improved Product control’s string from being used to
designate a keyboard shortcut.

By default, when you add a new label control to your wizard interface, the SS_NOPREFIX subsetting under the label
control’s Style setting is set to False. You can change this value as needed.

If your wizard interface includes a label control that should never contain a keyboard shortcut, consider selecting True for
the SS_NOPREFIX subsetting of that control. This ensures that any ampersands that are included in the string entries for
such controls are not inadvertently interpreted as keyboard shortcuts.

1134 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

If your product name includes an ampersand, you may want to use two separate product name properties in your wizard
interface—one property whose value uses a single ampersand, and one property whose value uses the escaped ampersand
(a double ampersand). Depending on the type and style of each control that contains the product name, you would use the
appropriate product name property as needed—for example:

Table 4-35 • Sample Usage of Two Different Properties for a String that Includes an Ampersand

Property Property Value Examples of Uses for This Property

[ProductName] New & Improved • Label controls in which SS_NOPREFIX = True

Product
• Wizard Caption setting on the Wizard Pages node—This
value is used as the caption in the caption bar of wizard
pages. The default value of this setting is:

[ProductName] - InstallShield Wizard

• Title setting for a wizard page—The title text is displayed in

the header area of wizard pages.

[EscapedProductName] New && Improved • Label controls in which SS_NOPREFIX = False

Product
• Controls such as check boxes, command links, and radio
buttons, which do not support the SS_NOPREFIX style
setting and always interpret single ampersands as being
used to designate keyboard shortcuts

See Also
Changing the Tab Order of Controls on a Wizard Page or Secondary Window

Using Navigation Buttons on Wizard Pages

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield 2020 User Guide ISP-2600-UG00 1135

Chapter 4
Defining the End-User Interface

Each wizard page in an Advanced UI or Suite/Advanced UI project can have one or more of the following built-in navigation
buttons:

Table 4-36 • Built-In Navigation Buttons for Wizard Pages

Button Description of Default Behavior

Next Move to the next wizard page in the interface, skipping any pages whose Visible conditions
evaluate to false.

Clicking this button has no effect if the current wizard page is the last page in the interface.

The Next navigation button behaves similarly to controls that use a Set Active Page action, which
triggers a move to a specific page.

Back Move to the previous wizard page in the interface, skipping any pages whose Visible conditions
evaluate to false.

Clicking this button has no effect if the current wizard page is the first page in the interface.

The Back navigation button behaves similarly to controls that use a Set Active Page action, which
triggers a move to a specific page.

Cancel Display a message box with question IDS_SUITE_CONFIRMCANCEL; on Yes, cancel the wizard and
move to the last wizard page.

In most cases, the last wizard page should not show a Cancel button, since cancelling the
installation at that point does not have any effect. If a Cancel button is displayed, clicking it would
result in closing the wizard.

Install Start the installation and move to the next wizard page.

The Install navigation button behaves similarly to controls that use an Install action, which start
the installation and then move to a specific wizard page.

Finish After a successful installation or maintenance, if a restart is required, ask whether to restart
(message IDS_SUITE_ASKREBOOT), and then trigger the appropriate response. In either case
(required or not required, immediate restart or delayed restart), close the wizard.

Including a Navigation Button on or Excluding It from a Wizard Page

When you select a wizard page in the Wizard Interface view of an Advanced UI or Suite/Advanced UI project, the grid on the
right side of the view shows the settings for the selected page. The Navigation area settings let you configure the navigation
buttons for the page.

Task To include or exclude a navigation button:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, click the wizard page whose buttons you want to modify.

3. In the Navigation area of the grid on the right side of the view, do the following:

1136 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• To include a specific button on the wizard page, select Yes in that button’s setting, and then configure the
subsettings under that button’s setting as needed.

• To exclude a specific button from a wizard page, select No in that button’s setting, and then configure the
subsettings under that button’s setting as needed.

To learn about changing the default behavior of navigation buttons, see Overriding the Default Behavior of a Navigation
Button on a Wizard Page.

See Also
Wizard Interface View

Overriding the Default Behavior of a Navigation Button on a Wizard Page

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

If the Click event of a navigation button includes either a Set Active Page action or an Install action, and if that action moves
through the wizard interface, this prevents the default behavior described above. The default behavior is prevented even if
the scheduled action is skipped because of a false condition for the action.

For example, you may want to override the default behavior for the Install button: instead of moving to the next wizard
page in the interface, you may want the installation to proceed to a specific wizard page. In this scenario, you must add an
Install action to the Install button’s Click setting, and specify the specific subsequent page. If you then add a condition to
the action, and the condition prevents the Install action from running, the default behavior for the Install button is
suppressed. That is, the installation does not start when the end user clicks the Install button. (Note that in this case, you
may want to define a condition for the navigation button’s Enabled setting to ensure that the Install button is disabled if
appropriate. Otherwise, end users may become confused when they are able to click an Install button that has no effect.)

Note that extension DLLs actions cannot prevent the default action except by actually calling the corresponding methods
on the ISuiteUIExtension interface. The Advanced UI or Suite/Advanced UI engine cannot determine whether the extension
chose to call the method. If you need an extension action to override the default behavior, but only navigate or install
under certain conditions, add a Set Active Page or Install action with a false condition such as the empty None group.

See Also
Using Navigation Buttons on Wizard Pages
Wizard Interface View

InstallShield 2020 User Guide ISP-2600-UG00 1137

Chapter 4
Defining the End-User Interface

Populating Combo Box and List Box Controls in the Wizard Interface
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield lets you add to the wizard interface one or more combo box controls and list box controls with predefined
selectable options. The process involves configuring the control’s settings to define the content for the selectable options.
The process also involves the use of two properties: one that defines the list of options that you want to display in the
control, and one that the installation uses to store the option that the end user selects at run time.

Task To populate a combo box control or a list box control with predefined options:

1. Associate the control with two properties: one that defines the list of options that you want to display in the control,
and one that the installation uses to store the option that the end user selects at run time:

a. In the View List under User Interface, click Wizard Interface.

b. In the Wizard Interface explorer, expand the wizard page or secondary window that you want to modify, and
then select the combo box control or list box control that you want to configure.

c. In the Property setting, enter the name of the Advanced UI or Suite/Advanced UI property—for example,
SELECTIONPROPERTY—that you want to associate with the control. At run time, the installation uses this property
to store the value that the end user selects.

d. In the Content Property setting, enter the name of the Advanced UI or Suite/Advanced UI property that you want
to use to identify the options that you want to list in this control—for example, CONTROLOPTIONS.

2. Define the list of options that you want to display in the combo box control or the list box control:

a. In the Content Property setting, click the ellipsis button (...). The Edit List Options dialog box opens.

b. In the Text column, enter one of the options that you want to display in the control.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the
languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis
button (...) in this setting to select an existing string. For more information, see Using String Entries in
InstallShield.

c. In the Value column, enter the value that you want to associate with the list option text that you entered in step
2b. This is the property value that is stored in SELECTIONPROPERTY—the property that you entered in step 1c—if
the end user selects the list option that you entered in the Text column.

d. To add additional text-value pairs, click the New button, and then complete the fields in the row that
InstallShield adds.

1138 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

For example, you might enter the following data:

Text Value

ID_Option1 Value1

ID_Option2 Value2

ID_Option3 Value3

e. Change the order of the list options if appropriate.

The installation displays the list options in the order that you list them on this dialog box. To change the order of
the list options, select a row, and then click the Up or Down buttons as needed. To select multiple consecutive
rows, click the first row, press and hold Shift, and then click the last row. To select multiple non-consecutive
rows, click one of the rows, press and hold down CTRL, and then click each additional row.

3. Click OK.

Specifying the Default Option for the Combo Box Control or the List Box Control
If you want to specify the default option for a combo box control or a list box control, use the Property Manager view to set
the value of the Advanced UI or Suite/Advanced UI property equal to the property value that corresponds with the default
selectable option. Thus, if you want ID_Option3 to be selected by default, add the SELECTIONPROPERTY property to the
Property Manager view, and set its value to Value3. To leave the control blank by default, do not define the property in the
Property Manager view.

Using the Proper Syntax for Identifying the Control Options Through a Property Value
In the first step in the aforementioned procedure, it is necessary to create a new Advanced UI or Suite/Advanced UI
property, and to set its value to the options that you want to be listed in the combo box control or the list box control. It is
also necessary to associate each option with a corresponding value. The following format is used:

ID_Option1\rValue1\nID_Option2\rValue2\nID_Option3\rValue3

ID_Option1 corresponds with Value1, ID_Option2 corresponds with Value2, and ID_Option3 corresponds with Value3.

ID_Option1, ID_Option2, and ID_Option3 represent string identifiers that are defined in the String Editor view. The strings
that are associated with those string identifiers indicate the selectable options that you want to be displayed in the control;
the order in which you specify these options is the same order that the installation uses to list the options in the control at
run time.

\r is the separator between the name of each selectable option and the corresponding property value that you want to
associate with it.

Value1, Value2, and Value3 are the possible property values that you want to be stored in SELECTIONPROPERTY—the
property that you entered in step 4.

Thus, if the end user selects ID_Option2 in the control, the installation sets the value of SELECTIONPROPERTY as Value2.

\n is the separator between a value and the next selectable option.

Note that there are no spaces before or after the separators (\r or \n).

InstallShield 2020 User Guide ISP-2600-UG00 1139

Chapter 4
Defining the End-User Interface

Working with End-User Data from a Combo Box Control or a List Box Control
At run time, end users can make a single selection from the combo box or the list box; this sets the control’s property
(which is SELECTIONPROPERTY in the aforementioned procedure) to the value that is associated with the selected option—
for example, Value1, Value2, or Value3. You can trigger different types of behavior based on the value of the
SELECTIONPROPERTY property. Examples are:

• You can enable or disable a control on the wizard page or secondary window. To do this, use the control’s Enabled
setting to define a Property type of condition and tie the enabled state of the control to a particular value of the
property.

• You can display or hide a particular control on a wizard page or secondary window. To do this, use the control’s Visible
setting to define a Property type of condition and tie the enabled state of the control to a particular value of the
property.

• You can display or skip a particular wizard page or secondary window. To do this, use the wizard page’s or secondary
window’s Visible setting to define a Property type of condition and tie the enabled state of the wizard interface to a
particular value of the property.

• You can use the value of the Advanced UI or Suite/Advanced UI property to set a particular property in a package in the
Advanced UI or Suite/Advanced UI installation. To do this, use the command line and silent command line settings
that are available as subsettings in the Operation area of the grid in the Packages view. For more information, see
Using Advanced UI and Suite/Advanced UI Formatted Expressions to Dynamically Configure Command Lines.

See Also
Adding a Control to a Wizard Page or Secondary Window
Wizard Interface View

Configuring Validation for a Control on a Wizard Page or Window

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield lets you implement validation for some of the various wizard interface controls. For example:

• You can ensure that end users enter a serial number in a text box in a specified format.

• You can configure validation for a text box control to check whether the folder an end user specifies in the text box is
valid.

• You can prevent end users from selecting certain combinations of check boxes that do not work together.

1140 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Validation for a control checks the property that is associated with that control. When an end user clicks a check box, for
example, the associated property is potentially changed to one of two new values. Validation offers a method for checking
whether the new value is appropriate.

Various types of controls trigger validation at different events:

Table 4-37 • Triggers for Different Types of Validation

Types of Controls Event that Triggers Validation

Text box, Validation occurs when the entry in the control changes.
password box

Button, Validation occurs when the end user clicks the control.
command link,
check box,
radio button,
image button

Combo box, Validation occurs when the selection for the control changes.
list box,
checked list box,
feature selection tree

You can use the subsettings under the Text Style setting to specify different text styles for the control to give end users a
visual indication when the control is in various states (default, valid, or invalid).

You can also use the subsettings in the Events area to trigger an action when the end user clicks or uses the control. If you
have actions and validation configured for a control, the validation runs before the actions. For more information about
actions, see Configuring an Action for an Element in the Wizard Interface.

Task To configure validation for a control:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, select the wizard page or secondary window that you want to modify.

3. In the wizard editor, select the control that requires validation.

4. In the Validate setting, click the Validation button and then point to the type of validation that you want to occur.

One of the types of validation lets you call a function in a DLL file that you have created. If your project includes any
DLL files in the Support Files view, InstallShield makes them available in this list, and lets you overwrite the validation
function name with the function in the DLL that you want to call.

InstallShield 2020 User Guide ISP-2600-UG00 1141

Chapter 4
Defining the End-User Interface

The following table describes the types of validation that are available. Note that some types of validation are applicable to
only certain types of controls. For example, the value length validation is applicable only to the text box and password box
controls.

Table 4-38 • Types of Validation for Wizard Interface Controls

Type of Validation Description

Existing File This type of validation checks whether the value of the property that is
associated with this control contains the fully qualified path and name of a file
that is present. The end user typically sets the value of the property when
entering the path and file name in this control.

Existing Folder This type of validation checks whether the value of the property that is
associated with this control contains the fully qualified path and name of a
folder that is present. The end user typically sets the value of the property
when entering the path and folder name in this control.

New File in Existing Folder This type of validation checks whether the value of the property that is
associated with this control contains the fully qualified path and name of a file
that is not present. The end user typically sets the value of the property when
entering the path and file name in this control.

Note that the path for the file must exist for this type of validation.

Value Length This type of validation checks whether the value of the property that is
associated with this control contains a certain number of characters. The end
user typically sets the value of the property when entering text in this control.

To configure this type of validation, specify the minimum and maximum values
in the subsettings under this setting.

Value Mask This type of validation checks whether the value of the property that is
associated with this control matches a particular format. The end user typically
sets the value of the property when entering information such as a serial
number in this control.

To configure this type of validation, specify the required format in the Pattern
setting under this setting. Enter any of the following characters in place of a
digit:

# % @

Enter any of the following characters in place of a character:

& ^ ? ’

Any other characters that you enter must match exactly.

Browse for DLL Action This type of validation calls a function in a DLL file that you have created and
added to your project through the Support Files view. For example, you can use
a DLL file to check the validity of the property’s value—that is, the input that the
end user enters for the control.

1142 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Wizard Interface View

Configuring an Action for an Element in the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield lets you define actions that are launched when a wizard page or secondary window is opened or closed. This
capability enables your installation to perform any initialization such as dynamically retrieving values for a combo box. It
also lets you schedule actions to occur before the wizard interface is displayed at run time.

In addition, InstallShield lets you define actions that an end user triggers when using some of the various wizard interface
controls. For example, you can add a Print button to a LicenseAgreement wizard page, and define a print action for that
button control; when an end user clicks the Print button, the Print dialog box opens, enabling the end user to print the
license agreement.

If you have actions and validation configured for a control, the validation runs before the actions. The actions run for both
validation success and validation failure. They also run when the splash page is dismissed, when an image button gets or
loses focus, or when an end user scrolls to the bottom of a rich text box. For more information about validation, see
Configuring Validation for a Control on a Wizard Page or Window.

Task To configure an action for a wizard page, secondary window, or control:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, select the wizard page or secondary window that you want to modify.

3. Do one of the following if you are configuring an action for a control:

• To configure the action of one of the navigation controls (the Next, Back, Cancel, Install, or Finish buttons)—In the
right pane, expand the settings for the control whose action you want to modify.

• To configure the action of any of the other controls—In the wizard editor, select the control whose action you
want to modify.

4. Do one of the following:

• To schedule an action to run when the selected wizard page or window opens: In the Page Entered setting, point
to the New Action button, and then click the type of action that you want to configure.

• To schedule an action to run when the selected wizard page or window closes: In the Page Exited setting, point
to the New Action button, and then click the type of action that you want to configure.

InstallShield 2020 User Guide ISP-2600-UG00 1143

Chapter 4
Defining the End-User Interface

• To schedule an action for a control: In the Click setting, or in an action-related setting under the Events setting,
point to the New Action button, and then click the type of action that you want to configure.

5. Configure the subsettings under the action as needed.

If you enter more than one action statement, the actions are run in the order in which they are listed in the action setting.

One of the types of actions lets you call a function in a DLL file that you have created. If your project includes any DLL files in
the Support Files view, InstallShield makes them available in this list, and lets you overwrite the action function name with
the function in the DLL that you want to call.

The following table describes the types of actions that are available.

Table 4-39 • Control Actions

Type of Action Description

Set Property This type of action sets a specific property to a specific value.

Install This type of action starts the installation and moves to a specific wizard page.

Open This type of action opens a file or Web page.

Print This type of action launches the Print dialog box, enabling an end user to print
the specified file.

Browse for Folder This type of action launches the Browse for Folder dialog box when an end user
clicks the control.

When the end user selects a folder in this dialog box and clicks the OK button,
the dialog box closes, and the installation sets the value of a specific property
to the full path of the folder that the end user selected.

To configure this type of action, configure the subsettings under this action.

Browse for File This type of action launches the file browse dialog box when an end user clicks
the control.

When the end user selects a file in this dialog box and clicks the Open button,
the dialog box closes, and the installation sets the value of a specific property
to the full path and file name of the file that the end user selected.

To configure this type of action, configure the subsettings under this action.

Browse for New File This type of action launches the new-file browse dialog box when an end user
clicks the control. The dialog box lets the end user browse to a location where a
new file should be saved.

When the end user specifies a file in this dialog box and clicks the Save button,
the dialog box closes, and the installation sets the value of the property that
you have specify in the Property subsetting to the full path and file name of the
file that the end user specifies.

To configure this type of action, configure the subsettings under this action.

1144 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-39 • Control Actions (cont.)

Type of Action Description

Set Active Page This type of action moves to a specific wizard page.

Show Window This type of action shows a secondary window as a modal window.

Close Window This type of action closes a main wizard page or secondary window, or in some
cases, provides conditional closing of a secondary window.

Close Window accepts parameters corresponding to the following predefined

Return Code IDs: IDOK, IDCANCEL, IDABORT, IDRETRY, IDIGNORE, IDYES, IDNO,
and IDCLOSE.

The behavior of the Close Window action differs slightly on wizard pages and
secondary windows, as noted following:

• For wizard pages, the Close Window action prompts the end user to cancel
if its Return Code parameter is set to IDCANCEL (and then interrupts the
wizard if the end user specifies Yes). For all other Return Code IDs, the
wizard immediately closes.

• For secondary windows, the Close Window action closes the secondary
window and in special cases such as with the ISRMFilesInUse and
ISRMFileInUse secondary windows, the specified Return Code value is
returned.

InstallShield currently provides the following secondary windows that contain

customized behavior that is dependent upon the specified Return Code ID:

• ISDownloadProgress

• ISPromptForSourceMedia

• ISFilesInUse

• ISRMFilesInUse

• ISUpgradeParcel

• ISSQLBrowse

Stop Event This type of action allows you to conditionally stop further actions from being
processed. For example, this action can be used to prevent the default
behavior of a button from occurring.

Run a Suite Action

Project • This functionality is available in Suite/Advanced UI projects.

This type of action launches an action in the installation. The action can be any
of the ones that are defined in the Events view of the Suite/Advanced UI
project. For more information, see Using Actions to Extend the Behavior of a
Suite/Advanced UI Installation.

InstallShield 2020 User Guide ISP-2600-UG00 1145

Chapter 4
Defining the End-User Interface

Table 4-39 • Control Actions (cont.)

Type of Action Description

Load Web Deploy Publish Profile

Project • This functionality is available in Suite/Advanced UI projects.

This type of action launches a secondary window that lets end users browse to
and load a publisher profile file (.publishsettings) that contains the
configuration settings that they want to use for the Web Deploy package. For
more information, see Adding a Web Deploy Package to a Suite/Advanced UI
Project.

1146 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Table 4-39 • Control Actions (cont.)

Type of Action Description

Database

Project • This functionality is available in Suite/Advanced UI projects.

The following database-related options are available:

• Configure Database Metadata—Initializes the database metadata

(connection string, ODBC driver, timeout value, etc.) that will be used for
connecting to a database, and saves the name of the configuration in an
extension DLL for other actions to reference as the active configuration.

• Override SQL Login Properties—Defines Suite properties that will be

used to identify SQL login settings to establish a connection to a specified
database server. For example, when the Validate a Database Login action
is called, the Suite SQL runtime reads the value of the Suite properties
specified by the Override SQL Login Properties action to retrieve the SQL
login settings that are entered on a Suite UI wizard page and then
attempts to establish a connection to the specified database server.

• Browse for Database Catalogs—Retrieves the list of available database

catalogs and saves the result to a Suite property (ISSQLBrowseList). This
action uses metadata and properties identified by the Configure
Database Metadata and Override SQL Login Properties actions.

• Browse for Database Servers—Retrieves the list of available database

servers and saves the result to a Suite property ((ISSQLBrowseList). This
action uses metadata and properties identified by the Configure
Database Metadata and Override SQL Login Properties actions.

• Browse for Registered Database Servers—Retrieves a list of database

servers registered in ODBC DSN and saves the list to a Suite property
(ISSQLBrowseLocalList). This action uses metadata and properties
identified by the Configure Database Metadata and Override SQL Login
Properties actions.

• Validate a Database Login—Adds a Validate action to verify the database

login credentials using database metadata and properties identified by
Configure Database Metadata and Override SQL Login Properties.

• Run a SQL String—Executes a SQL statement using database metadata

and properties identified by Configure Database Metadata and Override
SQL Login Properties.

Browse for DLL Action This type of action calls a function in a DLL file that you have created and added
to your project through the Support Files view. For example, you can use a DLL
file to trigger custom behavior.

See Also
Wizard Interface View
Referring to Feature States and Other Feature Data in the UI of an Advanced UI or Suite/Advanced UI Project

InstallShield 2020 User Guide ISP-2600-UG00 1147

Chapter 4
Defining the End-User Interface

Using Images, Text Files, and Other Objects in the Wizard Interface
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

Any images, text files (such as End-User License Agreements), and other files that you want to use in the wizard interface of
your Advanced UI or Suite/Advanced UI project are included in your project as support files. Support files are files that are
installed to the target system for use only during the installation process. These files are automatically removed from
target system when the installation is complete.

If your project supports multiple languages, you can add language-specific support files to the appropriate language-
specific areas of the Support Files view. At run time, the Advanced UI or Suite/Advanced UI installation displays the
appropriate language-specific support files.

For more information, see Using Support Files.

See Also
Support Files View (Advanced UI, Basic MSI, InstallScript Object, and Suite/Advanced UI Projects)
Wizard Interface View

DPI-Awareness in the Wizard Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

DPI-awareness in Advanced UI and Suite/Advanced UI projects has two parts:

• Items that are drawn by the engine are scaled according to the target system’s DPI settings. Thus, if a target system
has a DPI of 200%, the check box control is scaled accordingly.

• The engine considers the scale factor and language when displaying images and other resources that you are
including in the wizard interface.

1148 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

For example, when the engine determines that the scale factor should be 150 and that the appropriate language is English,
it looks for resources that have the string scale-150 in their path or file name. It searches the following paths in the order
listed when searching for image.png on the target system:

1. [SUPPORTDIR]0409\scale-150\image.png

2. [SUPPORTDIR]0409\image.scale-150.png

3. [SUPPORTDIR]0409\image.png

4. [SUPPORTDIR]scale-150\image.png

5. [SUPPORTDIR]image.scale-150.png

6. [SUPPORTDIR]\image.png

Note that matching the language takes precedence over matching the correct DPI.

InstallShield includes scale-150 and scale-200 images for the built-in default images that are included in Advanced UI and
Suite/Advanced UI projects. If you want to include custom resources in your project, use the Support Files view to add
appropriately scaled images.

See Also
Support Files View (Advanced UI, Basic MSI, InstallScript Object, and Suite/Advanced UI Projects)
Wizard Interface View

Localizing the End-User Interface

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

InstallShield has many settings that let you specify text strings that should be displayed to end users. For example, when
you enter a value for the Display Name and Description settings for a feature, you are configuring the feature name and
description that may be displayed in the CustomSetup dialog at run time. Whenever you enter a value for such a setting
that may need to be localized for one or more languages, InstallShield automatically creates a string entry for each
language that your project supports. Each string entry consists of a language-independent identifier and a corresponding
language-specific value. At run time, the installation displays the appropriate translated string values. Using string entries
instead of hard-coded text enables you to keep the code for your installation completely separate from any language-
specific strings that you may want to be displayed during the installation.

InstallShield 2020 User Guide ISP-2600-UG00 1149

Chapter 4
Defining the End-User Interface

To help streamline the process of localizing a project, all of the text strings that may be displayed at run time during the
installation process are available in one consolidated view: the String Editor view. You can use this view to edit the strings
for everything from button text to feature descriptions. You can also use this view to export each language’s string entries
to a file, translate the values that are listed in the file, and then import the translated file into your project.

See Also
Translating String Entries
Run-Time Language Support in InstallShield

Working with String Entries in Projects that Support Multiple Languages

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

Edition • The Premier edition of InstallShield includes support for creating multilingual installations.

Note • To add additional languages to your project, use the Setup Language setting in the General Information view.

Your project contains a string entry for every localizable text string and for each language that your project supports. The
String Editor view shows the collection of language-independent identifiers and corresponding language-specific values
for your project.

Note the following details about string entries in projects that include support for multiple languages:

• The values for all of the localizable settings throughout InstallShield—such as the Display Name and Description
settings for a feature—use the project’s default language (which you can specify in the String Editor view). If you edit
the value of one of these localizable settings, InstallShield simultaneously updates the string entry’s value in the
String Editor view for the default language.

Likewise, if you use the String Editor view to modify a string value for your project’s default language, InstallShield
simultaneously updates the settings in the other InstallShield views that display the value of that string entry.

• Each language that is supported by your project uses the same set of string identifiers.

Therefore, if you add a string entry to a project, InstallShield uses the same string identifier for each language. If you
rename a string identifier, InstallShield renames the string identifier for all languages. If you delete a string entry,
InstallShield deletes it from each language.

1150 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• If you add a new language to your project, InstallShield adds to that language the same string identifiers that are
available in the other languages that are in your project. For default string entries—that is, those that are available for
the built-in dialogs and other user-interface elements—InstallShield adds the already-translated string values. For
custom string entries that you have created, InstallShield uses the string values from the default language for the new
language. You can modify any string values as needed for the new language.

When you finish authoring your project, you can export the string entries for each language to text files, and send the text
files out for translation. Once the string entries in the text file are translated, you can import them into your project.

See Also
String Editor View
Setting the Default Project Language
Translating String Entries

Using String Entries in InstallShield

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

Note • Localization of Windows App packages requires the Windows 10 SDK be installed on the same machine as
InstallShield. If it is not present, InstallShield will build a Windows App package (.appx) containing only the default language.

Instead of hard-coding strings throughout your project, you can use string entries in areas of InstallShield that accept
localizable text. The manner in which you select a string entry differs depending on where you need to use it.

Settings in Various Views

When you are entering the value of a setting in one of the views in InstallShield and that value is a text string that can be
presented to end users, InstallShield automatically uses a string identifier for that setting. InstallShield places the string
identifier in curly brackets before the string value. Following is an example of the value for the Display Name setting of a
feature:

{ID_STRING24}My New Feature

In this example, ID_STRING24 is the string identifier that is used for the Display Name setting. My New Feature is the string
value for the project’s default language.

InstallShield 2020 User Guide ISP-2600-UG00 1151

Chapter 4
Defining the End-User Interface

Task To work with a setting that accepts a localizable text string entry, do one of the following:

• To enter a new text string that is not present anywhere else in the project, type the text string that you want to use.
InstallShield automatically assigns a new string identifier to the value that you enter.

If your project includes support for multiple languages, InstallShield adds the new string identifier to all of your
project’s languages, and uses the string value that you entered as the value for all languages.

• To look at a list of existing string entries that are used in the project, click the ellipsis button (...) that is displayed on
the right when you click the setting’s value. InstallShield opens the Select String dialog box, which lets you select an
existing string entry or create a new string entry.

Caution • Do not confuse editing an existing string value with entering a new string identifier by entering text in an
InstallShield setting. Once you have selected a string identifier for a setting, deleting the localizable text in the setting merely
deletes the current string value; it does not replace the current string identifier with a new one.

Dialog Editor
Many of the controls in the Dialog Editor accept strings that are displayed to the end user. For example, the Text and
Tooltip properties always require localizable text.

Using a string entry in the Dialog Editor is similar to selecting string identifiers in other areas of InstallShield.

Task To work with the Dialog Editor and a control’s property that uses localizable text, do one of the following:

• Click the control’s property sheet and edit the string. Doing so changes the value of the string entry for the current
language. When you enter a text value without first selecting a string, InstallShield creates a new string identifier for
your project.

If your project includes support for multiple languages, InstallShield adds the new string identifier to all of your
project’s languages, and uses the string value that you entered as the value for all languages.

• When you click a localizable property’s value to edit it, an ellipsis button (...) appears inside the property sheet. Click
the ellipsis button to view the string entries for the current language.

The major difference between the dialog control properties and the settings in other views in InstallShield is that the other
views always display the string value for the default language. When you edit a dialog’s layout, however, you must first
select the language of the dialog. Then, all strings displayed in the dialog and in the property sheet are from the current
language of the dialog that you are editing.

InstallScript Script Editor Pane

If you are working in the InstallScript script editor pane in the InstallScript view, you can select and edit string entries
through the Select String dialog box.

1152 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Task To use a string identifier in your InstallScript:

1. Place the cursor at the point in your script where you want the string identifier to be inserted.

2. On the Edit menu, point to Insert and click String Entry. The Select String dialog box opens.

3. Do one of the following:

• To use an existing string entry, click the row that contains the string entry that you want to use in your script.

• To create a new string entry, click the New button. The String Entry dialog box opens, enabling you to create a
new string identifier and value.

4. Click OK.

InstallShield places the string identifier in your script preceded by the at (@) symbol.

For more information, see String Constant Operator (@).

Tip • Although you can include hard-coded user-interface strings directly in InstallScript code, it is recommended that you
avoid doing this. Strings that are hard coded in InstallScript code are not stored as Unicode; thus, they are displayed correctly
only when the installation is run on systems that have the correct code page. Adding strings to a project through the String
Editor view and referencing the associated string identifiers from InstallScript code eliminates this issue.

What Happens with String Entries at Build Time and Run Time
InstallShield stores string entries in the ISString table of your InstallShield project file (.ism). At build time, InstallShield
uses the string values instead of the string identifiers when it is creating your release in most cases. That is, the string
identifiers are not built into the release, and the string identifiers are not available at run time.

The one exception of when InstallShield does use string identifiers in a build is if your project includes InstallScript code. In
this scenario, the release that InstallShield builds includes string tables that contain all of the string entries. These string
tables make it possible for you to use string identifiers in your InstallScript code instead of hard-coded text strings. At run
time, the installation replaces string identifiers with string values as needed.

See Also
String Editor View
Select String Dialog Box
Setting the Default Project Language

Adding a String Entry

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript

InstallShield 2020 User Guide ISP-2600-UG00 1153

Chapter 4
Defining the End-User Interface

• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

The String Editor view lets you create a new string entry that you can later reference in one of the settings in InstallShield,
in one of your project’s dialogs, and in your InstallScript code.

Task To add a new string entry to your project:

1. In the View List under User Interface, click String Editor.

2. Do one of the following:

• Click the New String Entry button.

• Press the INSERT key.

The String Entry dialog box opens.

3. In the String Identifier box, specify the language-independent string identifier that you want to use for your string
entry, or leave the new default string identifier that InstallShield enters in this box for you.

4. In the Value box, specify the localizable text string that you want to use for the string entry.

5. In the Comments box, you can optionally specify an internal note about the string entry. The comments are not
displayed at run time.

6. Click OK.

InstallShield adds a new row in the String Editor view for the new string entry.

Tip • If your project includes support for multiple languages, InstallShield adds the string entry to all of your project’s
languages, and it uses the string value that you entered as the value for all languages. You can edit the string values for
languages as needed.

Note • Since you must use a string identifier throughout InstallShield for settings that accept localizable text, InstallShield
adds a new string entry to your project whenever you try typing a value into a setting without selecting an existing string
identifier.

See Also
String Editor View
Translating String Entries

Editing a String Entry

InstallShield 2020

Project • This information applies to the following project types:

1154 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

The String Editor view contains a spreadsheetlike table that lets you modify string entries in your project.

Task To edit a string entry in the String Editor view:

1. In the View List under User Interface, click String Editor.

2. Find the string entry that you want to modify.

3. Do one of the following:

• To overwrite all of the text in a table cell, click the table cell and then type your new identifier, value, or
comments.

• To place the cursor at a particular place within a table cell, double-click that place. Then type your change.

Note that if you rename a string identifier, InstallShield renames the string identifier for all languages in your project.

When you edit a string entry, InstallShield updates the Modified column with the date and time that you made the change.
You can sort the string entries in the String Editor view by modified date. This is helpful if you want to identify which strings
have been modified since the strings were last translated.

Tip • If you are editing a localizable setting from within one of the other views in InstallShield, you can click the ellipsis button
(...) in that setting. Doing so opens the Select String dialog box, which lets you specify which string entry you want to use for the
selected setting.

Project • In Basic MSI, InstallScript MSI, and Merge Module projects, some of the string values contain Windows Installer
properties inside square brackets—for example, Install [ProductName]. At run time, the property and brackets are replaced
by the property value.

String values may also contain font information in curly brackets—for example, {&MSSansBold8}OK. The font information
indicates style details that should be used to display the strings at run time.

See Also
String Editor View
Select String Dialog Box
Translating String Entries

InstallShield 2020 User Guide ISP-2600-UG00 1155

Chapter 4
Defining the End-User Interface

Searching for Instances of String Identifiers

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

String identifiers are used throughout InstallShield projects. If you want to see where a particular string identifier is used in
your project, you can perform a search in the String Editor view.

Task To find all the occurrences of a particular string identifier within your project:

1. In the View List under User Interface, click String Editor.

2. Select the row that contains the string identifier for which you want to search.

To select multiple consecutive rows, click the first row, and then press SHIFT while clicking the last row. To select
multiple nonconsecutive rows, click the first row, and then press CTRL while clicking each additional row.

3. Click the Search for Selected Strings in Project button.

InstallShield displays the search results on the Results tab in the Output window. The Results tab indicates how many
times the string identifier is used. In addition, it indicates the location in the Direct Editor view where the string identifier is
used.

If the string identifier is not used in the project, the Results tab shows that zero occurrences were found.

Note • InstallShield does not search the project’s InstallScript files (.rul) for instances of the string identifier.

See Also
String Editor View

Finding and Replacing String Entries

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI

1156 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

The String Editor includes support for standard find-and-replace functionality. This functionality may be useful if you want
to search for specific strings in your project and replace them with revised strings.

Finding Strings in the String Editor

Task To find a string in the String Editor:

1. In the View List under User Interface, click String Editor.

2. Click the Find String button. The Find dialog box opens.

3. In the Find what box, type the string that you want to find.

4. Select any other options that you want.

5. Click Find Next.

InstallShield finds the first instance of the string that you specified.

Finding and Replacing Strings in the String Editor

Task To find and replace a string in the String Editor:

1. In the View List under User Interface, click String Editor.

2. Click the Find and Replace button. The Replace dialog box opens.

3. In the Find what box, type the string that you want to replace.

4. In the Replace with box, type the new string.

5. Select any other options that you want.

6. Click Find Next, Replace, or Replace All.

InstallShield replaces strings as needed.

See Also
String Editor View

Removing a String Entry

InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 1157

Chapter 4
Defining the End-User Interface

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

If you no longer need a particular string entry in your project, you can delete it.

Note that if you delete a string entry, InstallShield deletes it from each language in your project.

Task To remove a string entry from your project:

1. In the View List under User Interface, click String Editor.

2. Find the string entry that you want to delete.

3. Click the Delete Selected Strings button or press DELETE.

See Also
String Editor View
Setting the Default Project Language

Removing String Identifiers from Localizable Settings

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

When you are entering the value of a setting in one of the views in InstallShield and that value is a text string that can be
presented to end users, InstallShield automatically uses a string identifier for that setting. InstallShield places the string
identifier in curly brackets before the string value.

If you try to delete the setting’s value, you are actually deleting the string value for the current language. In that case, the
string identifier with an empty value is used for the setting.

Therefore, if you want to remove a string identifier from a localizable setting, you must replace it with a different string
identifier, or add a new string identifier.

For information on replacing a string identifier, see Editing a String Entry. To learn how to create a new string identifier, see
Adding a String Entry.

1158 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Displaying Billboards
InstallShield 2020

Project • Billboards are available in the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

You can add billboards to your projects to display information to end users during the installation process. The billboards
can be used to communicate, advertise, educate, and entertain end users. For example, billboards can present overviews
on new features of the product being installed or other products from your company. Each billboard is a file that you or
your company’s graphics department creates for complete control over the look and feel of the file transfer.

Project • Support for billboards differs, depending on which project type you are using. To learn more about billboards, see
the appropriate section:

• Displaying Billboards in Basic MSI Installations

• Displaying Billboards in InstallScript and InstallScript MSI Installations

Displaying Billboards in Basic MSI Installations

InstallShield 2020

Project • This information applies to Basic MSI projects.

You can add billboards to your projects to display information to end users during the installation process. The billboards
can be used to communicate, advertise, educate, and entertain end users. For example, billboards can present overviews
on new features of the product being installed or other products from your company. Each billboard is a file that you or
your company’s graphics department creates for complete control over the look and feel of the file transfer.

See Also
Billboards View
Types of Billboards for Basic MSI Projects
Adding an Adobe Flash Application File Billboard to a Basic MSI Project
Adding Image Billboards to a Basic MSI Project

Billboard File Types for Basic MSI Projects

InstallShield 2020

Project • This information applies to Basic MSI projects.

InstallShield supports different types of files for billboards:

InstallShield 2020 User Guide ISP-2600-UG00 1159

Chapter 4
Defining the End-User Interface

• Adobe Flash application file (.swf)

• Images (.bmp, .gif, .jpg, and .jpeg)

If a target system does not have the Adobe Flash Player, which is used to display Flash application files, the installation can
detect that and display image billboards in place of the Flash billboard. Therefore, if you include a Flash billboard in your
project, it is recommended that you also include one or more image billboards in your project.

Note • You can add more than one image billboard to a project, but only one Adobe Flash application file billboard.

See Also
Adding an Adobe Flash Application File Billboard to a Basic MSI Project
Adding Image Billboards to a Basic MSI Project
Setting the Billboard Order in a Basic MSI Project

Types of Billboards for Basic MSI Projects

InstallShield 2020

Project • This information applies to Basic MSI projects.

InstallShield offers support for three different billboard styles. For example, with one style, the installation displays a full-
screen background, with billboards in the foreground, and a small progress box in the lower-right corner of the screen.
With another style, the installation displays a standard-size dialog that shows the billboards. The bottom of this dialog
shows the progress bar.

Following are descriptions and sample screen shots of each type of billboard.

Fullscreen with Small Progress (Displayed in Lower Right)

For the Fullscreen with Small progress (displayed in lower right) type of billboard, when the installation displays the
standard end-user dialogs, it also displays a full-screen background. During file transfer, the installation shows full-screen
backgrounds, with billboards in the foreground, and a small progress box in the lower-right corner of the screen.

1160 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Figure 4-28: Fullscreen Billboard with Small Progress (Displayed in Lower Right)

In the sample screen shot, the billboard is the blue-green rectangle image in the center. Some of the configurable billboard
settings were set as follows:

• Origin—Centered

• Title—A B C

• Font—48 pt. Arial

• Background Color—Yellow

Windowed with Standard Progress

For the Windowed with Standard progress type of billboard, during file transfer, the installation displays a standard-size
dialog that shows the billboards. The bottom of this dialog shows the progress bar. The installation does not display a
background for this style.

InstallShield 2020 User Guide ISP-2600-UG00 1161

Chapter 4
Defining the End-User Interface

Figure 4-29: Windowed with Standard Progress

In the sample screen shot, the billboard is the blue-green rectangle image. Its size is 544 pixels wide by 281 pixels high.

Windowed with Small (Displayed in Lower Right, No Billboards)

For the Windowed with Small (displayed in lower right, no billboards) type of billboard, the installation displays a small
progress box in the lower-right corner of the screen during file transfer. It does not display any billboards or a background.

Figure 4-30: Windowed with Small (Displayed in Lower Right, No Billboards)

1162 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

As shown in the sample screen shot, the progress bar is shown, but no billboard is displayed. The black background is the
end user’s desktop.

See Also
Specifying Which Type of Billboard to Use in a Basic MSI Project

Specifying Which Type of Billboard to Use in a Basic MSI Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

InstallShield offers support for different billboard styles.

Task To specify which type of billboard you want to use in your installation:

1. In the View List under User Interface, click Billboards.

2. In the center pane, click the Billboards explorer. InstallShield displays the Billboard Type setting in the right pane.

3. In the Billboard Type setting, select the appropriate style of billboard.

To see samples of each type of billboard, see Types of Billboards for Basic MSI Projects.

See Also
Billboard File Types for Basic MSI Projects

Adding an Adobe Flash Application File Billboard to a Basic MSI Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

InstallShield lets you display a Flash application file billboard during the file transfer process. Flash application files can
consist of videos, movies, sounds, interactive interfaces, games, text, and more—anything that is supported by the .swf
type of file. It is recommended that files such as Flash video files (.flv) and MP3 audio files be embedded in the .swf file so
that they are available locally on the target system during file transfer. Although .swf files can reference external files that
you can post on a Web site, this external implementation would require that end users have an Internet connection.

Task To add an Adobe Flash Application File billboard to your installation project:

1. In the View List under User Interface, click Billboards.

2. In the Billboards explorer, right-click Adobe Flash Application File (.swf) and then click New Billboard. InstallShield
adds a new billboard item with the name NewBillboard1.

3. Type a name for the billboard item. This name is used to help you identify the item while you are creating your
installation; the name is not displayed during the installation.

InstallShield 2020 User Guide ISP-2600-UG00 1163

Chapter 4
Defining the End-User Interface

4. In the right pane, configure the settings for the billboard.

Note • If the version of Flash or other tool that you use to create your .swf file is newer than the version of the Flash Player that
is installed on a target system, it is possible that some of the Flash features may not work as expected on that target system.

If a target system does not have the Adobe Flash Player, which is used to display Flash application files, the installation can
detect that and display image billboards in place of the Flash billboard. Therefore, if you include a Flash billboard in your
project, it is recommended that you also include one or more image billboards in your project.

See Also
Billboard File Types for Basic MSI Projects
Run-Time Behavior of a Basic MSI Installation that Includes Billboards

Adding Image Billboards to a Basic MSI Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

You can choose to display only one image billboard during the file transfer process, or you can include a series of image
billboards, each one designed to be displayed for a specific amount of time. InstallShield includes support for .bmp, .gif,
.jpg, and .jpeg image files.

Note • Animated .gif files are not supported. If you want to use animation in a billboard, consider using an Adobe Flash
application file billboard.

Task To add an image billboard to your installation:

1. In the View List under User Interface, click Billboards.

2. In the Billboards explorer, right-click Images and then click New Billboard. InstallShield adds a new billboard item
with the name NewBillboard1.

3. Type a name for the billboard item. This name is used to help you identify the item while you are creating your
installation; the name is not displayed during the installation.

4. In the right pane, configure the settings for the billboard.

See Also
Billboard File Types for Basic MSI Projects
Run-Time Behavior of a Basic MSI Installation that Includes Billboards

1164 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Configuring Billboard Settings in a Basic MSI Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

When you add an Adobe Flash application file billboard or an image billboard to your project, you need to configure its
settings.

Task To configure a billboard’s settings:

1. In the View List under User Interface, click Billboards.

2. In the Billboards explorer in the center pane, click the billboard that you want to configure. InstallShield displays the
billboard settings in the right pane.

3. Configure the settings as required.

For information about each of the billboard settings, see Settings for Adobe Flash Application File Billboards and Image
Billboards.

See Also
Billboard Settings
Adding an Adobe Flash Application File Billboard to a Basic MSI Project
Adding Image Billboards to a Basic MSI Project

Previewing Billboards Without Building and Launching a Release

InstallShield 2020

Project • This information applies to Basic MSI projects.

InstallShield lets you preview a billboard to see how it would be displayed at run time, without requiring you to build and
run a release.

Previewing a billboard lets you see how your billboard will look with the background color, position, and related settings
that are currently configured for your billboard.

Task To preview a billboard:

1. In the View List under User Interface, click Billboards.

2. In the Billboards explorer in the center pane, right-click the billboard that you want to preview, and then click
Preview Billboard.

InstallShield displays a preview of the billboard as it would be displayed at run time.

To stop previewing a billboard, click the Cancel button in the preview window.

InstallShield 2020 User Guide ISP-2600-UG00 1165

Chapter 4
Defining the End-User Interface

Tip • Previewing a billboard is especially helpful if you want to see how your Flash or image billboard will look with different
selected billboard types. You can preview a billboard, change the billboard type, and then preview a billboard again.

See Also
Types of Billboards for Basic MSI Projects

Setting the Billboard Order in a Basic MSI Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

Image billboards are displayed in the order in which they are listed in the Billboards view, from top to bottom.

Task To change the order in which image billboards are displayed at run time:

1. In the View List under User Interface, click Billboards.

2. In the Billboards explorer, right-click one of the billboard items that you want to move, and then click either Move Up
or Move Down.

Repeat the last step until all of the billboards are correctly sorted.

See Also
Adding Image Billboards to a Basic MSI Project

Run-Time Behavior of a Basic MSI Installation that Includes Billboards

InstallShield 2020

Project • This information applies to Basic MSI projects.

Important • If your installation includes billboards, your installation must include a Setup.exe setup launcher. The setup
launcher is required because it displays the billboards at run time. The Setup.exe tab for a release in the Releases view is
where you specify information such as whether you want to use a setup launcher. To learn more, see Setup.exe Tab for a
Release.

If your installation includes a Flash billboard and one or more image billboards, only one billboard type is displayed at run
time during the file transfer process: the Flash billboard or the image billboards.

• If the Flash Player is present on the target system, the installation displays the Flash billboard.

• If the Flash Player is not present, the installation displays the image billboards.

The run-time behavior is slightly different, depending on whether the installation is displaying a Flash billboard or image
billboards:

1166 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

• If the installation is displaying a Flash billboard—When the file transfer is complete, the installation continues
showing the Flash billboard until its duration has elapsed. Once the duration has elapsed, the installation stops
displaying the billboard and shows the appropriate SetupComplete dialog.

If the file transfer takes more time than you have allocated for the duration of the Flash billboard, the installation
continues displaying the Flash billboard until file transfer ends.

• If the installation is displaying image billboards—When the file transfer is complete, the installation stops
displaying the image billboards, even if other billboards are scheduled or the current billboard’s duration has not
elapsed. The installation then shows the appropriate SetupComplete dialog.

If the file transfer takes more time than you have allocated for the billboards, the installation continues displaying the
billboards until file transfer ends. If No is selected for the Loop Billboard setting in the Billboards view and the
installation reaches the last billboard before the file transfer ends, the installation continues displaying that last
image billboard until file transfer ends. Then the installation shows the appropriate SetupComplete dialog. If Yes is
selected for this setting and the installation reaches the last billboard before the file transfer ends, the installation
restarts the display of billboards from the beginning. The loop continues, if necessary, until the file transfer ends, and
the SetupComplete dialog is displayed.

Note • If the version of Flash or other tool that you use to create your .swf file is newer than the version of the Flash Player that
is installed on a target system, it is possible that some of the Flash features may not work as expected on that target system.

See Also
Types of Billboards for Basic MSI Projects
Previewing Billboards Without Building and Launching a Release
Setting the Billboard Order in a Basic MSI Project

Removing a Billboard from a Basic MSI Project

InstallShield 2020

Project • This information applies to Basic MSI projects.

Task To remove a billboard from your installation:

1. In the View List under User Interface, click Billboards.

2. In the Billboards explorer, right-click the billboard that you would like to remove, and then click Delete.

Displaying Billboards in InstallScript and InstallScript MSI Installations

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript

InstallShield 2020 User Guide ISP-2600-UG00 1167

Chapter 4
Defining the End-User Interface

• InstallScript MSI

You can add billboards to your projects to display information to end users during the installation process. The billboards
can be used to communicate, advertise, educate, and entertain end users. For example, billboards can present overviews
on new features of the product being installed or other products from your company. Each billboard is a file that you or
your company’s graphics department creates for complete control over the look and feel of the file transfer.

See Also
Displaying a Background Window in InstallScript and InstallScript MSI Installations

Billboard Styles and File Types for InstallScript and InstallScript MSI Projects
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

InstallShield offers support for two different billboard styles. One includes a full-screen background window, and the other
does not. Both styles show a progress bar.

Following are descriptions and sample screen shots of both types of billboard, along with applicable supported file types.

Windowed Billboards with Progress

For this style of billboard, the installation displays a standard-size dialog. During file transfer, the top of the dialog shows
the billboards, and the bottom of this dialog shows the progress bar. The installation does not require a background
window for this style of billboard.

You can use the following types of files for this style of billboard:

• Adobe Flash application file (.swf)

• Images (.bmp, .gif, .jpg, and .jpeg)

If a target system does not have the Adobe Flash Player, which is used to display Flash application files, the installation can
detect that and display image billboards in place of the Flash billboard. Therefore, if you include a Flash billboard in your
project, it is recommended that you also include one or more image billboards in your project.

Note • For windowed billboards that show progress, you can add more than one image billboard to a project, but only one
Adobe Flash application file billboard.

1168 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Figure 4-31: Windowed Billboard with Progress

In the sample screen shot, the billboard is the blue-green rectangle image. Its size is 544 pixels wide by 281 pixels high.

Note • Skinned dialogs cannot display windowed billboards. To learn more about skins, see Dialog Skins.

Billboards with a Full-Screen Background Window

For this style of billboard, when the installation displays the standard end-user dialogs, it also displays a full-screen
background window. During file transfer, the billboards are displayed in front of the full-screen background window, and
the standard size progress dialog is displayed in front of the billboards. This style of billboard requires a background
window.

You can use image files (.bmp, .gif, .jpg, and .jpeg) for this style of billboard.

InstallShield 2020 User Guide ISP-2600-UG00 1169

Chapter 4
Defining the End-User Interface

Figure 4-32: Billboard with Full-Screen Background Window

In the sample screen shot, the billboard is the blue-green rectangle image behind the progress dialog but in front of the
background window.

See Also
Adding or Modifying the Code in an InstallScript or InstallScript MSI Project to Display Billboards
Naming Billboard Files in an InstallScript or InstallScript MSI Project
Adding an Adobe Flash Application File Billboard to an InstallScript or InstallScript MSI Project
Adding an Image Billboard to an InstallScript or InstallScript MSI Project
Setting the Billboard Order in an InstallScript or InstallScript MSI Project

Naming Billboard Files in an InstallScript or InstallScript MSI Project

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Note • The Adobe Flash application file support that is described here is applicable if the billboard style that you are using is
the windowed style with progress, not the billboard style with a full-screen background window. If you want to use Flash file
support with a full-screen background window, use the PlayMMedia function; with this support, the following naming
conventions do not apply to the Adobe Flash file. For more information, see PlayMMedia. To learn how to display the

1170 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

background window for this implementation, see Displaying a Background Window in InstallScript and InstallScript MSI
Installations.

You can add more than one image billboard to a project, but only one Adobe Flash application file billboard.

Note that if a target system does not have the Adobe Flash Player, which is used to display Flash application files, the
installation can detect that and display image billboards in place of the Flash billboard. Therefore, if you include a Flash
billboard in your project, it is recommended that you also include one or more image billboards in your project.

The first step in adding billboards to your project is to create the Adobe Flash application file (if applicable) and image files
(.bmp, .gif, .jpg, or .jpeg) that serve as your installation’s billboards. When your files are properly named, you can add your
billboards to your project. Note that if a target system does not have the Adobe Flash Player, which is used to display Flash
application files, the installation can detect that and display image billboards in place of the Flash billboard. Therefore, if
you include a Flash billboard in your project, it is recommended that you also include one or more image billboards in your
project.

Billboard files must follow a designated naming convention. Each file name must begin with bbrd, followed by the number
of the billboard (from 1 through 99); each must end with a supported file extension (.swf, .bmp, .gif, .jpg, or .jpeg). You can
include a maximum of one Adobe Flash file (.swf) in your project; if you do include an .swf file, its name must contain the
lowest number in the list of billboard files (for example, bbrd1.swf) that you are including in your project.

The billboards are displayed according to the sequential order of their file names. For example, a billboard file named
bbrd2.bmp is displayed before bbrd4.gif.

Note that it is not necessary for the file name numbers to be contiguous; that is, you can add bbrd1.jpg, bbrd3.jpg, and
bbrd5.jpg to your project, and each image is displayed at run time in order.

Tip • The length of time that an image billboard is displayed depends upon the number of image billboards in your
installation project. The percentage of the display time is approximately 1 divided by the number of billboards. For example, if
you have four billboards in your installation, each billboard is displayed for 25% of the file-transfer time.

Adding an Adobe Flash Application File Billboard to an InstallScript or InstallScript MSI Project
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Note • The Adobe Flash application file support that is described here is applicable if the billboard style that you are using is
the windowed style with progress, not the billboard style with a full-screen background window. If you want to use Flash file
support with a full-screen background window, use the PlayMMedia function. For more information, see PlayMMedia. To
learn how to display the background window for this implementation, see Displaying a Background Window in InstallScript
and InstallScript MSI Installations.

InstallShield 2020 User Guide ISP-2600-UG00 1171

Chapter 4
Defining the End-User Interface

InstallShield lets you display a Flash application file billboard during the file transfer process. Flash application files can
consist of videos, movies, sounds, interactive interfaces, games, text, and more—anything that is supported by the .swf
type of file. It is recommended that files such as Flash video files (.flv) and MP3 audio files be embedded in the .swf file so
that they are available locally on the target system during file transfer. Although .swf files can reference external files that
you can post on a Web site, this external implementation would require that end users have an Internet connection.

Task To add an Adobe Flash Application File billboard to your installation project:

1. In the View List under Behavior and Logic, click Support Files/Billboards.

2. In the Support Files explorer, click the Billboards item that should contain the billboard: either Language
Independent or a language-specific item. The Files pane is displayed on the right.

3. Right-click anywhere in the Files pane and click Insert Files, or place your cursor in the Files pane and press the Insert
key. The Open dialog opens.

4. Select your Adobe Flash application file billboard file named bbrd1.swf, and click OK.

InstallShield adds the file to your project.

Note • If the version of Flash or other tool that you use to create your .swf file is newer than the version of the Flash Player that
is installed on a target system, it is possible that some of the Flash features may not work as expected on that target system.

If a target system does not have the Adobe Flash Player, which is used to display Flash application files, the installation can
detect that and display image billboards in place of the Flash billboard. Therefore, if you include a Flash billboard in your
project, it is recommended that you also include one or more image billboards in your project.

See Also
Adding or Modifying the Code in an InstallScript or InstallScript MSI Project to Display Billboards

Adding an Image Billboard to an InstallScript or InstallScript MSI Project

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

You can choose to display only one image billboard during the file transfer process, or you can include a series of image
billboards, each one designed to be displayed for a specific amount of time. InstallShield includes support for .bmp, .gif,
.jpg, and .jpeg image files.

Note • Animated .gif files are not supported. If you want to use animation in a billboard, consider using an Adobe Flash
application file billboard.

1172 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Task To add an image billboard to your installation project:

1. In the View List under Behavior and Logic, click Support Files/Billboards.

2. In the Support Files explorer, click the Billboards item that should contain the billboard: either Language
Independent or a language-specific item. The Files pane is displayed on the right.

3. Right-click anywhere in the Files pane and click Insert Files, or place your cursor in the Files pane and press the Insert
key. The Open dialog opens.

4. Select a billboard file, and click OK.

InstallShield adds the file to your project.

Tip • The length of time that an image billboard is displayed depends upon the number of image billboards in your
installation project. The percentage of the display time is approximately 1 divided by the number of billboards. For example, if
you have four billboards in your installation, each billboard is displayed for 25% of the file-transfer time.

See Also
Adding or Modifying the Code in an InstallScript or InstallScript MSI Project to Display Billboards

Adding or Modifying the Code in an InstallScript or InstallScript MSI Project to Display

Billboards
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The InstallScript code that is needed to display billboards at run time varies, depending on the style of billboard that you
are using.

• Windowed Billboards with Progress—To use windowed billboards that show progress at run time, use the
STATUSBBRD constant with the Enable function.

• Billboards with a Full-Screen Background Window—To use billboards that are displayed with a full-screen
background window, use the FULLWINDOWMODE and BACKGROUND constants with the Enable function. To learn
how, see Displaying a Background Window in InstallScript and InstallScript MSI Installations.

Note that if you want to use an Adobe Flash billboard with this style of billboard, you must also use the PlayMMedia
function.

For details about these different styles of billboards, see Billboard Styles and File Types for InstallScript and InstallScript
MSI Projects.

InstallShield 2020 User Guide ISP-2600-UG00 1173

Chapter 4
Defining the End-User Interface

See Also
Enable
PlayMMedia
Adding an Adobe Flash Application File Billboard to an InstallScript or InstallScript MSI Project
Adding an Image Billboard to an InstallScript or InstallScript MSI Project
Displaying a Background Window in InstallScript and InstallScript MSI Installations

Setting the Billboard Order in an InstallScript or InstallScript MSI Project

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Image billboards are displayed according to the numeric order of their file names. A billboard file named bbrd2.bmp is
displayed to the end user before a file named bbrd3.bmp, and after a file named bbrd1.bmp. For specific guidelines on
naming conventions, see Naming Billboard Files in an InstallScript or InstallScript MSI Project.

Task To change the order in which billboards are displayed:

1. Remove the billboard files whose order should change. (For more information, see Removing a Billboard from an
InstallScript or InstallScript MSI Project.)

2. Using Windows Explorer, rename the billboard files so that they are in the appropriate numeric order.

3. Add the renamed files, as explained in Adding an Image Billboard to an InstallScript or InstallScript MSI Project.

Note that it is not necessary for the file name numbers to be contiguous; that is, you can add bbrd1.jpg, bbrd3.jpg, and
bbrd5.jpg to your project, and each image is displayed at run time in order.

Displaying Billboards with Special Effects During an InstallScript or InstallScript MSI

Installation
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The SetDisplayEffect function enables you to display your billboards with different special effects when they first appear
on the main installation window. Choose one of this function’s options before you display a bitmap with PlaceBitmap or
display billboards during file transfer.

1174 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

See Also
Adding an Image Billboard to an InstallScript or InstallScript MSI Project
Billboard Styles and File Types for InstallScript and InstallScript MSI Projects
SetDisplayEffect
PlaceBitmap

Moving Billboards to a Different Screen Location for an InstallScript or InstallScript MSI Project
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Note • The Adobe Flash application file support that is described here is applicable if the billboard style that you are using is
the billboard style with a full-screen background window (which uses the PlayMMedia function), not for the windowed style
with progress (which uses the STATUSBBRD constant with the Enable function). For more information about these two styles
of billboards, see Billboard Styles and File Types for InstallScript and InstallScript MSI Projects.

By default, the installation displays billboards in the center of the main installation window. To specify a different location,
call the PlaceWindow function with the BILLBOARD option. For example, to place your billboards 10 pixels from the upper-
left corner of the screen, make the following call:

PlaceWindow (BILLBOARD, 10, 10, UPPER_LEFT);

Since billboards are displayed only during file transfer, ensure that you call PlaceWindow before you begin file transfer.

See Also
PlaceWindow

Removing a Billboard from an InstallScript or InstallScript MSI Project

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Task To remove a billboard from your installation project:

1. In the View List under Behavior and Logic, click Support Files/Billboards.

2. In the Support Files explorer, click the Billboards item that contains the billboard that you want to remove: either
Language Independent or a language-specific item. The Files pane is displayed on the right.

InstallShield 2020 User Guide ISP-2600-UG00 1175

Chapter 4
Defining the End-User Interface

3. Right-click the billboard file and click Delete.

Displaying a Background Window in InstallScript and

InstallScript MSI Installations
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

By default, installations do not display a background window. If you want to use the PlayMMedia function to display an
Adobe Flash application file (.swf) or AVI files, your installation must display a background window. You may also want to
display a background window for one type of billboard.

Tip • You can display a Flash file billboard and image billboards without a background window. For more information, see
Billboard Styles and File Types for InstallScript and InstallScript MSI Projects.

The method for displaying a background window depends on which project type you are using.

InstallScript Projects
To display a background window in an InstallScript project, modify the script’s OnShowUI event handler by removing the
double slashes from the beginnings of the following lines of code:

//if ( LoadStringFromStringTable( "TITLE_MAIN", szTitle ) < ISERR_SUCCESS ) then // Load the title
string.
// szTitle = IFX_SETUP_TITLE;
//endif;
//SetTitle( szTitle, 24, WHITE );
//Enable( FULLWINDOWMODE );
//Enable( BACKGROUND );
//SetColor( BACKGROUND, RGB( 0, 128, 128 ) );

InstallScript MSI Projects

To display a background window in an InstallScript MSI project, modify the appropriate script’s UI event handler (such as
OnFirstUIBefore or OnMaintUIBefore) by removing the double slashes from the beginnings of the following lines of code:

// SetTitle( @PRODUCT_NAME, 24, WHITE );

// SetTitle( @PRODUCT_NAME, 0, BACKGROUNDCAPTION );
// Enable( FULLWINDOWMODE );
// Enable( BACKGROUND );
// SetColor(BACKGROUND,RGB (0, 128, 128));

See Also
Enable
PlayMMedia
Script Editor in the InstallScript View

1176 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Defining the End-User Interface

Populating List Boxes at Run Time

InstallShield 2020

Basic MSI Projects

Populating a list box at run time requires you to create temporary records for the .msi database using SQL queries. For an
example, see Knowledge Base article Q103295. For additional information, see InstallShield Developer Tip: Accessing the
MSI Database at Run Time.

InstallScript MSI Projects

The CtrlSetList function associates a string list variable with a ListBox control on a dialog. For example:

function FillListBox( )
LIST listDays;
begin
listDays = ListCreate(STRINGLIST);
ListAddString(listDays, "Monday", AFTER);
ListAddString(listDays, "Wednesday", AFTER);
ListAddString(listDays, "Friday", AFTER);

CtrlSetList("DialogName", nListBoxId, listDays);

end;

See Also
CtrlSetList

Displaying File Browse Dialogs

InstallShield 2020

For an example of calling the GetOpenFileName API to display a file browse dialog, see Knowledge Base article Q104325.

Displaying Network Browse Dialogs in InstallScript

Installations
InstallShield 2020

You can use the SelectDirEx function to display a dialog with which the user can browse the Network Neighborhood.

prototype NetBrowse( );

function NetBrowse( )
STRING svSelectedDir[MAX_PATH + 1];
NUMBER nReturn;
begin
svSelectedDir = PROGRAMFILES;

nReturn = SelectDirEx("", "Select a directory:", "", "",

BIF_EDITBOX | BIF_RETURNONLYFSDIRS, svSelectedDir);

if (nReturn = OK) then

InstallShield 2020 User Guide ISP-2600-UG00 1177

Chapter 4
Defining the End-User Interface

MessageBox("Selected directory was: " + svSelectedDir, INFORMATION);

elseif (nReturn = CANCEL) then
MessageBox("User clicked Cancel", INFORMATION);
else
MessageBox("Error displaying dialog", WARNING);
endif;
end;

1178 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Configuring Servers
InstallShield 2020

When you are creating an installation, you may find it necessary to provide server-side support for some technology that
will be installed on a target system. InstallShield makes it easy to configure server-side installations or manage COM+
server applications and application proxies. InstallShield provides support for Internet Information Services, SQL, and
component services.

Configuring SQL Support

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

Note • For information about configuring SQL support in Suite/Advanced UI projects, refer to Adding a SQLLogin Predefined
Wizard Page in a Suite/Advanced UI Project.

InstallShield provides SQL support for Microsoft SQL Server, Microsoft Windows Azure, MySQL, and Oracle. The SQL Scripts
view provides a central location for managing and organizing all SQL scripts by server connections and settings within the
user interface. SQL support within InstallShield enables you to do the following:

• Connect to SQL servers.

• Import catalog schema and/or data.

• Associate SQL scripts with features.

• Set required SQL server/script properties (server name, database name, authentication method, etc.).

• Set SQL script for execution during installation or uninstallation.

• Edit SQL scripts.

• Require and/or target specific versions of SQL Server, MySQL, or Oracle.

• Define SQL script text replacement.

• Open scripts in Microsoft SQL Server Management Studio or Microsoft SQL Server Query Analyzer.

Note • The import database functionality applies to the Microsoft SQL Server Database. Oracle users should refer to the
Oracle Web page on Oracle Database Utilities for information on utilities that may work in conjunction with InstallShield.

If you have Microsoft SQL Server Management Studio or Microsoft SQL Server 2000 SQL Query Analyzer installed on your
system, you can open a new SQL script that you have added to your project to test, edit, and syntax-check the script. To launch

InstallShield 2020 User Guide ISP-2600-UG00 1179

Chapter 4
Configuring Servers

one of those tools and open your script from within InstallShield, right-click the script file in the SQL Scripts view and then click
Open Script in Microsoft SQL Server Management Studio. InstallShield searches your system for the following tools in order
and launches the first one that it finds:

1. Microsoft SQL Server 2008 Management Studio (any edition, including Express; ssms.exe)
2. Microsoft SQL Server 2005 Management Studio (SqlWb.exe)
3. Microsoft SQL Server 2005 Management Studio Express (ssmsee.exe)
4. Microsoft SQL Server 2000 Query Analyzer (isqlw.exe)

See Also
SQL Scripts View

Using Windows Installer Properties for SQL Login Settings

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI

When you use the SQL Scripts view to add a new SQL database connection to your project, InstallShield adds the following
Windows Installer properties to the project by default.

Table 4-1 • Default SQL Login Properties

Property Description

IS_SQLSERVER_AUTHENTICATION This property identifies the type of authentication that you want to use to
connect to the specified catalog. The default property is
IS_SQLSERVER_AUTHENTICATION. The following numbers are valid property
values:

• 0—Windows authentication credential of the current user

• 1—Server authentication

This property is the default value for the Authentic Type Property Name
setting on the Advanced tab for the selected SQL connection.

IS_SQLSERVER_DATABASE This property identifies the name of the SQL catalog to which you want to
create a connection during the installation. This property is the default value
for the Target Catalog Property Name setting on the Advanced tab for the
selected SQL connection.

IS_SQLSERVER_PASSWORD This property identifies the password that should be used for server
authentication. This property is the default value for the Server
Authentication Password Property Name setting on the Advanced tab for the
selected SQL connection.

1180 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Table 4-1 • Default SQL Login Properties (cont.)

Property Description

IS_SQLSERVER_SERVER This property identifies the name of the target server instance (for Microsoft
SQL Server and MySQL) or the connect URL string or local net service name
(for Oracle). This property is the default value for the Target Server Property
Name setting on the Advanced tab for the selected SQL connection.

IS_SQLSERVER_USERNAME This property identifies the login ID that should be used for server
authentication. This property is the default value for the Server
Authentication Login ID Property Name setting on the Advanced tab for the
selected SQL connection.

If you want to override one of these Windows Installer property for an existing connection, add a new property in the
Property Manager. Then, in the SQL Scripts view, select the connection. On the Advanced tab, select the name of the new
property in the appropriate list.

If you want to store the values of any of these properties on the target system for later use by your product, you can do so.
Following are examples of ways you can use these properties:

• In the Registry view, create a registry value whose data is [IS_SQLSERVER_SERVER]. At run time, when your installation
creates the registry value, the data for that registry value is set to the name of the SQL catalog.

• Use the Text File Changes view to configure text string replacements that you want to occur at run time. In this view,
add a text file reference that describes a file that is installed with your product, and then specify the search-and-
replace criteria. For the search-and-replace criteria, you can enter [IS_SQLSERVER_DATABASE] in place of the name of
the SQL Server machine. At run time, when your installation edits the text file, the name of the SQL Server machine is
written in the text file.

Tip • For a list of additional Windows Installer properties that you can define in your project to override default SQL run-time
behavior, see Overriding the Default SQL Run-Time Behavior.

Project • In a Basic MSI installation, the built-in SQLLogin dialog lets end users configure the aforementioned properties. If
you change any of the SQL properties on the Advanced tab of a SQL connection in a Basic MSI project, the corresponding
properties are not automatically updated in the SQLLogin dialog in the Dialogs view. Therefore, you must manually change
the properties in the dialog to match the properties that selected on the Advanced tab of the SQL connection.

See Also
Specifying Whether New SQL Connections Should Share the Same Windows Installer Properties
SQL Scripts View

InstallShield 2020 User Guide ISP-2600-UG00 1181

Chapter 4
Configuring Servers

Specifying Whether New SQL Connections Should Share the Same Windows Installer
Properties
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI

InstallShield lets you specify whether new SQL database connections that you add to your project should share the same
Windows Installer properties by default.

For example, if you want connections to share the same default Windows Installer properties, you could add one
connection to your project in the SQL Scripts view, and specify a catalog name of MyConnection. If you add a second
connection to your project, InstallShield uses the same catalog name of MyConnection for that second connection. If you
change the catalog name of either connection, InstallShield automatically updates the catalog name of the other
connection, since both are based on the same Windows Installer property.

Task To specify whether SQL connections should share the same Windows Installer properties:

1. On the Tools menu, click Options. The Options dialog box opens.

2. Click the SQL Scripts tab.

3. Select or clear the Generate unique Windows Installer properties for new connections check box:

• To share Windows Installer properties between any new connections that you add, clear this check box.

• To use different Windows Installer properties for any new connections that you add, select this check box.

If you select the check box and then add a second connection to your project, InstallShield creates a new set of Windows
Installer properties for the second connection.

If you clear the check box and then add a second connection, InstallShield uses the default Windows Installer properties for
the second connection. The default Windows Installer properties are the ones that were added for the first connection that
you added to your project.

Tip • If you want to override a Windows Installer property for an existing connection, add a new property in the Property
Manager. Then, in the SQL Scripts view, select the connection. On the Advanced tab, select the name of the new property in the
appropriate list.

Project • For Basic MSI projects, the built-in SQLLogin dialog is designed to work with the default Windows Installer properties
for the first SQL connection that was added to the project. If you select the Generate unique Windows Installer property for
new connections option, you need to duplicate the dialog for each connection to work with the new Windows Installer
properties.

1182 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

See Also
Options Dialog Box
SQL Scripts View

Using the SQL Run-Time Functions in InstallScript and InstallScript MSI

Projects
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The InstallScript language includes many built-in SQL run-time (SQLRT) functions that begin with a prefix of SQLRT. Some
of the functions are available only in InstallScript projects, some are available only in InstallScript MSI projects, and some
are available in both project types.

The SQLRT functions require that you configure SQL information through the SQL Scripts view; the configuration
information is written to the SQLRT.ini file so that the SQL run-time functions work properly. For InstallScript projects, the
SQLRT functions are in the SQLRT.obl file, and they call the SQLRT.dll file. For InstallScript MSI projects, the SQLRT
functions are in the SQLCONV.obl file, and they call the ISSQLSRV.dll file. These support files are added automatically to
your project when you use the SQL Scripts view.

The SQLRTInitialize2 function initializes the SQL server run time. In InstallScript projects, the SQLRTInitialize2 function is
called automatically during the OnSQLServerInitialize event handler. In InstallScript MSI projects, the SQLRTInitialize2
function is called automatically during the OnSQLLogin event handler. If you need to call one of the SQLRT functions
before the OnSQLServerInitialize or OnSQLLogin events, you must first call the SQLRTInitialize2 function.

Note • In earlier versions of InstallShield, the SQLRTInitialize function was used to initialize the SQL server run time in
InstallScript projects. This function has been superseded by the SQLRTInitialize2 function.

See Also
SQL Functions
SQLRTInitialize2
OnSQLServerInitialize
OnSQLLogin

Adding a New SQL Connection

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript

InstallShield 2020 User Guide ISP-2600-UG00 1183

Chapter 4
Configuring Servers

• InstallScript MSI

In the SQL Scripts view, scripts are organized by connection, since no script can run on a server until a connection has been
established. Therefore, before you can add any SQL scripts to your project, you must first create a SQL connection.

Task To create a new SQL connection:

1. In the View List under Server Configuration, click SQL Scripts.

2. Right-click the SQL Scripts explorer and click New SQL Connection.

InstallShield adds a new connection in the explorer. Use the tabs in the right pane to configure the settings that are
associated with this connection.

Note • The SQLLogin and SQLBrowse dialogs let end users use alias names for connecting and browsing to SQL Server
databases.

Microsoft has released a new OLE DB provider called Microsoft OLE DB Driver for SQL Server (MSOLEDBSQL). Going forwar,
the new provider will be updated with the most recent server features. This provider also supports TLS 1.2 only
environments.

InstallShield 2019 R3 and later now uses MSOLEDBSQL as the default provider for all new SQL Server connections. This can
be changed by choosing different SQL Driver from 'Choose a Driver for Database Server' drop down present in the
Requirements tab.

Important • Microsoft OLE DB Driver for SQL Server (MSOLEDBSQL) is included as a prerequisite in InstallShield 2019 R3 and
later.

For more information, see Choose SQL Driver for Database Server in Requirements Tab.

See Also
Requirements for Connecting to Instances of SQL Server Express LocalDB
Overriding the Default TCP/IP Network Library with a Different Protocol for a SQL Server Database
SQL Scripts View

Overriding the Default TCP/IP Network Library with a Different Protocol for a SQL Server
Database
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

1184 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

By default, InstallShield installations use the TCP/IP network library when connecting to a SQL Server database. You can
override this default behavior as needed if you want to use a different protocol.

Task To override the default TCP/IP network library when connecting to a SQL Server database:

1. In the View List under Server Configuration, click SQL Scripts.

2. Right-click the SQL Scripts explorer and click New SQL Connection. InstallShield adds a new connection in the
explorer. Use the tabs in the right pane to configure the settings that are associated with this connection.

3. In the View List under Additional Tools, click Direct Editor.

4. In the Tables explorer, click the Property table.

5. Find the IS_SQLSERVER_NETLIB_MS field. The default value is:

Network Library=DBMSSOCN

DBMSSOCN refers to the name of the module for the TCP/IP network library, without the file extension.

6. Replace the default DBMSSOCN name as required. For example:

• To use the Named Pipes network library, specify DBNMPNTW.

• To use SPX/IPX, specify DBMSSPXN.

• To use Banyan Vines, specify DBMSVINN.

• To use Multi-Protocol (Windows RPC), specify DBMSRPCN.

At run time, the installation uses the protocol that you specified when connecting to a SQL Server database.

See Also
Direct Editor
SQL Scripts View

Requirements for Connecting to Instances of SQL Server Express LocalDB

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

If you want your installation to support connections to instances of SQL Server Express LocalDB, the target system must
have the SQL Server Native Client 11 ODBC driver. To ensure that it is present on target systems, you can include the
Microsoft SQL Server 2012 Native Client prerequisite in your installation. You also must configure your project to use the
driver.

InstallShield 2020 User Guide ISP-2600-UG00 1185

Chapter 4
Configuring Servers

Task To include the appropriate SQL Server Native Client prerequisite in your project for connecting to instances of SQL
Server Express LocalDB:

1. For Basic MSI and InstallScript MSI projects: In the View List under Application Data, click Redistributables.

For InstallScript projects: In the View List under Application Data, click Prerequisites.

2. In the list of redistributables, select the appropriate Microsoft SQL Server 2012 Native Client check box.

The InstallShield prerequisite is launched only if the conditions that are defined in the InstallShield prerequisite file (.prq)
are met. To see the list of conditions, click the SQL Server Native Client prerequisite in the Redistributables view or the
Prerequisites view, and then review the details that are listed in the details pane on the right. You can hide or show the
details pane by clicking the Show Details button in these views.

Task To configure your InstallShield installation project so that your installation uses the SQL Server Native Client 11 ODBC
driver:

1. In the View List under Additional Tools, click Direct Editor.

2. In the Tables explorer, click the ISSQLDBMetaData table.

3. In the ISSQLDBMetaData column, find the MSSQLServer row.

4. Replace the value of the AdoDriverName column with the following:

sqlncli11

At run time, the installation uses the SQL Server Native Client 11 ODBC driver when connecting to a SQL Server Express
LocalDB database.

See Also
Direct Editor
SQL Scripts View

Adding a New SQL Script

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

1186 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Task To add a new SQL script once you have created a new SQL connection:

1. In the View List under Server Configuration, click SQL Scripts.

2. Right-click the new connection and click New Script.

When you add a new script to your project, InstallShield adds a new component for the script. You must associate the script
with a feature. If one does not exist, the Create a New Feature dialog box opens when you add the SQL script, prompting
you to create a new feature. You can change the script-feature association later by using the Select Features the SQL
Script Belongs to area on the General tab in the SQL Scripts view for the SQL script.

Tip • You can also add scripts to your project by importing or inserting them. For more information, see Inserting and
Importing SQL Scripts.

Note • If you have Microsoft SQL Server Management Studio or Microsoft SQL Server 2000 SQL Query Analyzer installed on
your system, you can open a new SQL script that you have added to your project to test, edit, and syntax-check the script. To
launch one of those tools and open your script from within InstallShield, right-click the script file in the SQL Scripts view and
then click Open Script in Microsoft SQL Server Management Studio. InstallShield searches for one of the following tools and
launches the first one that it finds:

• Microsoft SQL Server 2008 Management Studio (any edition, including Express; ssms.exe)
• Microsoft SQL Server 2005 Management Studio (SqlWb.exe)
• Microsoft SQL Server 2005 Management Studio Express (ssmsee.exe)
• Microsoft SQL Server 2000 Query Analyzer (isqlw.exe)

See Also
Database Import Wizard
SQL Scripts View

Inserting and Importing SQL Scripts

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

InstallShield enables you to reuse SQL script files (.sql) in multiple projects. You can insert or import script files into a
project through the SQL Scripts view:

• Inserting a script file creates a link to the script file in its current location.

InstallShield 2020 User Guide ISP-2600-UG00 1187

Chapter 4
Configuring Servers

• Importing a script file copies the script file to the folder containing the script files for your project. The script files that
you import can be stored somewhere on your system, or they can be stored in a repository.

Inserting SQL Script Files

Task To insert a SQL script file:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, add a SQL connection if you have not already done so.

3. Right-click the SQL connection and then click Insert Script Files. The Open dialog box opens.

4. Select the SQL script file (.sql) that you want to insert.

5. Click Open.

Importing SQL Script Files

Task To import a SQL script file:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, add a SQL connection if you have not already done so.

3. Right-click the SQL connection and then click Import Script Files. The Import SQL Script Files Dialog Box opens.

4. Do one of the following:

• In the Repository Items box, click the SQL script file (.sql) that you want to add to your project.

• If the script file that you want to import is not stored in the repository, click the browse button to select it.

5. Click OK.

When you insert or import a new script to your project, InstallShield adds a new component for the script. You must
associate the script with a feature. If one does not exist, the Create a New Feature dialog box opens when you add the SQL
script, prompting you to create a new feature. You can change the script-feature association later by using the Select
Features the SQL Script Belongs to area on the General tab in the SQL Scripts view for the SQL script.

See Also
Importing a SQL Server Database and Generating a SQL Script File
Using a Repository to Share Project Elements

Importing a SQL Server Database and Generating a SQL Script File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

1188 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

• DIM
• InstallScript
• InstallScript MSI

Task To import an existing Microsoft SQL Server database and then generate a script file from it:

1. In the View List under Server Configuration, click SQL Scripts.

2. Right-click the SQL Scripts explorer and then click Database Import Wizard. The Database Import Wizard opens.

3. Complete the panels in the Database Import Wizard.

The Database Import Wizard will guide you through the process of importing your database settings and generating a SQL
script file based on those settings and other options that you determine.

Note • The import database functionality applies to the Microsoft SQL Server Database. The script generated by the Database
Import Wizard is not compatible with other database types.

Editing a SQL Script File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

Once you have created, inserted, or imported a script file, you can edit it from within InstallShield.

Project • In an InstallScript project, if you are working on a script that had overridden OnFirstUIBefore before upgrading to
InstallShield and it is not calling OnSQLServerInitialize, you should add that code to your script file.

Task To edit a script file in InstallShield:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, click the script file that you want to edit.

3. Click the Script tab, which displays the contents of your script file.

4. Edit the file as needed.

If you want to re-create your script each time that you build your project, you can select the Regenerate SQL Script at Build
check box on the Database Import tab for the script in the SQL Scripts view. A backup of any existing script file is always
saved first.

InstallShield 2020 User Guide ISP-2600-UG00 1189

Chapter 4
Configuring Servers

Note • If you have Microsoft SQL Server Management Studio or Microsoft SQL Server 2000 SQL Query Analyzer installed on
your system, you can open a new SQL script that you have added to your project to test, edit, and syntax-check the script. To
launch one of those tools and open your script from within InstallShield, right-click the script file in the SQL Scripts view and
then click Open Script in Microsoft SQL Server Management Studio. InstallShield searches for one of the following tools and
launches the first one that it finds:

• Microsoft SQL Server 2008 Management Studio (any edition, including Express; ssms.exe)
• Microsoft SQL Server 2005 Management Studio (SqlWb.exe)
• Microsoft SQL Server 2005 Management Studio Express (ssmsee.exe)
• Microsoft SQL Server 2000 Query Analyzer (isqlw.exe)

See Also
Working with the Script Editor Pane in Various Views
SQL Scripts View

Specifying a Version Number for a SQL Script File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

You can assign a schema version number to a SQL script file after you have a created or imported a script file in the SQL
Scripts view. Specifying schema version information helps you to trigger the launching of the SQL script only when it is
appropriate.

Task To specify the schema version for your SQL script file:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, click the SQL script that you want to configure.

3. Click the General tab.

4. In the Schema Version (xxxxx.xxxxx.xxxxx.xxxxx) box, type the schema version number for your SQL script

The installation checks the current schema version that is on the target database. The schema version is stored in the
ISSchema column of the custom table named InstallShield. When you specify a schema version for a SQL script, the
installation runs the script only if the script schema version number is greater than the current schema version number.
Once the script is executed, the installation updates the current schema version on the target database to reflect the new
schema version number.

If you do not specify a schema version number for a SQL script, the script is always launched.

1190 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

For example, your installation may create a new connection to a database called TestDB and then create a script that is
called TestScript and that has a schema version number of 12345.54321.12345.54321. The installation creates the
custom InstallShield table in the TestDB database and stores the schema version in the ISSchema column of that table.
If another installation is run on that system, and this installation also has a SQL script called TestScript, the SQL script is
executed only if the schema version number of this other script is greater than the version number that is stored in the
ISSchema column in the InstallShield table of the target database. If the script is executed, the installation updates the
ISSchema column with the new schema version number.

Tip • When you specify a number for the Schema Version setting and InstallShield adds the custom InstallShield table for
storing the schema version number on the target database, the data is not automatically removed upon uninstallation.
Therefore, if you want the installation to be able to roll back the changes, you need to create a custom script upon
uninstallation to drop the InstallShield table.

Specifying the Order for Running Multiple SQL Scripts That Are Associated
with a Connection
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

If you add more than one SQL script to a SQL connection in your project, you can specify the order in which the installation
runs those SQL scripts on the target machine. The procedure for specifying the order differs for Windows Installer–based
and InstallScript-based projects.

Specifying the SQL Script Order in Basic MSI, DIM, and InstallScript MSI Projects
The order in which a connection’s SQL scripts are listed in the SQL Scripts view of a Basic MSI, DIM, and InstallScript MSI
project is the order in which the installations run the SQL scripts. For example, if you create a connection in the SQL Scripts
view and add two SQL scripts to that connection, the script that is listed first under the SQL connection is the one that the
installation runs first.

Task To change the order in which a connection’s SQL scripts are run:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, right-click the SQL script that you want to move and click Move Up or Move Down.

The next time that you build and run the installation, the order is updated.

InstallShield 2020 User Guide ISP-2600-UG00 1191

Chapter 4
Configuring Servers

Specifying the SQL Script Order in InstallScript Projects

By default for InstallScript installations, batch mode for SQL scripts is disabled; therefore, the order in which a
connection’s SQL scripts are run corresponds with the order in which the installation processes the associated
components.

If you want to be able to override this default behavior and specify a particular order for running the SQL scripts, you can do
so by enabling the batch mode in the SQL Scripts view.

Task To enable or disable batch mode:

1. In the View List under Server Configuration, click SQL Scripts.

2. Right-click the SQL Scripts explorer and click Batch Mode.

Batch mode is enabled if the Batch Mode command has a check mark; it is disabled if the command does not have a check
mark.

The SQLRTGetBatchList function returns the list of components that are associated with SQL scripts that need to be run
when batch mode is enabled. For more information, see SQLRTGetBatchList.

Overriding the Default SQL Run-Time Behavior

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI

You can define the following Windows Installer properties to override default run-time behavior:

Table 4-2 • Windows Installer Properties for SQL

Property Description

IS_SQLSERVER_CONNECTIONS_TO_VALIDATE Overrides the connections that will be tested when

clicking the Next button on the SQLLogin dialog. Specify
multiple connections by separating each with a semicolon.
By default, all the connections in the ISSQLConnection
table will be validated.

IS_SQLSERVER_CXNS_ABSENT_FROM_INSTALL Specifies one or more SQL connections that should be

skipped during installation or uninstallation. To specify
more than one SQL connection, separate each with a
semicolon (;). To skip all of the SQL connections, set the
value of this property to ALL. Using this property is helpful
if you cannot uninstall a product because of a SQL
scripting error.

1192 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Table 4-2 • Windows Installer Properties for SQL (cont.)

Property Description

IS_SQLSERVER_DO_NOT_USE_REG Specifies not to use the stored SQL Server login

information written in the registry. Since the SQLLogin
dialog is not displayed in maintenance and uninstall
modes, the installation stores the login information that is
specified during installation. If you do not want this
behavior, set the IS_SQLSERVER_DO_NOT_USE_REG
property.

IS_SQLSERVER_LOCAL_ONLY Specifies to show only the local SQL Server in the SQL
Server browse combo box and list box controls.

Note • To show only the local SQL Server and either remote
SQL Servers or SQL Server aliases, you can set the
IS_SQLSERVER_LOCAL_ONLY property, as well as either the
IS_SQLSERVER_REMOTE_ONLY property or the
IS_SQLSERVER_ALIAS_ONLY property.

IS_SQLSERVER_REMOTE_ONLY Specifies to show only the remote SQL Servers in the SQL
Server browse combo box and list box controls.

Note • To show only the remote SQL Servers and either the
local SQL Server or SQL Server aliases, you can set the
IS_SQLSERVER_REMOTE_ONLY property, as well as either the
IS_SQLSERVER_LOCAL_ONLY property or the
IS_SQLSERVER_ALIAS_ONLY property.

IS_SQLSERVER_ALIAS_ONLY Specify to show only the SQL Server aliases in the SQL
Server browse combo box and list box controls.

Note • To show only the SQL Server aliases and either the
local SQL Server or remote SQL Servers, you can set the
IS_SQLSERVER_ALIAS_ONLY property, as well either the
IS_SQLSERVER_LOCAL_ONLY property or the
IS_SQLSERVER_REMOTE_ONLY property.

Project • For Basic MSI projects, all connections are linked to the SQLLogin dialog. To display multiple SQLLogin dialogs, you
can copy the SQL dialogs from the Dialogs view and modify their behavior and events similar to the default SQL dialogs.
Remember to create new properties, and set them in the connection’s Advanced tab of the SQL Scripts view. You can use those
new properties when you modify the copies of the SQL dialogs that you made.

InstallShield 2020 User Guide ISP-2600-UG00 1193

Chapter 4
Configuring Servers

See Also
Using Windows Installer Properties for SQL Login Settings
Specifying Whether New SQL Connections Should Share the Same Windows Installer Properties
SQL Scripts View

Handling SQL Run-Time Errors

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

Task To set SQL script error-handling properties in the interface:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, click the SQL script file for which you want to add error handling.

3. Click the Runtime tab.

4. In the Script Error Handling area, select one of the options listed, or click the Custom button to override the script’s
default error handling. Available options are:

• On Error, Goto Next Script

• On Error, Goto Next Statement

• On Error, Abort Installation

See Also
SQL Scripts View

Setting Up a Database Server Type Condition for SQL Scripts

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

1194 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

InstallShield enables you to create a single connection that targets both Microsoft SQL Server and MySQL and that has
multiple SQL scripts specific to each database server technology. However, a connection is created based on whichever
database type is detected first. Therefore, scripts are run only for the detected database type, and the scripts that are
specific to the non-detected database server type fail. For example, if the run time detects a Microsoft SQL Server, then the
scripts associated with Microsoft SQL Server run, and the scripts that are specific to MySQL fail.

As a workaround to this behavior, it is recommended that you set a condition in your SQL script so that a SQL scripting
error occurs when the installation is running a non-detected database server type script. Then you can set up custom error
handling for the scripting error and skip to the next script for the connection. The following instructions discuss how you
can set this database server type condition for scripts.

Task To set up a database server type condition for a script that targets Microsoft SQL Server:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, click the script file for which you are creating the condition.

3. Click the Script tab.

4. Add the following statement at the beginning of the script:

SELECT @@ROWCOUNT

5. Click the Runtime tab.

6. In the Script Error Handling area, click the Custom button. The Custom Error Handling dialog box opens.

7. Click the Click here to add a new item row.

8. In the Error Number column, type 1193. This is the error number that MySQL returns when it does not have the
specified system variable that you added at the beginning of the script.

9. In the Behavior column, click On Error, Goto Next Script.

10. In the Project Wide column, click No.

11. Click OK.

Task To set up a database server type condition for a script that targets MySQL:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, click the script file for which you are creating the condition.

3. Click the Script tab.

4. Add the following statement at the beginning of the script:

SELECT @@table_cache

5. Click the Runtime tab.

6. In the Script Error Handling area, click the Custom button. The Custom Error Handling dialog box opens.

7. Click the Click here to add a new item row.

InstallShield 2020 User Guide ISP-2600-UG00 1195

Chapter 4
Configuring Servers

8. In the Error Number column, type 137. This is the error number that Microsoft SQL Server returns when it does not
have the specified system variable that you added at the beginning of the script.

9. In the Behavior column, click On Error, Goto Next Script.

10. In the Project Wide column, click No.

11. Click OK.

Conditionally Launching a SQL Script in a Windows Installer-Based

Installation
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI

You may want your installation to launch a SQL script only if certain conditions are met on the target system. For example,
your SQL script may require that the end user have administrator rights. If an end user does not have administrator rights,
the SQL script is not launched.

Task To create a SQL script condition:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, click the script file for which you are creating the condition.

3. Click the Runtime tab.

4. In the Script Condition area, select the Specify a Conditional Statement check box.

5. Click the ellipsis button (...). The Condition Builder dialog box opens.

6. Create one or more conditions.

The SQL scripts are tied to component states. The condition that is set in the SQL Scripts view is the condition for the SQL
script’s component. If the component conditions are met on the target system, the installation installs the SQL script. If the
installation installs a SQL script that you did not expect to be installed on a target system, generating a log file for your
installation may help you determine why the SQL script was installed.

Tip • For information on conditions and on condition syntax, see Building Conditional Statements and Conditional Statement
Syntax.

See Also
Condition Builder Dialog Box

1196 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Conditionally Launching a SQL Script in an InstallScript Installation

InstallShield 2020

Project • This information applies to InstallScript projects.

You may want your installation to launch a SQL script only if certain conditions are met on the target system.

InstallShield generates a set of default global event handlers, each of which is a function scripted in the InstallScript
language. The following SQL-related events are automatically called by the InstallShield framework:

• OnSQLServerInitialize

• OnSQLComponentInstalled

OnSQLServerInitialize is called by OnFirstUIBefore, and OnSQLComponentInstalled is called during file transfer, for each
component installed.

Note • If you are working on a script that had overridden OnFirstUIBefore before upgrading to InstallShield and it is not
calling OnSQLServerInitialize, you should add that code to your script file.

In your script, you can modify OnSQLServerInitialize and OnSQLComponentInstalled to perform checks for different things.
For example, you can check for a user with administrator rights in the sample code below.

function OnSQLComponentInstalled(szComponent)
string sMessage;
string sData;
number nResult;
begin

if( Is( USER_ADMINISTRATOR, sData ) ) then

nResult = SQLRTComponentInstall( szComponent );

if( nResult = SQL_ERROR_ABORT ) then

sMessage = SdLoadString( IDS_IFX_SQL_ERROR_RUN_FAILED );

MessageBox( sMessage, MB_OK );
abort;

endif;
else
//User does not have administrator rights, so we do not run scripts
endif;
end;

Note • You can configure the behavior for script failure in the InstallShield interface when you click a SQL script in the SQL
Scripts explorer, and then go to the Runtime tab. The Script Error Handling section lets you select one of the following options:

• On Error, Go to Next Script

• On Error, Go to Next Statement
• On Error, Abort Installation

InstallShield 2020 User Guide ISP-2600-UG00 1197

Chapter 4
Configuring Servers

See Also
SQL Scripts View

Requiring that SQL Scripts Be Run Only Against a Full SQL Server
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

Installations that include SQL script support allow end users to run the SQL scripts on Microsoft SQL Server Desktop Engine
(MSDE) and on SQL Server Express Edition, by default. If you want end users to be able to run SQL scripts on only a full SQL
Server, you can use the SQL Scripts view to configure that for any database connection in your installation.

Task To prevent your SQL script files from running on target systems that have MSDE or SQL Server Express Edition:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, click the SQL connection that you want to configure.

3. On the Requirements tab, clear the Allow Installation to Microsoft SQL Server Desktop Engine/SQL Server
Express check box.

Using Windows Installer Properties to Dynamically Replace Strings in SQL

Scripts
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI

For Basic MSI, DIM, and InstallScript MSI projects, you can specify a replacement for text in a SQL script at run time through
the use of Windows Installer properties. This enables you to let end users specify information that is then used in the SQL
script that is launched on the target system. Windows Installer uses MsiFormatRecord to resolve the properties in the SQL
script at run time.

1198 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Example
The following procedure demonstrates how to create a database at run time using a custom SQL script that contains
information that end users enter on the built-in SQL login dialog: the SQLLogin dialog in a Basic MSI installation or the
SQLServerSelectLogin2 dialog in an InstallScript MSI installation. Windows Installer properties are used for the database
name and its target location.

Task To create a database using a SQL script that contains information that end users specify at run time:

1. In the View List under Server Configuration, click SQL Scripts.

2. Right-click the SQL Scripts explorer and click New SQL Connection. InstallShield adds a new SQL connection.

3. Click the SQL connection, and then click the General tab.

4. Clear the Create Catalog If Absent check box.

5. In the SQL Scripts explorer, right-click the new connection and click New Script. InstallShield adds a new SQL script
to the SQL connection.

6. Click the SQL script, and then click the Script tab.

7. In the script pane, enter the following:

if not exists(select name from master.dbo.sysdatabases where name = '%DBNAME%')

begin
CREATE DATABASE %DBNAME%
ON
( NAME = %DBNAME%_dat,
FILENAME = '%DBPATH%%DBNAME%dat.mdf',
SIZE = 10,
MAXSIZE = 50,
FILEGROWTH = 5 )
LOG ON
( NAME = %DBNAME%_log,
FILENAME = '%DBPATH%%DBNAME%log.ldf',
SIZE = 5MB,
MAXSIZE = 25MB,
FILEGROWTH = 5MB ) ;
end
GO

8. Configure two text replacements for the SQL script:

a. Click the Text Replacement tab, and then click the Add button. The Find and Replace dialog box opens.

b. In the Find What box, type the following:

%DBNAME%

c. In the Replace What box, type the following:

[IS_SQLSERVER_DATABASE]

d. Click OK. The Find and Replace dialog box closes.

e. Click the Add button. The Find and Replace dialog box opens.

f. In the Find What box, type the following:

InstallShield 2020 User Guide ISP-2600-UG00 1199

Chapter 4
Configuring Servers

%DBPATH%

g. In the Replace What box, type the following:

[INSTALLDIR]

h. Click OK. The Find and Replace dialog box closes.

9. Click the Runtime tab.

10. Clear the Run Script During Install check box and select the Run Script During Login check box.

11. Build your release.

See Also
MsiFormatRecord (Windows Installer Help Library)
MsiFormatRecord (Windows Installer Help Library)
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
Working with Dialogs in Basic MSI Projects
Working with Dialogs in InstallScript and InstallScript MSI Projects
Dialog Functions
Dialog Customization Functions

Using InstallScript Text Substitution to Dynamically Replace Strings in SQL

Scripts
InstallShield 2020

Project • This information applies to InstallScript projects.

For InstallScript projects, you can specify a replacement for text in a SQL script at run time through the use of text
substitution string variables. This enables you to let end users specify information that is then used in the SQL script that is
launched on the target system. The InstallScript run-time code uses the TextSubSubstitute function to replace the string
variable with the appropriate value in the SQL script.

Example
The following procedure demonstrates how to create a database at run time using a custom SQL script that contains
information that end users enter on the SQLServerSelectLogin2 dialog. InstallScript text substitution is used for the
database name and its target location.

Task To create a database using a SQL script that contains information that end users specify at run time:

1. In the View List under Server Configuration, click SQL Scripts.

2. Right-click the SQL Scripts explorer and click New SQL Connection. InstallShield adds a new SQL connection.

3. Click the SQL connection, and then click the General tab.

4. Clear the Create Catalog If Absent check box.

5. In the SQL Scripts explorer, right-click the new connection and click New Script. InstallShield adds a new SQL script
to the SQL connection.

1200 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

6. Click the SQL script, and then click the Script tab.

7. In the script pane, enter the following:

if not exists(select name from master.dbo.sysdatabases where name = '%DBNAME%')

begin
CREATE DATABASE %DBNAME%
ON
( NAME = %DBNAME%_dat,
FILENAME = '%DBPATH%\%DBNAME%dat.mdf',
SIZE = 10,
MAXSIZE = 50,
FILEGROWTH = 5 )
LOG ON
( NAME = %DBNAME%_log,
FILENAME = '%DBPATH%\%DBNAME%log.ldf',
SIZE = 5MB,
MAXSIZE = 25MB,
FILEGROWTH = 5MB ) ;
end
GO

8. Configure two text replacements for the SQL script:

a. Click the Text Replacement tab, and then click the Add button. The Find and Replace dialog box opens.

b. In the Find What box, type the following:

%DBNAME%

c. In the Replace What box, type the following:

<MYDATABASENAME>

d. Click OK. The Find and Replace dialog box closes.

e. Click the Add button. The Find and Replace dialog box opens.

f. In the Find What box, type the following:

%DBPATH%

g. In the Replace What box, type the following:

<TARGETDIR>

h. Click OK. The Find and Replace dialog box closes.

9. Click the Runtime tab.

10. Clear the Run Script During Install check box and select the Run Script During Login check box.

11. In the View List under Behavior and Logic, click InstallScript.

12. Find the dialog code in the OnSQLServerInitialize event for the dialog that should contain the Database Name control,
and add a call to the InstallScript function TextSubSetValue. For example, if you want the user name to be the name
that the end user specifies on the SQLServerSelectLogin2 dialog, you would add a TextSubSetValue call as shown in
the following lines of code:

// Display login dialog (without connection name)

// UNCOMMENT OUT TO SWAP DIALOGS

InstallShield 2020 User Guide ISP-2600-UG00 1201

Chapter 4
Configuring Servers

// nResult = SQLServerSelectLogin2( szConnection, szServer, szUser, szPassword,

bWinLogin, szDB, FALSE, TRUE );

// Display login dialog (with connection name)

// COMMENT OUT TO SWAP DIALOGS
nResult = SQLServerSelectLogin2( szConnection, szServer, szUser, szPassword, bWinLogin,
szDB, TRUE, TRUE );
TextSubSetValue ("<MYDATABASENAME>", szDB, FALSE);

13. Build your release.

See Also
Text Substitutions
Working with Dialogs in InstallScript and InstallScript MSI Projects
Dialog Functions
Dialog Customization Functions

Requiring a SQL Server-Side Installation for a Windows Installer-Based

Project
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI

One way to configure your installation so that it runs only on SQL Server machines is to perform a system search for registry
information, store the result in a property, and then use the property in a condition that you set. The following step-by-step
instructions show how to do this.

Task To configure a Windows Installer–based installation to run only on SQL Server machines:

1. In the View List under Behavior and Logic, click System Search.

2. Right-click the grid and click Add. The System Search Wizard opens.

3. In the What do you want to find panel, click Registry entry and click Next.

4. In the How do you want to look for it panel, do the following:

a. In the Registry Root list, click HKEY_LOCAL_MACHINE.

b. In the Registry Key box, type the following text:

Software\Microsoft\Microsoft SQL Server

c. In the Registry Value box, type the following text:

InstalledInstances

d. Click Next.

1202 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

5. In the What do you want to do with the value panel, do the following:

a. In the Store the value in this property box, type the following:

SQLSERVERFOUND

b. In the Additional Options area, select the Store the value in the property and use the property in an Install
Condition option.

c. Click Finish. The Condition Builder opens.

6. Verify the condition, and type a message that you want end users to see if the registry entry is not found on the system.
For example, you can type the following message:

Microsoft SQL Server was not found on this machine. This installation was designed to run only on the
server machine.

7. Click OK.

InstallShield adds an entry to the System Search grid.

See Also
Requiring a Server-Side Installation for an InstallScript Project
SQL Scripts View

Requiring a Server-Side Installation for an InstallScript Project

InstallShield 2020

Project • This information applies to InstallScript projects.

One way to enforce a server-side installation in an InstallScript project is to set up your installation project so that it
searches for a specific registry key and value and only installs the installation project if the value is found. See the sample
code below for an example of how you can do this in your InstallScript project.

function OnBegin()
string sKey, sValue, sData;
string sMsg;
number nType, nSize, nResult;
begin

RegDBSetDefaultRoot( HKEY_LOCAL_MACHINE );
sKey = "Software\\Microsoft\\Microsoft SQL Server";
sValue = "InstalledInstances";
nResult = RegDBGetKeyValueEx( sKey, sValue, nType, sData, nSize );

if( nResult < 0 ) then

//SQL Server registry key is missing

sMsg = "Microsoft SQL Server was not found on this machine.\n" +
"This installation was designed to run only on the server machine.";
MessageBox( sMsg, SEVERE );
abort;

endif;

InstallShield 2020 User Guide ISP-2600-UG00 1203

Chapter 4
Configuring Servers

end;

See Also
Requiring a SQL Server-Side Installation for a Windows Installer-Based Project
SQL Scripts View

Publishing SQL Script Files to a Repository

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

If you have an existing SQL script file that you would like to reuse in other projects or share with other users, you can
publish it to a repository.

Task To publish a SQL script file to a repository:

1. In the View List under Server Configuration, click SQL Scripts.

2. In the SQL Scripts explorer, right-click the script file that you would like to publish, and then click Publish Wizard. The
Publish Wizard opens.

3. Complete the panels in the Publish Wizard.

After you have imported a script file from a repository into a project, there is no link between the current script file and the
existing repository script file. If you make a change to the script file and then republish it to the repository, it does not affect
the script file in the project to which it was imported. However, you can reimport the script file from the repository into
your project.

See Also
Inserting and Importing SQL Scripts
Using a Repository to Share Project Elements

Installing the MySQL ODBC Driver

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

1204 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

If you want to install and launch the MySQL ODBC driver before your installation is run, you can include the InstallShield
prerequisite for MySQL Connector 3.51 in your project.

Task To install and launch the MySQL ODBC driver before your installation is run:

1. For Basic MSI and InstallScript MSI projects: In the View List under Application Data, click Redistributables.

For InstallScript projects: In the View List under Application Data, click Prerequisites.

2. In the list of redistributables, select the MySQL Connector ODBC 3.51 check box.

Tip • The MySQL Connector ODBC 3.51 prerequisite is available only if you have downloaded the installer and added the
InstallShield prerequisite to your system. For detailed instructions, see Including the MySQL Connector ODBC Prerequisite.

See Also
Working with InstallShield Prerequisites that Are Included in Installation Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects

Deleting a SQL Server Database During Uninstallation

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

Note • You cannot delete a database to which you are currently connected.

If you need to remove a SQL database during uninstallation, you can do so through your SQL script. The following
procedure demonstrates how to configure your project and SQL script to delete a Microsoft SQL Server database.

Task To remove a Microsoft SQL Server database during uninstallation:

1. In the View List under Server Configuration, click SQL Scripts.

2. Add a SQL connection.

3. On the General tab, in the Catalog Name box, type Master.

Master is the name of the system database that exists on all Microsoft SQL Server systems; since you cannot delete a
database to which you are currently connected, you can connect to the Master database and then delete a different
database to which you are not connected.

InstallShield 2020 User Guide ISP-2600-UG00 1205

Chapter 4
Configuring Servers

4. Enter the authentication information for the server.

5. Add a new SQL script file.

6. Add the following to the SQL script file:

DROP DATABASE DatabaseName

GO

DatabaseName is the name of the database that you want to delete.

Tip • As an alternative to the aforementioned procedure, you can perform the same operation completely in SQL script. To do
so, enter the following code in your SQL script:

USE Master
DROP DATABASE DatabaseName
GO

DatabaseName is the name of the database that you want to delete.

Connecting to a Microsoft Windows Azure Database Server and Running SQL

Scripts
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Target for Connecting to a Microsoft Windows Azure SQL Database Server

Connecting to a Microsoft Windows Azure SQL database server requires the SQL Server Native Client 10.0 ODBC driver on
target system that are running the installation. To ensure that this driver is available on target systems, you can include the
InstallShield prerequisite for Microsoft SQL Server 2008 Native Client 10.00.2531 in your project.

Task To include the Microsoft SQL Server 2008 Native Client 10.00.2531 prerequisite in your project:

1. For Basic MSI and InstallScript MSI projects: In the View List under Application Data, click Redistributables.

For InstallScript projects: In the View List under Application Data, click Prerequisites.

2. In the list of redistributables, select the appropriate Microsoft SQL Server 2008 Native Client 10.00.2531 check box
or check boxes, depending on whether the architecture of target systems is 32 bit or 64 bit.

The InstallShield prerequisite is launched only if the conditions that are defined in the InstallShield prerequisite file (.prq)
are met. To see the list of conditions, click the SQL Server Native Client prerequisite in the Redistributables view or the
Prerequisites view, and then review the details that are listed in the details pane on the right. You can hide or show the
details pane by clicking the Show Details button in these views.

1206 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Specifying the User Name for the Windows Azure SQL Database Connection at Run-
Time
If you use the SQLLogin dialog in your installation and your installation is targeting a Windows Azure SQL database, end
users should use the following format to enter a string in the Login ID box on the SQLLogin dialog:

DatabaseUserName@ServerName

Following is an example:

MyUserName@wbzdh64drd

See Also
Adding a New SQL Connection

Connecting to an Instance of Oracle and Running SQL Scripts

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Note • If you want your installation to download the Oracle 11g Instant Client whenever it needs to be installed on a target
system, check with Oracle to ensure that it is allowed. If it is allowed, you must host the download on your own Web site and
add its download path to the InstallShield prerequisite. Revenera does not make this installation available for download.

Connecting to an instance of Oracle requires the following elements on the end-user machine that is running the
installation:

• Microsoft ODBC for Oracle

• 32-bit version of the Oracle Instant Client software (even on 64-bit target systems)

The latest Microsoft Data Access Components (MDAC) include support for the Microsoft ODBC for Oracle drivers. However,
the Microsoft ODBC for Oracle driver requires Oracle Instant Client software to communicate with Oracle database servers.
Therefore, you may want to include the Oracle 11g Instant Client prerequisite to help configure the Oracle Instant Client on
target machines upon installation. Oracle does not provide an installation for the files; you can do so easily by using the
Oracle Instant Client installation project that is available in the InstallShield Program Files folder. For instructions, see
Downloading the Oracle Instant Client and Creating an .msi Package for It.

Note that if your SQL script contains Unicode characters, you may want to use the Oracle ODBC Instant Client, since it has
support for running SQL scripts that contain Unicode characters, but Microsoft ODBC for Oracle does not. You may want to
include an ODBC Instant Client installation with the Oracle 11g Instant Client prerequisite to help configure the Oracle
Instant Client on target machines, and to also set up the ODBC Instant Client. For more information, see Downloading the
Oracle Basic Instant Client and the Oracle ODBC Instant Client and Creating an .msi Package and InstallShield Prerequisite
for Both. If you plan on using the ODBC Instant Client instead of Microsoft ODBC for Oracle, ensure that you configure your
project accordingly. For more information, see Running SQL Scripts with Unicode Characters on an Oracle Database
Server.

InstallShield 2020 User Guide ISP-2600-UG00 1207

Chapter 4
Configuring Servers

Downloading the Oracle Instant Client and Creating an .msi Package for It
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Before you can add Oracle 11g Instant Client support to your Basic MSI, InstallScript, or InstallScript MSI project, you must
download the Oracle Instant Client from Oracle’s Web site. Oracle does not provide an installation for the files, so you also
need to create an .msi package; you can do so easily by using the Oracle Instant Client installation project that is available
in the InstallShield Program Files folder.

Once you have created the .msi package, you can add it to the appropriate folder on your machine, and then add the
InstallShield prerequisite that uses this Oracle Instant Client .msi package.

Note • Note that if your SQL script contains Unicode characters, you may want to use the Oracle ODBC Instant Client, since it
has support for running SQL scripts that contain Unicode characters, but Microsoft ODBC for Oracle does not. You may want to
include an ODBC Instant Client installation with the Oracle 11g Instant Client prerequisite to help configure the Oracle Instant
Client on target machines, and to also set up the ODBC Instant Client. For more information, see Downloading the Oracle Basic
Instant Client and the Oracle ODBC Instant Client and Creating an .msi Package and InstallShield Prerequisite for Both.

Task To download the Oracle Instant Client and create an .msi package:

1. Visit http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html and download the

11.1.0.x version of the Oracle Instant Client (the Basic package for 32-bit Windows platforms). The download file is
called instantclient-basic-win32-11.1.0.7.0.zip.

Important • The Oracle support in InstallShield requires that the target system have the 32-bit version of the Oracle
Instant Client, regardless of whether the target system is a 32-bit or 64-bit system.

2. Unzip the files to the root of your C drive. Unzipping the files adds all of the files to the following location:

C:\instantclient_11_1

3. Open the Oracle Instant Client installation project in InstallShield. The path for the project is as follows:

InstallShield Program Files Folder\Support\Oracle Instant Client\instantclient-win32-11_1.ism

Revenera created this project for the 11.1.0.7 version of the Oracle Instant Client; however, you can use this same
project for more-recent versions of the Oracle 11g Instant Client, such as 11.2.01, for example.

4. The name that is displayed at run time during the Oracle 11g Instant Client installation is Oracle11g Instant Client
11.1.0.7; this name is also used for the .msi file. If you want to change this name to something else to reflect a different
version number, such as 11.2.0.1 or 11.2.0.x, you can do so:

a. In the View List under Installation Information, click General Information.

1208 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

b. In the Product Name setting, edit the existing text as needed.

5. If you are using a version that was released after 11.1.0.7 and it requires any dependencies, add the files or merge
modules to the project.

6. On the toolbar, click the Build button.

InstallShield builds an Oracle 11g Instant Client .msi file and adds it to the following directory so that you can include the
Oracle 11g Instant Client in your InstallShield projects:

InstallShield Program Files Folder\SetupPrerequisites\oracle

Tip • If you are using a version that was released after 11.1.0.7, open the Oracle 11g Instant Client 11.1.0.7 prerequisite in the
InstallShield Prerequisite Editor. Rename the prerequisite to reflect the appropriate version number. In addition, update the
conditions to reflect the appropriate version number.

For instructions on how to add the Oracle 11g Instant Client to installations, see Installing the Oracle 11g Instant Client.

See Also
Modifying an Existing InstallShield Prerequisite
Setting Installation Conditions for an InstallShield Prerequisite

Downloading the Oracle Basic Instant Client and the Oracle ODBC Instant Client and Creating
an .msi Package and InstallShield Prerequisite for Both
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

Before you can add support for the Oracle 11g Instant Client and the Oracle ODBC Instant Client to your Basic MSI,
InstallScript, or InstallScript MSI project, you must download the Oracle Basic Instant Client and the Oracle ODBC Instant
Client from Oracle’s Web site. Oracle does not provide an installation for the files, so you also need to create an .msi
package; you can do so easily by using the Oracle Instant Client installation project that is available in the InstallShield
Program Files folder.

Once you have created the .msi package, you can add it to the appropriate folder on your machine, and then add the
InstallShield prerequisite that uses this Oracle .msi package.

Task To download the Basic Instant Client and the ODCBC Instant Client and create an .msi package:

1. Visit http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html and download the

11.1.0.x version of the Oracle Instant Client (the Basic package for 32-bit Windows platforms), as well as the 11.1.0.x

InstallShield 2020 User Guide ISP-2600-UG00 1209

Chapter 4
Configuring Servers

version of the Instant Client Package for ODBC. The download files are called instantclient-basic-win32-
11.1.0.7.0.zip and instantclient-odbc-win32-11.1.0.7.0.zip.

Important • The Oracle support in InstallShield requires that the target system have the 32-bit version of the Basic
Instant Client and of the ODBC Instant Client, regardless of whether the target system is a 32-bit or 64-bit system.

2. Unzip the files to the root of your C drive. Unzipping the files adds all of the files to the following location:

C:\instantclient_11_1

Ensure that the files are not unzipped to C:\instantclient11_1\instantclient11_1.

3. Make a copy of the Oracle Instant Client installation project. The path for the project is as follows:

InstallShield Program Files Folder\Support\Oracle Instant Client\instantclient-win32-11_1.ism

Name the copy instantclient-win32-odbc11_1.ism, and put it in the same directory as the original .ism file. The
path for this new file is:

InstallShield Program Files Folder\Support\Oracle Instant Client\instantclient-win32-odbc11_1.ism

Revenera created the instantclient-win32-11_1.ism project for the 11.1.0.7 version of the Oracle Instant Client;
however, you can use this same project for more-recent versions of the Oracle 11g Instant Client and ODBC Instant
Client, such as 11.2.01, for example.

4. Open the new project that you created in InstallShield.

5. Update the product code, the upgrade code, and the product name:

a. In the View List under Installation Information, click General Information.

b. In the Product Code setting, click the Generate a new GUID button ({..}).

c. In the Upgrade Code setting, click the Generate a new GUID button ({..}).

d. In the Product Name setting, change the existing text as needed.

Oracle11g Instant Client - ODBC 11.1.0.7

The name that you enter is displayed at run time during the Oracle installation. If you want to change this name
to something else to reflect a different version number, such as 11.2.0.1 or 11.2.0.x, you can do so.

6. If you are using a version that was released after 11.1.0.7 and it requires any dependencies, add the files or merge
modules to the project.

7. Add a custom action that launches the ODBC Instant Client installation:

a. In the View List under Behavior and Logic, click Custom Actions and Sequences.

b. In the center pane, right-click the Custom Actions explorer, point to New EXE, and click Path referencing a
directory. InstallShield adds a new custom action.

c. Configure the custom action’s settings in the right pane as follows:

• Working Directory: INSTALLDIR

• Filename & Command Line: [INSTALLDIR]odbc_install.exe

• In-Script Execution: Deferred Execution in System Context

1210 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

• Install Exec Sequence: After InstallODBC

• Install Exec Condition: Not Installed

8. Add a custom action that uninstalls the ODBC Instant Client when end users uninstall the Instant Client:

a. In the View List under Behavior and Logic, click Custom Actions and Sequences.

b. In the center pane, right-click the Custom Actions explorer, point to New EXE, and click Path referencing a
directory. InstallShield adds a new custom action.

c. Configure the custom action’s settings in the right pane as follows:

• Working Directory: INSTALLDIR

• Filename & Command Line: [INSTALLDIR]odbc_uninstall.exe

• In-Script Execution: Deferred Execution in System Context

• Install Exec Sequence: After RemoveODBC

• Install Exec Condition: REMOVE="ALL"

9. Specify a name for the .msi package file:

a. In the View List under Media, click Releases.

b. In the center pane, in the Releases explorer, click the product configuration called Product Configuration 1.

c. In the MSI Package File Name setting, enter the following name:

Oracle11g Instant Client - ODBC 11.1

InstallShield will use the name that you enter for the .msi package that it creates for the Basic Instant Client and
ODBC Instant Client. This is the file that will be launched by the InstallShield prerequisite that you create.

10. On the toolbar, click the Build button.

InstallShield builds an Oracle .msi file and adds it to the following directory so that you can include the Oracle11g Instant
Client - ODBC 11.1.msi file in your InstallShield projects:

InstallShield Program Files Folder\SetupPrerequisites\oracle

Task To create an InstallShield prerequisite that launches the .msi package that you created in the aforementioned
procedure:

1. Make a copy of the existing InstallShield prerequisite (.prq) for the Oracle11g Instant Client. The path for the
prerequisite is as follows:

InstallShield Program Files Folder\SetupPrerequisites\Oracle11g Instant Client 11.1.0.7.prq

Name the copy Oracle11g Instant Client - ODBC 11.1.0.7.prq, and put it in the same directory as the original
.prq file. The path for this new file is:

InstallShield Program Files Folder\SetupPrerequisites\Oracle11g Instant Client - ODBC 11.1.0.7.prq

2. On the Tools menu, click Prerequisite Editor. The InstallShield Prerequisite Editor opens.

3. On the File menu, click Open. The Open dialog box opens.

4. Browse to the new Oracle11g Instant Client - ODBC 11.1.0.7.prq file, and then click the Open button.

InstallShield 2020 User Guide ISP-2600-UG00 1211

Chapter 4
Configuring Servers

5. On the Properties tab, in the Unique identifier for InstallShield prerequisite setting, enter:

Oracle11g Instant Client – ODBC 11.1.0.7

If you are using a different version, update the identifier accordingly.

6. Configure the conditions for the InstallShield prerequisite:

a. Click the Conditions tab.

b. Click each existing condition and then click the Remove button.

c. Click the Add button. The Prerequisite Condition dialog box opens.

d. Select the A registry key does or does not exist option.

e. In the Specify the registry key name to check setting, enter:

HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI\Oracle in instantclient11_1

If you are using a different version, configure the condition accordingly.

f. Select the 32-bit option.

g. Select the If the specified registry key DOES NOT EXIST option, and then click OK.

7. Specify the appropriate .msi file to include in your InstallShield prerequisite:

a. Click the Files to Include tab.

b. Select the existing Oracle11g Instant Client 11.1.msi file, and then click the Modify button. The New File dialog
box opens.

c. Select the Oracle11g Instant Client - ODBC 11.1.msi file that you built in the aforementioned procedure,
and then click OK.

8. Specify the file that the InstallShield prerequisite should launch:

a. Click the Application to Run tab.

b. In the Specify the application you wish to launch setting, select the .msi file.

9. On the File menu, click Save.

For instructions on how to add the Oracle 11g Instant Client and the ODBC Instant Client to installations, see Installing the
Oracle 11g Instant Client.

If you plan on using the Oracle ODBC Instant Client instead of Microsoft ODBC for Oracle, ensure that you configure your
project accordingly. For more information, see Running SQL Scripts with Unicode Characters on an Oracle Database
Server.

See Also
Modifying an Existing InstallShield Prerequisite
Setting Installation Conditions for an InstallShield Prerequisite

1212 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Installing the Oracle 11g Instant Client

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

If you want to install the Oracle 11g Instant Client when your installation is run, you can include the Oracle 11g Instant
Client prerequisite in your project.

Note that before you can include the InstallShield prerequisite, you must download the Oracle Basic Instant Client and
create an .msi package. If you also want the Oracle ODBC Instant Client to be installed—for example, if you need to use
Unicode support with Oracle—you must download the Basic Instant Client and the ODBC Instant Client, build an .msi
package, and create an InstallShield prerequisite; you can use the Oracle 11g Instant Client prerequisite as a template, and
modify the settings as needed. For more information, see:

• Downloading the Oracle Instant Client and Creating an .msi Package for It

• Downloading the Oracle Basic Instant Client and the Oracle ODBC Instant Client and Creating an .msi Package and
InstallShield Prerequisite for Both

Important • The Oracle support in InstallShield requires that the target system have the 32-bit version of the Oracle Instant
Client, regardless of whether the target system is a 32-bit or 64-bit system.

Task To include the Oracle 11g Instant Client prerequisite in your project:

1. For Basic MSI and InstallScript MSI projects: In the View List under Application Data, click Redistributables.

For InstallScript projects: In the View List under Application Data, click Prerequisites.

2. In the list of redistributables, select the Oracle11g Instant Client 11.1.0.7 check box (or the check box for whatever
Oracle prerequisite that you are using).

The InstallShield prerequisite is launched only if the conditions that are defined in the InstallShield prerequisite file (.prq)
are met. To see the list of conditions, click the Oracle prerequisite in the Redistributables view or the Prerequisites view,
and then review the details that are listed in the details pane on the right. You can hide or show the details pane by clicking
the Show Details button in these views.

Note • If you want your installation to download the Oracle 11g Instant Client whenever it needs to be installed on a target
system, check with Oracle to ensure that it is allowed. If it is allowed, you must host the download on your own Web site and
add its download path to the InstallShield prerequisite. Revenera does not make this installation available for download.

InstallShield 2020 User Guide ISP-2600-UG00 1213

Chapter 4
Configuring Servers

Running SQL Scripts with Unicode Characters on an Oracle Database Server

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

For installations that use the default SQL script support that is available in the SQL Scripts view of InstallShield, Microsoft
ODBC for Oracle is used to connect to an Oracle database server on a target system. In some cases, you may want to
override the default behavior, and use the Oracle ODBC Instant Client instead of Microsoft ODBC for Oracle.

For example, if your SQL script contains Unicode characters, you may want to use the Oracle ODBC Instant Client, since it
has support for running SQL scripts that contain Unicode characters, but Microsoft ODBC for Oracle does not.

Task To configure your InstallShield project so that your installation uses the Oracle ODBC Instant Client instead of Microsoft
ODBC for Oracle:

1. In the View List under Additional Tools, click Direct Editor.

2. In the Tables explorer, click the ISSQLDBMetaData table.

3. Perform the following steps for the Oracle record:

a. Change the AdoDriverName field to the following value:

{Oracle in instantclient11_1}

b. Change the AdoCxnServer field to the following value:

DBQ=

At run time, the installation uses the Oracle ODBC Instant Client for connecting to the Oracle database and running SQL
scripts.

Tip • The Oracle ODBC Instant Client is available on a target system if the ODBC package of the Oracle Instant Client software
is installed. To learn how to add it to your installation, see Downloading the Oracle Basic Instant Client and the Oracle ODBC
Instant Client and Creating an .msi Package and InstallShield Prerequisite for Both.

Creating a Sample Installation that Creates a SQL Server Database by

Running Customized SQL Script
InstallShield 2020

Project • This information applies to the following project types:

1214 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

• Basic MSI
• InstallScript MSI

The following procedure demonstrates how to create an installation that creates a SQL Server database through
customized SQL script.

Task To create an installation that creates a SQL Server database on the target machine by running customized SQL script:

1. Create a new Basic MSI or InstallScript MSI project.

2. In the View List under Behavior and Logic, click Property Manager.

3. Create a new property that has the following name:

IS_SQLSERVER_DATABASE2

4. In the View List under Server Configuration, click SQL Scripts.

5. Add and configure a new SQL connection:

a. Right-click the SQL Scripts explorer and click New SQL Connection. InstallShield adds a new connection with
the name NewConnection1 as the default name.

b. In the SQL Scripts explorer, click the NewConnection1 item, and then click the General tab.

c. In the Default Target Server Name (optional) box, type TESTSQLSERVER.

d. Clear the Create Catalog If Absent check box.

e. In the Connect using area, select the Server authentication using the Login ID and password below option.

f. In the Login ID box, type sa. Leave the Password box blank.

g. Click the Requirements tab.

h. Ensure that the Microsoft SQL Server check box is selected and the MySQL and Oracle check boxes are cleared.

6. Add and configure a new SQL script for NewConnection1:

a. In the SQL Scripts explorer, right-click NewConnection1 and click New Script.

b. Change the name of the script to NewScript1.

c. In the SQL Scripts explorer, click NewScript1, and then click the Script tab.

d. In the script editor pane, add the following script:

CREATE DATABASE [TestDB] ON (NAME = N' TestDB', FILENAME = N'C:\Program Files\Microsoft SQL
Server\MSSQL\data\testdb.mdf' , SIZE = 3, FILEGROWTH = 10%) LOG ON (NAME = N' TestDB_log',
FILENAME = N'C:\Program Files\Microsoft SQL Server\MSSQL\data\testdb.ldf' , SIZE = 1, FILEGROWTH
= 10%)
COLLATE SQL_Latin1_General_CP1_CI_AS

e. Click the Runtime tab.

f. In the Script Execution area, select the Run Script During Login check box and ensure that the Run Script
During Install and Run Script During Uninstall check boxes are cleared.

7. Add and configure a second new SQL connection:

InstallShield 2020 User Guide ISP-2600-UG00 1215

Chapter 4
Configuring Servers

a. Right-click the SQL Scripts explorer and click New SQL Connection. InstallShield adds a new connection with
the name NewConnection2 as the default name.

b. In the SQL Scripts explorer, click the NewConnection2 item, and then click the Advanced tab.

c. In the Target Catalog Property Name list, select IS_SQLSERVER_DATABASE2.

d. Click the General tab.

e. In the Catalog Name box, type TestDB.

f. Clear the Create Catalog If Absent check box.

g. In the Default Target Server Name (optional) box, type TESTSQLSERVER.

h. In the Connect using area, select the Server authentication using the Login ID and password below option.

i. In the Login ID box, type sa. Leave the Password box blank.

j. Click the Requirements tab.

k. Ensure that the Microsoft SQL Server check box is selected and the MySQL and Oracle check boxes are cleared.

8. Add and configure a new SQL script for NewConnection2:

a. In the SQL Scripts explorer, right-click NewConnection2 and click New Script.

b. Change the name of the script to NewScript2.

c. In the SQL Scripts explorer, click NewScript2, and then click the Script tab.

d. In the script editor pane, add the following script:

CREATE TABLE TestTable (TestColumn1 CHAR NOT NULL PRIMARY KEY)

e. Click the Runtime tab.

f. In the Script Execution area, select the Run Script During Install check box and ensure that the Run Script
During Login and Run Script During Uninstall check boxes are cleared.

When you run the installation, it creates the TestDB database and adds a table called TestTable to that database.

Project • You can achieve the same outcome when following the above procedure but using a DIM project, and then adding
the DIM to an installation project.

Creating a Sample Installation that Creates an Oracle Schema by Running

Customized SQL Script
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

1216 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

The following procedure demonstrates how to create an installation that creates an Oracle schema through customized
SQL script.

Task To create an installation that creates an Oracle schema on the target machine by running customized SQL script:

1. Create a new Basic MSI or InstallScript MSI project.

2. In the View List under Behavior and Logic, click Property Manager.

3. Create three new properties that have the following names:

IS_SQLSERVER_DATABASE2

IS_SQLSERVER_USERNAME2

IS_SQLSERVER_PASSWORD2

4. In the View List under Server Configuration, click SQL Scripts.

5. Add and configure a new SQL connection:

a. Right-click the SQL Scripts explorer and click New SQL Connection. InstallShield adds a new connection with
the name NewConnection1 as the default name.

b. In the SQL Scripts explorer, click the NewConnection1 item, and then click the General tab.

c. In the Default Target Server Name (optional) box, type the following:

//sch01jsmith.installshield.com:1521/orcl

d. Clear the Create Catalog If Absent check box.

e. In the Connect using area, select the Server authentication using the Login ID and password below option.

f. In the Login ID box, type scott.

g. In the Password box, type scott.

h. Click the Requirements tab.

i. Ensure that the Oracle check box is selected and the Microsoft SQL Server and MySQL check boxes are cleared.

6. Add and configure a new SQL script for NewConnection1:

a. In the SQL Scripts explorer, right-click NewConnection1 and click New Script.

b. Change the name of the script to NewScript1.

c. In the SQL Scripts explorer, click NewScript1, and then click the Script tab.

d. In the script editor pane, add the following script:

CREATE TABLESPACE TEST_TS LOGGING DATAFILE 'test01.dbf' SIZE 1M AUTOEXTEND ON NEXT 2M MAXSIZE
UNLIMITED
Go
CREATE USER TEST_USER IDENTIFIED BY MYPSWD DEFAULT TABLESPACE TEST_TS QUOTA UNLIMITED on TEST_TS
Go
GRANT CONNECT TO TEST_USER
Go
GRANT DBA TO TEST_USER
Go

InstallShield 2020 User Guide ISP-2600-UG00 1217

Chapter 4
Configuring Servers

ALTER USER TEST_USER DEFAULT ROLE ALL

Go

e. Click the Runtime tab.

f. In the Script Execution area, select the Run Script During Login check box and ensure that the Run Script
During Install and Run Script During Uninstall check boxes are cleared.

7. Add and configure a second new SQL connection:

a. Right-click the SQL Scripts explorer and click New SQL Connection. InstallShield adds a new connection with
the name NewConnection2 as the default name.

b. In the SQL Scripts explorer, click the NewConnection2 item, and then click the Advanced tab.

c. In the Target Catalog Property Name list, select IS_SQLSERVER_DATABASE2.

d. In the Server Authentication Login ID Property Name list, select IS_SQLSERVER_USERNAME2.

e. In the Server Authentication Password Property Name list, select IS_SQLSERVER_PASSWORD2.

f. Click the General tab.

g. In the Catalog Name box, type TEST_USER.

h. Clear the Create Catalog If Absent check box.

i. In the Default Target Server Name (optional) box, type the following:

//sch01jsmith.installshield.com:1521/orcl

j. In the Connect using area, select the Server authentication using the Login ID and password below option.

k. In the Login ID box, type TEST_USER.

l. In the Password box, type MYPSWD.

m. Click the Requirements tab.

n. Ensure that the Oracle check box is selected and the Microsoft SQL Server and MySQL check boxes are cleared.

8. Add and configure a new SQL script for NewConnection2:

a. In the SQL Scripts explorer, right-click NewConnection2 and click New Script.

b. Change the name of the script to NewScript2.

c. In the SQL Scripts explorer, click NewScript2, and then click the Script tab.

d. In the script editor pane, add the following script:

CREATE TABLE TestTable (TestColumn1 CHAR NOT NULL PRIMARY KEY)

e. Click the Runtime tab.

f. In the Script Execution area, select the Run Script During Install check box and ensure that the Run Script
During Login and Run Script During Uninstall check boxes are cleared.

When you run the installation, it creates the TEST_USER user and a TestTable table on the TEST_USER schema.

1218 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Project • You can achieve the same outcome when following the above procedure but using a DIM project, and then adding
the DIM to an installation project.

Adding a SQLLogin Predefined Wizard Page in a Suite/

Advanced UI Project
InstallShield 2020

Project • This information applies to the Suite/Advanced UI project type.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield. For information about the
differences between these two project types, see Advanced UI Projects vs. Suite/Advanced UI Projects.

SQL servers are integral to many applications, especially those that benefit from the multiple package support provided by
InstallShield Suite installations. Previously, InstallShield SQL support was limited to Basic MSI, InstallScript, and
InstallScript MSI projects. Now, SQL support has been added to Suite/Advanced UI projects, giving you the ability to:

• Add a new SQLLogin predefined wizard page

• Execute SQL statements directly from Suites

The SQLLogin wizard page lets end users enter database server login information (database server name, authentication
credentials, database catalog name, etc.) in order to establish a connection to the database server that is targeted by one
or more .msi packages in the suite.

Adding a SQLLogin wizard page to your project allows you to:

• Specify properties that identify the SQL login settings in the Suite project and then select the .msi package that
receives these properties

• Specify the properties that identify the SQL login settings in the .msi package

• Choose the database technology (Microsoft SQL Server, Microsoft Windows Azure, MySQL, or Oracle) and select the
ODBC driver to be targeted

• Ensure that updated SQL drivers will be scheduled for installation via an action in OnBegin

In addition, Suite/Advanced UI projects now support directly executing SQL statements on SQL database servers from the
user interface, helping to examine SQL database servers before proceeding the installation. The SQL query result can then
be accessed in a Suite property.

The following shows how to add a SQLLogin predefined wizard page to your project. Alternatively, you can manually
configure SQL support in your Suite project in order to customize the UI based upon your installation’s needs.

InstallShield 2020 User Guide ISP-2600-UG00 1219

Chapter 4
Configuring Servers

Task To add a SQLLogin predefined wizard page and optionally execute a SQL statement directly in a Suite/Advanced UI
project:

1. In the View List under User Interface, click Wizard Interface.

2. In the Wizard Interface explorer, right-click Wizard Pages and then click Add Predefined Page. The User Interface
Wizard opens.

3. In the Task page list, select Enter login information for a database server.

4. In the Subsequent page list, indicate where in the wizard page sequence you want to schedule the database server
wizard page. The page that you select in this list will be displayed immediately after the new database server wizard
page at run time.

5. In the Task Configuration panels in the User Interface Wizard:

a. Specify properties that identify the SQL login settings in the Suite project.

Note • A suite project may have multiple packages that require different SQL servers or they may need to share.

b. Select the .msi package that receives the properties.

c. Choose the database technology and driver.

InstallShield adds corresponding Page Entered settings for the Task Configuration properties you specify.

6. To optionally add a SQL statement to be directly executed from the Suite/Advanced UI project at runtime, add a Run a
SQL String action to your project and specify its subsettings as needed. The SQL query result will be accessible from
the Suite property that you specify in the Data Property subsetting.

See Also
Sequencing Wizard Pages
User Interface Wizard
Wizard Interface View

Managing COM+ Applications and Components

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

The Component Services view enables you to manage COM+ applications and components for your installation package.
You can manage both COM+ server applications and application proxies. A COM+ application proxy consists of a subset of
the attributes of the server application, and it enables remote access from a client machine to the machine where the
application resides.

1220 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Note the following information regarding component services in InstallShield:

• Only non-system COM+ applications can be added to your project. Therefore, InstallShield displays only non-system
COM+ applications under the COM+ Applications explorer in the Component Services view.

• Only the COM+ applications that are installed on the local machine are included in the Component Services view and
available for you to add to your projects.

• An application proxy is available for COM+ server applications only, not for library applications.

The look and feel of the Component Services view is similar to that of the Component Services administrative tool in the
Control Panel.

See Also
Managing COM+ Server Applications
Managing COM+ Application Proxies
Including a COM+ Application that Targets Servers and Client Machines

Managing COM+ Server Applications

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

Task To configure the installation settings for a COM+ server application:

1. In the View List under Server Configuration, click Component Services.

2. In the Component Services explorer, select the COM+ application that you would like to configure if you have not
already done so.

3. On the Installation tab, select the Server check box.

Note • You must select the Proxy check box, the Server check box, or both check boxes. Once you clear one of these
check boxes, the other check box remains selected but it is no longer available; this prevents you from clearing both check
boxes.

4. Select the Refresh the COM+ settings from the client machine at build check box if appropriate.

5. If your installation does not include the COM+ application proxy support, clear the Proxy check box

When you add a COM+ server application to your project, InstallShield creates a corresponding component for each of the
features that are associated with the proxy component. This component has the COM+ application’s server .dll files.

InstallShield 2020 User Guide ISP-2600-UG00 1221

Chapter 4
Configuring Servers

Note • If the selected COM+ application includes both server and proxy installations, you can add installation conditions so
that the appropriate COM+ application is installed on the target machine. For more information, see Including a COM+
Application that Targets Servers and Client Machines.

See Also
Component Services View
Managing COM+ Application Proxies
Including a COM+ Application that Targets Servers and Client Machines

Managing COM+ Application Proxies

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

The COM+ application proxy support configures the system settings that enable remote access from a client machine to the
machine where the server application resides. You may also need to add the client application to your installation.

Task To configure the installation settings for a COM+ application proxy:

1. In the View List under Server Configuration, click Component Services.

2. In the Component Services explorer, select the COM+ application that you would like to configure if you have not
already done so.

3. On the Installation tab, select the Proxy check box.

4. Clear the Server check box if your installation does not include the COM+ server application.

Note • You must select the Proxy check box, the Server check box, or both check boxes. Once you clear one of these
check boxes, the other check box remains selected but it is no longer available; this prevents you from clearing both check
boxes.

5. In the Remote Server Name box, specify the name of the remote server computer where the application resides. You
can type the exact name or use the default [REMOTESERVERNAME] property, which is automatically created when you
select the Proxy check box for a COM+ application in your installation.

Note • The default value for the [REMOTESERVERNAME] property is the name of the machine used to add the COM+
application to the installation project in InstallShield. To change the value of the [REMOTESERVERNAME] property, use the
Property Manager view.

1222 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

If you would like the end user to be able to specify the remote server, add a Remote Server edit field control to an end-user
dialog in the Dialogs view. Set the Property value of this control to REMOTESERVERNAME.

6. Select the Enable distributed COM on the client machine check box if appropriate. Clear this check box if you know
that distributed component object model (DCOM) is already enabled on all client machines and you will not have
administrative privileges on them.

If you select this check box, Y is written at installation time to the EnableDCOM entry of the
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Ole registry key to enable DCOM.

Note • End users can enable or disable DCOM on their machines using the Component Services administrative tool in the
Control Panel. However, the application proxy will not work on a client machine if DCOM is disabled on that machine. For
this reason, you may want to select the Enable distributed COM on the client machine check box.

If an end user uninstalls the application proxy support, the EnableDCOM registry entry is not changed, even if the
installation process involved changing this registry entry to Y on the target machine.

When you add a COM+ application proxy to your project, InstallShield creates a corresponding component for each of the
features that are associated with the server component. This component has the COM+ application’s server .dll files. These
server files are installed on the client machine for the type libraries.

Note • If the selected COM+ application includes both server and proxy installations, you can add installation conditions so
that the appropriate COM+ application is installed on the target machine. For more information, see Including a COM+
Application that Targets Servers and Client Machines.

See Also
Component Services View
Managing COM+ Application Proxies
Including a COM+ Application that Targets Servers and Client Machines

Including a COM+ Application that Targets Servers and Client Machines

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

If you want your installation to install the server application on the server as well as the application proxy support on client
machines, you can create installation conditions so that the appropriate component is installed on the target machine. The
following example procedure illustrates how you can do this.

InstallShield 2020 User Guide ISP-2600-UG00 1223

Chapter 4
Configuring Servers

Task To include a COM+ application in an installation that targets both servers and client machines:

1. In the Property Manager view, create a new property called COMPLUSTYPE.

2. In the Dialogs view, add a radio button group control to a new or existing end-user dialog, and set the Property value
of this control to COMPLUSTYPE. This radio button group will enable end users to specify which installation they would
like to run: server or proxy.

3. Add a radio button for the Server option to the radio button group, and set the Value property of this control to
Server.

4. Add a radio button for the Proxy option to the radio button group, and set the Value property of this control to Proxy.

5. In the Component Services view, select the COM+ application that you would like to configure.

6. On the Installation tab, set the parameters for server installations and application proxies.

7. In the Condition box under the Server check box, type the following:

COMPLUSTYPE="Server"

8. In the Condition box under the Proxy check box, type the following:

COMPLUSTYPE="Proxy"

See Also
Component Services View
Managing COM+ Application Proxies
Including a COM+ Application that Targets Servers and Client Machines

Managing Internet Information Services

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Internet Information Services (IIS) is a Web server developed by Microsoft. It provides a secure platform for building and
deploying Web-based applications, managing Web sites, and publishing information to the Internet or an intranet.

The Internet Information Services view in InstallShield enables you to create and manage new IIS Web sites, applications,
virtual directories, application pools, and Web service extensions.

1224 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

See Also
Internet Information Services View
Creating a Web Site and Adding an Application or a Virtual Directory
Feature and Component Associations for IIS Support
Configuring Advanced IIS Settings
Uninstalling Web Sites, Applications, and Virtual Directories
Adding IISROOTFOLDER Support
Adding Project Output from a Web Service or Web Application Project

Version-Specific Information for IIS Support in InstallShield

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Following is information about specific versions of IIS:

• IIS is included with Windows 2000 Server and later and Windows XP and later systems. IIS 6 is available only on
Windows Server 2003 systems. IIS 7 is available on Windows Vista and Windows Server 2008 systems. IIS 7.5 is
available on Windows 7 and Windows Server 2008 R2 systems. IIS is not installed automatically by default.

• Some of the Web site and virtual directory settings in the Internet Information Services view apply to specific versions
of IIS. Version-specific information is noted for these settings in the inline help panes in InstallShield. If you configure a
version-specific property but a target system does not have the corresponding version of IIS, IIS ignores the version-
specific property.

For example, IIS 7 and IIS 6 do not support the Application Protection property for applications or virtual directories.
In the Internet Information Services view, this property is configured through a setting in the Application Settings area
for an application or a virtual directory. When you select this setting in the Internet Information Services view, the help
pane that is displayed in the lower-right corner indicates that the setting does not apply to IIS 6 or later. If you
configure this setting and an end user installs your product on a target system that has IIS 6 or later, the Application
Protection setting is ignored.

• Web service extensions, application pools, and all of the associated properties are available only on machines with IIS
6 or later.

On systems with IIS 7, Web service extensions require that the IIS Metabase and IIS 6 Configuration Compatibility
feature be installed. If it is not installed, the installation’s log file may show error -2147467259 to inform you that this
feature may be required.

For information on how to determine whether a Windows Vista or Windows Server 2008 system has the IIS Metabase
and IIS 6 Configuration Compatibility feature installed, see Determining If a Target System Has IIS 6 or Earlier or the
IIS 6 Metabase Compatibility Feature.

• Windows Vista and later and Windows Server 2008 and later systems store settings for individual Web sites,
applications, and virtual directories in configuration files that are located at the physical path that you specify in your

InstallShield 2020 User Guide ISP-2600-UG00 1225

Chapter 4
Configuring Servers

installation project—in the Content Source Path (Local or UNC) setting in the Internet Information Services view.
Therefore, each Web site, application, or virtual directory should have a unique physical path. Otherwise, you may
notice unexpected behavior, especially in testing environments, if you have two different applications or virtual
directories with the same physical path.

For example, if you have two virtual directories that have the same physical path, and directory browsing is enabled in
one but not the other, the directory browsing setting for the second virtual directory that is created overrides the
setting for the first virtual directory.

• On systems that have Windows Server 2003, if IIS 6 is not installed, other IIS directories and sites are still created. IIS 6-
specific settings are skipped.

• IIS 5.1 for Windows XP Professional can service only one Web site at a time. This is a limitation of IIS 5.1.

• InstallShield supports version 5 and later of IIS.

See Also
Web Site Settings
Application and Virtual Directory Settings

Determining Which Version of IIS Is Installed

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

When you add a Web site in the Internet Information Services view, an entry is added to the System Search view to search
for the version of IIS that is installed on the target system. The IIS_VERSION property is set by entries in the RegLocator
and AppSearch tables (available in the Direct Editor), which determine the version of IIS that is installed.

The IIS_VERSION property contains the IIS version number. If you need to determine the IIS version that is installed, check
the value of this property.

See Also
Managing Internet Information Services
Internet Information Services View

Run-Time Requirements for IIS Support

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM

1226 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

• InstallScript
• InstallScript MSI
• Merge Module

IIS support in InstallShield installations works only if IIS is installed on the target machine and the end user has
administrative privileges.

During the installation of a package that includes IIS settings, an InstallShield installation checks for the existence of IIS on
the target machine. If IIS is not installed, the installation displays a dialog informing the end user that they do not have IIS
installed. The dialog gives the end user the option to abort, retry, or ignore:

• If the end user chooses to abort, the installation stops.

• If the end user installs IIS and then chooses to retry, the installation checks for IIS again, and continues with the
installation. If the end user does not install IIS but still chooses to retry, the installation checks for IIS again and then
displays the dialog again.

• If the end user chooses to ignore, the installation continues, but IIS Web sites, applications, virtual directories, and
other IIS elements are not configured.

Note • InstallShield does not support the creation of Web sites on target machines other than the one on which the
installation is running.

Project • If you are creating an application pool in an InstallScript project and you want the application pool to be associated
with a virtual directory, application, or Web site, you must create the application pool and the virtual directory, application, or
Web site within the same component. If you do this, the application pool is created before the virtual directory, application, or
Web site is created. This is a requirement of IIS 6 and later, and it is not a limitation for Basic MSI, DIM, InstallScript MSI, or
Merge Module projects.

See Also
Determining Which Version of IIS Is Installed

Specifying Whether a Web Server Should Allow the CMD Command to Be

Used for SSI #exec Directives
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Server-side include (SSI) directives instruct a Web server to insert content into a Web page. The #exec type of directive
enables the Web server to include the output of a shell command in a Web page.

InstallShield 2020 User Guide ISP-2600-UG00 1227

Chapter 4
Configuring Servers

You can configure an IIS Web server to prevent the CMD command for the #exec directive from being used to execute shell
commands, or you can configure it to allow the CMD command to be used to execute this type of command. The
SSIEnableCmdDirective registry value for the
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters registry key is what determines whether
the CMD command is permitted.

InstallShield lets you specify how your installation should configure the SSIEnableCmdDirective registry value on target
systems. If you do not want your installation to change the SSIEnableCmdDirective registry value, you can also specify that.

Because of security concerns, the default SSIEnableCmdDirective registry value is FALSE (0); the FALSE (0) value prevents
end users from running unauthorized server-side executable files.

Task To specify whether a Web server should allow the CMD command to be used for SSI #exec directives:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the center pane, click the Web Sites explorer. InstallShield displays the Web server settings in the right pane.

3. For the SSIEnableCmdDirective registry value setting, select the appropriate option:

• Ignore—Do not change the SSIEnableCmdDirective registry value on the target system. This is the default option.

• FALSE (0)—Set the SSIEnableCmdDirective registry value on the target system to 0. This prevents the #exec CMD
directive of server-side includes to be used to execute shell commands. Note that if you select this value and an
IIS Web server has applications that rely on #exec CMD directives, those applications may stop working properly
after your installation project’s Web site and virtual directory are installed.

• TRUE (1)—Set the SSIEnableCmdDirective registry value on the target system to 1. This allows the #exec CMD
directive of server-side includes to be used to execute shell commands.

If you select the FALSE or TRUE options, InstallShield stores the value—either 0 for FALSE or 1 for TRUE—in the
INSTALLSHIELD_SSI_PROP property.

If one or more Web sites, virtual directories, application pools, or Web service extensions in your installation are installed
on a target system and you selected the FALSE or TRUE options for the SSIEnableCmdDirective registry value setting, the
SSIEnableCmdDirective registry value is updated on the target system.

Note • If your product is uninstalled from a target system, the SSIEnableCmdDirective registry value is not changed, even if its
value was changed during installation.

See Also
Internet Information Services View

Creating a Web Site and Adding an Application or a Virtual Directory

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

1228 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

• DIM
• InstallScript
• InstallScript MSI
• Merge Module

The Internet Information Services view in InstallShield is where you add an IIS Web site to your project. It is also where you
can add applications and virtual directories to a Web site. Note that you can add a Web site without any applications or
virtual directories if you associate the Web site with a component.

Task To create a Web site on the target system at run time:

1. In the View List under Server Configuration, click Internet Information Services.

2. Right-click the Web Sites explorer and click Add Web Site. InstallShield adds a new Web site.

3. Select the Web site to configure its settings.

Tip • InstallShield lets you specify the TCP port and site numbers for a Web site in your project. These settings help determine
whether a new Web site is created or an existing one is updated at run time. To learn more, see Configuring the TCP Port and
Site Numbers.

Task To create an application on the target system at run time:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, right-click the Web site that should contain the application and click New Application.
InstallShield adds a new application.

3. Select the application to configure its settings.

Task To create a virtual directory on the target system at run time:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, right-click the Web site that should contain the virtual directory and click New Virtual
Directory. InstallShield adds a new virtual directory.

3. Select the virtual directory to configure its settings.

Note • To learn how Web sites, applications, and virtual directories are associated with components and features, see
Feature and Component Associations for IIS Support.

InstallShield 2020 User Guide ISP-2600-UG00 1229

Chapter 4
Configuring Servers

See Also
Internet Information Services View
Adding Files to an IIS Virtual Directory
Scanning an IIS Web Site and Importing Its Settings into an InstallShield Project
Deploying Web Services on a Target Machine
Specifying Whether a Component’s Files and Other Associated Data Are Uninstalled During Uninstallation

Scanning an IIS Web Site and Importing Its Settings into an InstallShield Project
InstallShield 2020

Edition • The ability to import IIS data into an InstallShield project is available only in the Premier edition of InstallShield.

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield includes support for scanning an existing IIS Web site, recording IIS data about the Web site, and importing
those settings into the Internet Information Services view of an InstallShield project. Once you have imported the data into
a project, you can make changes to the IIS settings as needed, and build an installation that creates or maintains an IIS Web
site.

The IIS scanner (IISscan.exe) is a command-line tool that scans an IIS Web site and records the values of the settings that
you can configure in the Internet Information Services view in InstallShield. IISscan.exe creates an XML file that contains
all of the values. You can use this XML file to import the values into the Internet Information Services view.

IISscan.exe is installed in the following location:

InstallShield Program Files Folder\System\iisscan.exe

Task To scan an existing Web site and record all of the IIS data that can be configured in the Internet Information Services
view:

1. Place the IISscan.exe tool on the server that has the IIS Web site that you want to scan.

2. At the command prompt, enter the command-line statement that launches the IIS scanner to scan a specific Web site.
Following is a sample statement:

iisscan.exe -website "Site Name" -outfile "C:\PathToFile\FileName.xml"

For more information about IISscan.exe, see IISscan.exe.

The IIS scanner creates an XML file that contains the IIS data for the specified Web site.

1230 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Task To import the data from the XML file into an InstallShield project:

1. Obtain the XML file that the IIS scanner created, and place it in a location that can be accessed from the machine that
has InstallShield.

2. In the View List under Server Configuration, click Internet Information Services.

3. Right-click the Web Sites explorer and click Import Web Site. The Open dialog box opens.

4. Select the XML file that the IIS scanner created, and then click Open.

InstallShield imports the Web site and its settings into the Internet Information Services view. All of the Web site’s settings,
virtual directories, and applications are configured in this view during the import.

Tip • InstallShield lets you configure filters if you want to prevent certain IIS data—such as Web sites, applications, virtual
directories, application pool, or any of their settings—from ever being imported into the Internet Information Services view. To
learn more, see Filtering IIS Data When Importing a Web Site and Its Settings into an InstallShield Project.

See Also
Internet Information Services View
Creating a Web Site and Adding an Application or a Virtual Directory

Filtering IIS Data When Importing a Web Site and Its Settings into an InstallShield Project

InstallShield 2020

Edition • The ability to import IIS data into an InstallShield project is available only in the Premier edition of InstallShield.

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

When you use an XML file that is generated by the IIS scanner to import an IIS Web site and its settings into the Information
Services view, you may find that certain IIS settings are imported, even though you do not need them to be configured in
your installation. To avoid having these settings configured every time that you use an XML file to import IIS settings, you
can edit Filters.xml. This file enables you to specify any IIS settings that you want the import to ignore.

Filters.xml is in the following location:

InstallShield Program Files Folder\Support

The file must remain in this location after you edit it; otherwise, the IIS import will not work properly.

InstallShield 2020 User Guide ISP-2600-UG00 1231

Chapter 4
Configuring Servers

Tip • You can also use the Filters.xml file to control which registry items should be excluded during COM extraction. For
more information, see Filtering Registry Changes for COM Extraction.

The Filters.xml file also lets you control which files should be included or excluded during dependency scanning. For more
information, see Filtering Files in Dependency Scanners.

Excluding IIS Data

The <Exclude> element in the Filters.xml file is where you add subelements for each of the IIS items (Web sites,
applications, virtual directories, and application pools) that you do not want to be imported. You can also add subelements
for each of the IIS settings that you do not want to be imported. Any items and settings that are listed here will not be
added to the Internet Information Services view of your project.

Examples for Specifying IIS Data in the <Exclude> Element

To prevent an application pool named TestAppPool from being imported into the Internet Information Services view, add
the following line within the <Exclude> element.

<IisScanItem name="TestAppPool" type="4"/>

The type is required. The following table shows the available IIS item types:

Table 4-3 • Recognized Attributes for the type Attribute of the <IisScanItem> Subelement

Attribute Value Description

1 Web site

2 Application

3 Virtual directory

4 Application pool

To prevent an IIS setting with a specific value from being imported into the Internet Information Services view, add the
following line within the <Exclude> element.

<IisScanProperty name="PropertyName" value="PropertyValue"/>

If this line is within the <Exclude> element, InstallShield blocks a setting named PropertyName with a value that equals or
contains PropertyValue.

Note • The property names and values are not Windows Installer properties and values. They are abbreviations for the names
and values of settings that InstallShield lets you configure in the Internet Information Services view.

Important • Ensure that your XML code is well formed; if its not well formed, all of the filters fail. In most cases, you can
identify improperly formed XML code by opening the Filters.xml file in Internet Explorer. You should be able to expand and
contract the <Filters>, <Include>, and <Exclude> elements; if you cannot, check the code for errors.

1232 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

If you add subelements to the <Exclude> or <Include> elements, be sure that you do not place them within the commented-out
section, since InstallShield ignores that area of the Filters.xml file.

The following sample XML code shows the format of the Filters.xml file:

<Filters>
<Include>
<!--Instructions on how to add files to this element.
-->
<File name="mfc42.dll" We="needthis"/>
</Include>
<Exclude>
<!--Instructions on how to add files to this element.
-->
<Registry key="HKEY_CLASSES_ROOT\Interface\{00020404-0000-0000-C000-000000000046}"/>
<File name="12520437.cpx" path="[SystemFolder]" wrp="4.0-10.0" />
<File name="12520850.cpx" path="[SystemFolder]" wrp="4.0-10.0" />
<IisScanProperty name="AppMappings" value="*;;*;0" />
<IisScanProperty name="CustomErrors" value="C:\WINDOWS\help\iisHelp\common" />
</Exclude>
</Filters>

See Also
IISscan.exe
Internet Information Services View

Creating a Nested Virtual Directory

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

You can create a virtual subdirectory under an existing virtual directory.

You can also create a virtual subdirectory under a virtual directory that is being installed as part of your installation. The
parent virtual directory must be installed before the virtual subdirectory.

Project • For InstallScript projects, if a parent virtual directory should be installed before its child virtual subdirectory, the
component that contains the parent virtual directory must be installed before the component that contains the child virtual
subdirectory.

InstallShield 2020 User Guide ISP-2600-UG00 1233

Chapter 4
Configuring Servers

Task To create a virtual directory under an existing virtual directory:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the Web site that should contain the nested virtual directory.

3. Right-click the new Web site and click New Virtual Directory. InstallShield adds a new virtual directory.

4. Click the General tab.

5. In the Name setting, indicate the name of the existing directory, as well as the name of the nested virtual subdirectory
that you want to create. Separate both names with a slash.

For example, to create a virtual directory called MySubDirectory under the existing virtual directory called
VirtualDirectory, enter the following:

VirtualDirectory/MySubDirectory

Note • If the parent directory does not already exist on the target system, the target system displays an error when the end
user opens the directory in the IIS Manager.

See Also
Internet Information Services View
Creating a Web Site and Adding an Application or a Virtual Directory
Adding Files to an IIS Virtual Directory

Configuring the TCP Port and Site Numbers

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield lets you specify the TCP port and site numbers for a Web site in your project. These settings help determine
whether a new Web site is created or an existing one is updated at run time. They also affect whether the Web site settings
that are configured in the Internet Information Services view are applied to a Web site on the target system.

Task To specify the TCP port and site numbers for a Web site:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the Web site that you want to configure.

3. Click the Web Site tab.

1234 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

4. In the TCP Port Number and Site Number boxes, enter the appropriate numbers.

Run-Time Behavior
At run time, the installation creates the Web site, applications, and virtual directories according to the following rules:

Table 4-4 • Run-Time Results for Various Sample TCP Port Number and Site Number Setting Values

TCP Port Number Setting Site Number Setting in

in InstallShield InstallShield Result at Run Time

0 Any non-zero number Since the TCP Port Number setting is 0 but the Site
Number setting is not 0, the installation installs the Web
site’s applications and virtual directories to the first site
number on the system. The specified site number is
ignored.

For example, if the first site number on the target system is

1, the installation installs the Web site's applications and
virtual directories under site number 1, even if a different
non-zero number such as 3 is specified for the Site Number
setting.

The installation does not apply any of the Web site settings
that are configured in the Internet Information Services
view to the Web site on the target system.

80 (a non-zero number) 0 (the default value) If the specified TCP port exists on the target system, the
installation installs the applications and virtual directories
to the Web site that is running on the TCP port—in this
example, port 80. The installation does not apply any of
the Web site settings that are configured in the Internet
Information Services view to the Web site on the target
system.

If the TCP port does not exist on the target system, a new
Web site is created with the Web site settings that are
configured in the project. In addition, the installation
installs the Web site’s applications and virtual directories.

InstallShield 2020 User Guide ISP-2600-UG00 1235

Chapter 4
Configuring Servers

Table 4-4 • Run-Time Results for Various Sample TCP Port Number and Site Number Setting Values (cont.)

TCP Port Number Setting Site Number Setting in

in InstallShield InstallShield Result at Run Time

81 (a non-zero number) 3 (a non-zero number) If the specified TCP port and site number exist on the
target system, the installation installs the applications and
virtual directories under the Web site whose site number
matches the specified one—in this example, site number 3.
The installation does not apply any of the Web site settings
that are configured in the Internet Information Services
view to the Web site on the target system.

If the TCP port exists on the target system but the site
number does not, the installation installs the new Web
site, plus its applications and virtual directories, to the
existing port with the new site number. In addition, the
installation configures the Web site’s properties that are
set in the Internet Information Services view.

If the TCP port does not exist on the target system but the
site number does, the installation installs the new Web
site, plus its applications and virtual directories, to this
TCP port. In addition, the installation configures the Web
site’s properties that are set in the Internet Information
Services view.

Installing an IIS Web Site and Its Applications and Virtual Directories to the Next
Available New Site Number
The following procedures demonstrate how to install an IIS Web site and its applications and virtual directories to the next
available new site number. Note that the procedure differs, depending on the project type.

Task To install to the next available new site number for a Basic MSI, DIM, InstallScript MSI, or Merge Module project:

1. Create a new Windows Installer property and set its value to INSTALLSHIELD_IIS_NEXT_NEW_SITE_NUMBER:

a. In the View List under Behavior and Logic, click Property Manager.

b. Click the New Property button. InstallShield adds a new row at the bottom of the view.

c. In the Name column, type a new property; for example:

MYPROPERTY

d. In the Value column, enter the following value:

INSTALLSHIELD_IIS_NEXT_NEW_SITE_NUMBER

2. Specify the property for the Web site’s site number:

a. In the View List under Server Configuration, click Internet Information Services.

b. In the Web Sites explorer, select the Web site that you want to configure.

1236 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

c. For the Site Number setting, enter the property that you created in step 1c. It must be in uppercase letters and
enclosed within brackets; for example:

[MYPROPERTY]

At run time, the installation installs the Web site and its applications and virtual directories to the next available new site
number.

Task To install to the next available new site number during an InstallScript installation:

1. Create a new string entry and set its value to INSTALLSHIELD_IIS_NEXT_NEW_SITE_NUMBER:

a. In the View List under User Interface, click String Editor.

b. Click the New String Entry button. The String Entry dialog box opens.

c. In the String Identifier box, enter a new variable name; the variable name must be in uppercase letters; for
example:

MYPROPERTY

d. In the Value box, enter the following value:

INSTALLSHIELD_IIS_NEXT_NEW_SITE_NUMBER

2. Specify the variable for the Web site’s site number:

a. In the View List under Server Configuration, click Internet Information Services.

b. In the Web Sites explorer, select the Web site that you want to configure.

c. For the Site Number setting, enter the variable that you created in step 1c. It must be in uppercase letters.

At run time, the installation installs the Web site and its applications and virtual directories to the next available new site
number.

See Also
Web Site Settings
Internet Information Services View

Specifying the IIS Host Header Name for a Web Site

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield lets you specify the host header name to identify an IIS Web site that is installed during your installation. Host
headers (also known as domain names) enable you to assign more than one Web site to an IP address on a Web server.

InstallShield 2020 User Guide ISP-2600-UG00 1237

Chapter 4
Configuring Servers

Task To specify a host header name for a Web site:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the Web site whose host header name you want to specify.

3. For the Host Header Name setting, type the host header name that you want to use. For example:

www.mycompany.com

See Also
Determining If a Target System Has IIS 6 or Earlier or the IIS 6 Metabase Compatibility Feature
Web Site Settings
Internet Information Services View

Specifying the SSL Certificate for a Web Site

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

A server certificate enables users to authenticate your Web server, check the validity of the Web content, and establish a
secure connection. InstallShield lets you include a server certificate for a Web site in your installation so that it can be
installed at run time.

Task To specify a SSL certificate that should be installed for a Web site:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the Web site whose SSL certificate you want to specify.

3. For the SSL Certificate setting, click the ellipsis button (...). The Open dialog box opens.

4. Select the security certificate file (.cer or .pfx) that you want to be installed, and then click Open.

5. If the certificate requires a password, specify it for the SSL Certificate Password setting.

InstallShield stores the .cer file in the Binary table. At run time, when the installation installs the Web site and its virtual
directories, it also installs the SSL certificate.

See Also
Internet Information Services View

1238 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Setting the IIS Certificate File at Runtime

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

You can choose to include a Configure SSL for IIS dialog (IISBrowseSSLCertificate) in your installer that enables the end
user to browse to a IIS certificate file that they provide for the SSL Certificate and enter a password at installation runtime.

Figure 4-1: Configure SSL for IIS Dialog

To add a Configure SSL for IIS dialog to your installer, perform the following steps:

Task To add a “Configure SSL for IIS” dialog to your installer:

1. In the View List under Server Configuration, click Internet Information Services.

2. Right-click the Web Sites explorer and click Add Web Site. InstallShield adds a new Web site.

3. Select the new web site and locate the SSL Certificate and SSL Certificate Password properties under Security >
Secure Communication.

4. Set the SSL Certificate and SSL Certificate Password properties to the following values:

Property Value

SSL Certificate [IS_IIS_WEBCERTPATH]

SSL Certificate Password [IS_IIS_WEBCERTPASSWORD]

5. Open the User Interface > Dialogs view and add the IISBrowseSSLCertificate dialog to the dialog sequences.

InstallShield 2020 User Guide ISP-2600-UG00 1239

Chapter 4
Configuring Servers

The property name for the SSL Certificate and password configured by the user is required to update in the
IISBrowseSSLCertificate dialog for the Edit boxes (IISWebCertPassword and IISWebCertPath) and the push button
(BrowseCertificate) events.

See Also
Internet Information Services View

Adding Files to an IIS Virtual Directory

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Task To add a file to an IIS virtual directory:

1. Add an IIS Web site to your project if you have not already done so. InstallShield automatically adds the predefined
path [IISROOTFOLDER] to the Files and Folders view.

2. In the View List under Application Data, click Files and Folders.

3. In the Feature list, select the feature with which you want the file associated.

4. In the Destination computer’s folders pane, add the file to the [IISROOTFOLDER] folder, or a subfolder of the
[IISROOTFOLDER] folder.

5. In the View List under Server Configuration, click Internet Information Services.

6. Create a new virtual directory.

7. In the Web Sites explorer, click the virtual directory that you created.

8. In the Content Source Path (Local or UNC) setting, click the ellipsis button (...). The Browse for Directory dialog box
opens. In a Basic MSI or InstallScript MSI project, this dialog box enables you to select a Windows Installer property
(such as [IISROOTFOLDER]) or create a new one. In an InstallScript project, this dialog box enables you to select an
InstallScript variable (such as <IISROOTFOLDER>) or create a new one. By default, the files are stored in
IISROOTFOLDER.

9. Enter the same target directory as the one that contains the new file that you added in the Files and Folders view.

10. Click OK.

At installation, files are copied to the target directory folder. In addition, the virtual directory is configured for that folder on
the target system if IIS is present.

1240 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

See Also
Creating a Web Site and Adding an Application or a Virtual Directory
Adding IISROOTFOLDER Support

Removing Applications and Virtual Directories from the Internet Information

Services View
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Task To remove an application or a virtual directory from your installation:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, right-click the application or virtual directory and click Delete.

See Also
Uninstalling Web Sites, Applications, and Virtual Directories
Managing Internet Information Services
Internet Information Services View

Adding Application Pools

InstallShield 2020 » Internet Information Services View

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

An application pool is a group of configuration settings that specify how one or more Web applications are routed to one or
more worker processes. InstallShield lets you create application pools and associate Web sites, applications, and virtual
directories with those application pools.

InstallShield 2020 User Guide ISP-2600-UG00 1241

Chapter 4
Configuring Servers

Project • If you are creating an application pool in an InstallScript project and you want the application pool to be associated
with a virtual directory, application, or Web site, you must create the application pool and the virtual directory, application, or
Web site within the same component. If you do this, the application pool is created before the virtual directory, application, or
Web site is created. This is a requirement of IIS 6 and later, and it is not a limitation for Basic MSI, DIM, InstallScript MSI, or
Merge Module projects.

Note • Application pools are available only on machines with IIS 6.0 or later installed.

Task To add a new application pool in the Internet Information Services view:

1. In the View List under Server Configuration, click Internet Information Services.

2. Right-click the Application Pools explorer and click Add Application Pool. InstallShield adds a new application pool
item.

3. Rename the new application pool item, and configure its settings.

See Also
Feature and Component Associations for IIS Support
Application Pool Settings

Removing Application Pools from the Internet Information Services View

InstallShield 2020 » Internet Information Services View

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Project • To remove an application pool from your installation:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Application Pools explorer, right-click the application pool and click Delete.

See Also
Uninstalling Web Service Extensions and Application Pools
Application Pool Settings

1242 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Adding Web Service Extensions

InstallShield 2020 » Internet Information Services View

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

A Web service extension is an IIS feature that extends the basic IIS functionality beyond serving static content. Examples of
Web service extensions are active server pages (.asp), ASP.NET, and server-side includes (SSI).

InstallShield lets you add Web service extensions to your installation.

Note • Web service extensions are available only on machines with IIS 6.0 or later installed.

On systems with IIS 7, Web service extensions require that the IIS Metabase and IIS 6 Configuration Compatibility feature be
installed. For more information, see Version-Specific Information for IIS Support in InstallShield.

Task To add a web service extension to your installation:

1. In the View List under Server Configuration, click Internet Information Services.

2. Right-click the Web Service Extensions explorer and click Add Web Service Extension. InstallShield adds a new Web
service extension.

3. Rename the new Web service extension item, and configure its settings.

See Also
Web Service Extension Settings

Removing Web Service Extensions from the Internet Information Services

View
InstallShield 2020 » Internet Information Services View

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1243

Chapter 4
Configuring Servers

Task To remove a Web service extension from your installation:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Service Extension explorer, right-click the Web service extension and click Delete.

See Also
Uninstalling Web Service Extensions and Application Pools
Web Service Extension Settings

Feature and Component Associations for IIS Support

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

There is a one-to-many relationship between components and IIS data (that is, Web sites, applications, virtual directories,
application pools, or Web service extensions). Therefore, you can associate more than one IIS element with a single
component. If a component is being installed, any Web sites, applications, virtual directories, application pools, and Web
service extensions that are associated with the component are created at run time.

Project • If a Web site is associated with a component in an InstallScript project, any applications or virtual directories that
are added to that Web site must be associated with the same component. Therefore, if you try to change the component for a
Web site that contains one or more applications or virtual directories, InstallShield displays a message box to inform you that
it will also make the same component change for all of that Web site’s applications and virtual directories; InstallShield also
displays this message box if you try to change the component for any applications or virtual directories in a Web site. In either
case, the message box enables you to proceed or cancel the component change.

Note that for Basic MSI, DIM, InstallScript MSI, and Merge Module projects, keeping a Web site in the same component as all of
the Web site’s applications and virtual directories is not required, but it is recommended.

If you are creating an application pool in an InstallScript project and you want the application pool to be associated with a
virtual directory, application, or Web site, you must create the application pool and the virtual directory, application, or Web
site within the same component. If you do this, the application pool is created before the virtual directory, application, or Web
site is created. This is a requirement of IIS 6 and later, and it is not a limitation for Basic MSI, DIM, InstallScript MSI, or Merge
Module projects.

At any time, you can use the Internet Information Services view to change which component contains the Web site,
application, virtual directory, application pool, or Web service extension.

1244 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Task To associate a Web site, application, virtual directory, application pool, or Web service extension with a different
component in your project:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the explorer, click the Web site, application, virtual directory, application pool, or Web service extension that you
want to associate with a component.

3. In the Component setting, select the name of the existing component that should contain the selected IIS data. You
can click the ellipsis button (...) to select an existing component or create a new one for the IIS data.

Tip • If you delete a component in your project, any Web sites, applications, virtual directories, application pools, and Web
service extensions that are associated with the component are simultaneously removed from your project.

See Also
Specifying Whether a Component’s Files and Other Associated Data Are Uninstalled During Uninstallation

Uninstalling Web Sites, Applications, and Virtual Directories

InstallShield 2020 » Internet Information Services

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Web sites that are created by an installation are never removed unless both of the following conditions are true:

• The Web site no longer contains applications or virtual directories.

• The value for the Delete on Uninstall setting for the Web site in the Internet Information Services view is Yes.

Note • If a Web site is associated with a component, the Delete on Uninstall setting for the Web site corresponds with
the Permanent setting for that component in a Basic MSI, DIM, InstallScript MSI, or Merge Module project, or with the
Uninstall setting for that component in an InstallScript project. That is, if you select or clear the Delete on Uninstall
setting for a Web site, InstallShield automatically updates the value of the component’s Permanent setting or Uninstall
setting, as appropriate.

If a component is uninstalled, all of its Web sites, applications, and virtual directories are uninstalled. A component is not
uninstalled if it is configured to be permanent. For more information, see Specifying Whether a Component’s Files and
Other Associated Data Are Uninstalled During Uninstallation.

InstallShield 2020 User Guide ISP-2600-UG00 1245

Chapter 4
Configuring Servers

Uninstalling Web Service Extensions and Application Pools

InstallShield 2020 » Internet Information Services

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Note • Web service extensions, application pools, and associated properties are available only on machines with IIS 6.0 or
later installed.

On systems with IIS 7, Web service extensions require that the IIS Metabase and IIS 6 Configuration Compatibility feature be
installed. For more information, see Version-Specific Information for IIS Support in InstallShield.

Any Web service extensions and application pools installed in the IIS Manager that have identical names as the Web service
extensions and application pools in an installation will always be uninstalled when the features with which they are
associated are uninstalled unless their components are marked as permanent. Even if the Web service extension or
application pool was originally created by something other than the installation, it will be removed from the target system
upon uninstallation if the names (of the Web service extensions and application pools) match those in the installation. One
exception is that the default application pool, named DefaultAppPool, will never be removed by the uninstallation.

Task To configure a Web service extension to be uninstalled during uninstallation:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Service Extensions explorer, select the Web service extension.

3. For the Mark Component as Permanent setting, select No.

Task To configure an application pool to be uninstalled during uninstallation:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Application Pool explorer, select the application pool.

3. For the Mark Component as Permanent setting, select No.

If Yes is selected for the Mark Component as Permanent setting, the Web service extension or application pool is left on the
target system after uninstallation.

Tip • Changing the value of the Mark Component as Permanent setting affects the value of the Permanent setting (in Basic
MSI, DIM, InstallScript MSI, and Merge Module projects) or the Uninstall setting (in InstallScript projects) for the component
that contains the Web service extension or the application pool. Therefore, if you select Yes for the Mark Component as

1246 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

Permanent and the component contains other data, such as files, shortcuts, and registry entries, the IIS data, as well as the
other data in the component, are not uninstalled during uninstallation.

See Also
Specifying Whether a Component’s Files and Other Associated Data Are Uninstalled During Uninstallation

Setting the ASP.NET Version for a Web Site or Application

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield lets you set the ASP.NET version for a Web site or application in your installation. If you specify the ASP.NET
version, after the Web site or application is created, the installation runs the ASP.NET IIS Registration tool
(Aspnet_regiis.exe) to map the Web site or application to the version that you specify.

If you specify the ASP.NET version for a Web site, IIS uses that value for the Web site that is created at run time, as well as for
any of its applications.

Important • Microsoft does not recommend using the Aspnet_regiis.exe tool on Windows Vista and Windows Server 2008
systems because it has limited capabilities. As a result, you may need to manually define application mappings in the Internet
Information Services view. To learn more, see Defining Application Mappings for a Web Site, Application, or Virtual Directory.

ASP.NET 3.0 does not include the Aspnet_regiis.exe tool. Therefore, you cannot set the ASP.NET version to version 3 of
ASP.NET.

Task To specify the ASP.NET version for a Web site or application in your project:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the Web site or application whose ASP.NET version you want to specify. The settings
for the Web site or application are displayed on the right.

3. For the ASP.NET Version setting, enter the complete version number of the .NET Framework that is required by your
application, or select it from the list.

For example, to specify version 2 of ASP.NET, type 2.0.50727. To specify version 1.1 of ASP.NET, type 1.1.4322.

Tip • If the installation may be run on a 64-bit version of Windows with the .NET Framework, you can use the ASP.NET Platform
setting for a Web site or application to specify which ASP.NET platform (32 bit or 64 bit) should be used to map the Web site or

InstallShield 2020 User Guide ISP-2600-UG00 1247

Chapter 4
Configuring Servers

application to the ASP.NET version. Note that it is not possible to register 32-bit ASP.NET on a 64-bit system unless the
Enable32BitAppOnWin64 property is set to true on the system.

See Also
Web Site Settings
Considerations for Supporting IIS 6 on 64-Bit Platforms
Application and Virtual Directory Settings

Specifying Whether to Perform Recursive or Non-Recursive ASP.NET

Registration
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

You can use the ASP.NET Registration setting on the Application settings of the Internet Information Services view to
specify whether to perform recursive or non-recursive ASP.NET registration. Using this feature enables you to install both
ASP.NET applications and ASP.NET Core applications to the same website.

Task To specify the ASP.NET registration for an application in your project:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the application whose ASP.NET registration you want to specify. The settings for the
application are displayed on the right.

3. For the ASP.NET Registration setting, select one of the following options:

• Recursive—Updates script maps and application-pool assignments for the specified application and for all sub-
applications.

• Non Recursive—Updates script maps and application-pool assignments for only the specific application. No sub-
applications are changed.

Considerations for Supporting IIS 6 on 64-Bit Platforms

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM

1248 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

• InstallScript MSI
• Merge Module

If your IIS installation may be run on a 64-bit version of Windows with the .NET Framework, you can use the ASP.NET
Platform setting in the Internet Information Services view for a Web site or application. This setting lets you specify which
ASP.NET platform should be used to map the Web site or application to the ASP.NET version. By default, this setting is not
configured in InstallShield; if you do not change the value of this setting, the installation assumes that 32-bit support is
needed.

Depending on the value that you configure for the ASP.NET Platform and ASP.NET Version settings, the following behavior
occurs by default at run time:

• If the target system has a 32-bit version of Windows, the 32-bit version of the specified ASP.NET version is used.

• If the target system has a 64-bit version of Windows, and 64 bit was specified for the ASP.NET platform, the
Enable32bitAppOnWin64 property on the target system needs to be set to False. Otherwise, using the 64-bit version of
ASP.NET on a system that is configured to support the 32-bit version would cause ASP.NET to become corrupted.
Thus, the installation is aborted to prevent damage to ASP.NET services.

• If the target system has a 64-bit version of Windows, and 32 bit was specified for the ASP.NET platform, the
Enable32bitAppOnWin64 property on the target system needs to be set to True. Otherwise, using the 32-bit version of
ASP.NET on a system that is configured to support the 64-bit version would cause ASP.NET to become corrupted.
Thus, the installation is aborted to prevent damage to ASP.NET services.

You can set the Enable32bitAppOnWin64 property on a target system that has IIS 7 by configuring the Enable 32-Bit
Applications setting for an application pool in the Internet Information Services view. At run time, the installation sets the
Enable32bitAppOnWin64 property as appropriate for the application pool that is being installed.

On systems with IIS 6, the Enable32bitAppOnWin64 property is a global property that affects all Web sites and applications
on an IIS server. Since changing the value of that property at installation run time might cause other already installed Web
sites and applications on that server to fail, installations that are created with InstallShield do not modify the
Enable32bitAppOnWin64 property at run time if the target system has IIS 6.

At run time, you can have your installation check the Enable32bitAppOnWin64 property on systems that have IIS 6.
Depending on the requirements for your product and the results of that check, you may want the installation to skip a
particular component that contains a 32-bit IIS 6 application, or a 64-bit IIS application, for example, and proceed with the
rest of the file transfer.

InstallShield includes a sample Windows Installer DLL file that detects how the Enable32bitAppOnWin64 property is set.
Release and debug versions of the DLL file, as well as the Visual Studio 2008 C++ project that was used to create the file, are
installed to the following location:

InstallShield Program Files Folder\Samples\WindowsInstaller\Detect IIS6 Compatibility

To use the Windows Installer DLL file in your project, you first need to create a custom action that calls the
DetectIIS6AppPool32BitSupport function in the DetectIIS6Compat.dll file.

Task To add a custom action that checks for support for 32-bit applications on systems that have IIS 6:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI or InstallScript MSI
projects) or Custom Actions (in DIM or Merge Module projects).

2. In the center pane, right-click the Custom Actions explorer, point to New MSI DLL, and click Stored in Binary table.
InstallShield adds a new custom action.

InstallShield 2020 User Guide ISP-2600-UG00 1249

Chapter 4
Configuring Servers

3. Change the name of the action to something like DetectIIS6AppPool32BitSupport.

4. Configure the custom action’s settings in the right pane:

• In the DLL Filename setting, specify the path to the DetectIIS6Compat.dll file. The typical path is:

<ISProductFolder>\Samples\WindowsInstaller\Detect IIS6 Compatibility\DetectIIS6Compat.dll

• In the Function Name setting, enter the following name:

DetectIIS6AppPool32BitSupport

• In the In-Script Execution setting, select Immediate Execution.

• Schedule the custom action as needed by selecting the appropriate option in one or more sequence settings.

• In the condition setting, enter the following condition:

VersionNT<600

This condition ensures that the custom action is not run on Windows Server 2008 or later or on Windows Vista or
later, since these operating systems would have IIS 7 or later.

At run time, the custom action sets the Windows Installer property ISIIS6APPPOOLSUPPORTS32BIT under certain
conditions:

Table 4-5 • Windows Installer Property for Checking for 32-Bit Application Support on IIS 6 Systems

Target System Environment Result

32-bit Windows, IIS 6 ISIIS6APPPOOLSUPPORTS32BIT is set to 1.

(The value of Enable32bitAppOnWin64 is not

relevant.)

64-bit Windows, IIS 6, ISIIS6APPPOOLSUPPORTS32BIT is set to 1.

Enable32bitAppOnWin64=true

64-bit Windows, IIS 6, ISIIS6APPPOOLSUPPORTS32BIT is not set.

Enable32bitAppOnWin64=false

You can use the ISIIS6APPPOOLSUPPORTS32BIT property in conditional statements. For example, if your product cannot be
used on an IIS 6 server without 64-bit application support, enter the following conditional statement in the Install
Condition setting of the General Information view:

Not ISIIS6APPPOOLSUPPORTS32BIT

As an alternative, you can create an error custom action. At run time, an error would be displayed if the condition for that
custom action is true. Thus, if your product cannot be used on an IIS 6 server without 64-bit application support, use the
following condition for an error custom action:

ISIIS6APPPOOLSUPPORTS32BIT=1

If you have a component that should be installed only on IIS 6 servers that have 32-bit application support enabled, enter
the following conditional statement in the Condition setting of the Components view:

ISIIS6APPPOOLSUPPORTS32BIT=1

1250 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

See Also
Setting Product Conditions
Version-Specific Information for IIS Support in InstallShield
Determining Which Version of IIS Is Installed

Defining Application Mappings for a Web Site, Application, or Virtual

Directory
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield lets you define mappings between file name extensions and the applications that process those files.

Task To add, edit, or remove an application mapping:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the Web site, application, or virtual directory that you want to configure.

3. In the Application Mappings setting, click the ellipsis button (...). The Application Mappings dialog box opens.

4. Do one of the following:

• To add a new mapping, click the Add button. The Application Extension Mapping dialog box opens. For more
information, see Application Extension Mapping Dialog Box.

• To change an existing mapping, select the one that you want to edit, and then click the Edit button.

• To delete an existing mapping, select it and then click the Delete button.

See Also
Application Mappings Dialog Box

Specifying Timeout Parameters for a Web Site, Application, or Virtual

Directory
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 1251

Chapter 4
Configuring Servers

• DIM
• InstallScript
• InstallScript MSI
• Merge Module

InstallShield lets you specify timeout parameters for a Web site, application, or virtual directory.

Task To specify timeout parameters:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the Web site, application, or virtual directory that you want to configure.

3. In the Application settings area, click the Configuration button. The Application Mappings dialog box opens.

4. In the Session Timeout (minutes) and the ASP Script Timeout (seconds) settings, specify the appropriate timeout
values.

See Also
Application Mappings Dialog Box

Determining If a Target System Has IIS 6 or Earlier or the IIS 6 Metabase

Compatibility Feature
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript MSI
• Merge Module

At run time, you can have your installation detect if the IIS Metabase and IIS 6 Configuration Compatibility feature is
installed on a target system, or if IIS 6 or earlier is installed. Depending on the requirements for your product and the
results of that detection, you may want the installation to exit and display an error message.

For example, Web service extensions can be installed on systems that have IIS 6. On systems that have IIS 7, Web service
extensions can be installed only if the IIS Metabase and IIS 6 Configuration Compatibility feature is installed. Thus, you
might want to configure your installation to verify that IIS 6 is present or the IIS 6 compatibility feature is installed; if either
of those conditions are false, the installation would exit and display an error message.

InstallShield includes a sample Windows Installer DLL file that detects if either of the following are true:

• The target system has IIS 7 and the IIS Metabase and IIS 6 Configuration Compatibility feature is installed.

• The target system has IIS 6 or earlier.

Release and debug versions of the DLL file, as well as the Visual Studio 2008 C++ project that was used to create the file, are
installed to the following location:

InstallShield Program Files Folder\Samples\WindowsInstaller\Detect IIS6 Compatibility

1252 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

To use the Windows Installer DLL file in your project, you first need to create a custom action that calls the
DetectIIS6Interfaces function in the DetectIIS6Compat.dll file.

Task To add a custom action that checks for the IIS Metabase and IIS 6 Configuration Compatibility feature and for IIS 6 and
earlier:

1. In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI or InstallScript MSI
projects) or Custom Actions (in DIM or Merge Module projects).

2. In the center pane, right-click the Custom Actions explorer, point to New MSI DLL, and click Stored in Binary table.
InstallShield adds a new custom action.

3. Change the name of the action to something like DetectIIS6Interfaces.

4. Configure the custom action’s settings in the right pane:

• In the DLL Filename setting, specify the path to the DetectIIS6Compat.dll file. The typical path is:

<ISProductFolder>\Samples\WindowsInstaller\Detect IIS6 Compatibility\DetectIIS6Compat.dll

• In the Function Name setting, enter the following name:

DetectIIS6Interfaces

• In the In-Script Execution setting, select Immediate Execution.

• Schedule the custom action as needed by selecting the appropriate option in one or more sequence settings.

If the IIS Metabase and IIS 6 Configuration Compatibility feature is installed or the target system has IIS 6 or earlier, the
Windows Installer property ISIISMETABASECOMPATPRESENT is set to a value of 1. If the target system has IIS 7 or later and the
compatibility feature is not installed, the property is not set.

You can use the ISIISMETABASECOMPATPRESENT property in conditional statements. For example, if your product cannot be
used on a system without the IIS Metabase and IIS 6 Configuration Compatibility feature or IIS 6 or earlier, enter the
following conditional statement in the Install Condition setting of the General Information view:

ISIISMETABASECOMPATPRESENT

As an alternative, you can create an error custom action. At run time, an error would be displayed if the condition for that
custom action is true. Thus, if your product cannot be used on a system without the IIS Metabase and IIS 6 Configuration
Compatibility feature or IIS 6 or earlier, use the following condition for an error custom action:

Not ISIISMETABASECOMPATPRESENT

If you have a component that should be installed only on systems that have the IIS Metabase and IIS 6 Configuration
Compatibility feature or IIS 6 or earlier, enter the following conditional statement in the Condition setting of the
Components view:

ISIISMETABASECOMPATPRESENT=1

See Also
Setting Product Conditions
Version-Specific Information for IIS Support in InstallShield
Determining Which Version of IIS Is Installed

InstallShield 2020 User Guide ISP-2600-UG00 1253

Chapter 4
Configuring Servers

Configuring Advanced IIS Settings

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Note • The advanced IIS settings apply to IIS 6 and earlier. IIS 7 ignores these settings.

When you select a Web site, application, or a virtual directory in the Web Sites explorer in the Internet Information Services
view, the right pane exposes the most common IIS settings. You can use the Advanced area at the bottom of the right pane
to configure other IIS settings that are not exposed in the other areas.

Task To configure a setting that is not exposed in the Internet Information Services view:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select the Web site, application, or virtual directory whose advanced settings you want to
configure.

3. In the Other IIS Properties setting, click the ellipsis button (...). The Other IIS Properties dialog box opens.

4. In the property list, select the property whose value you want to change, and then click the Change Value button. The
Edit IIS Metabase Value dialog box opens.

5. In the Value box, specify the new value.

If you change the default value for any advanced property, InstallShield adds the property, the value that you specify, and
the additional required information to the ISIISProperty table. For more information, see ISIISProperty Table.

See Also
Edit IIS Metabase Value Dialog Box
Internet Information Services View

Configuring Custom Error Messages for a Web Site, Application, or Virtual

Directory
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

1254 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

• DIM
• InstallScript
• InstallScript MSI
• Merge Module

When an end user tries to connect to a Web site and a hypertext transfer protocol (HTTP) error occurs, the end user’s
browser displays a default message describing the error. You can have your installation configure IIS so that it uses custom
error messages instead of the default error messages by mapping the HTTP error codes to a file or a URL.

Task To configure custom error messages for a Web site, application, or virtual directory:

1. Create a file that contains your custom error message and add it to your installation.

2. In the View List under Server Configuration, click Internet Information Services.

3. Select the Web site, application, or virtual directory for which you want to customize HTTP error messages. The
settings for the Web site, application, or virtual directory are displayed on the right.

4. In the Custom Errors setting, click the ellipsis button (...). The Custom Errors dialog box opens.

5. Select the HTTP error code that you want to change and then click the Edit Properties button. The Error Mapping
Properties dialog box opens.

6. To map the error code to a file:

a. In the Message Type list, select File.

b. In the File box, type the path and file name that points to the custom error message in your installation, or click
the browse button to locate the file.

To map the error code to a URL:

a. In the Message Type list, select URL.

b. In the URL box, type the URL that points to your custom error message.

See Also
Error Mapping Properties Dialog Box

Using Windows Installer Properties to Dynamically Modify IIS Settings

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

For Basic MSI and InstallScript MSI projects, you can configure an IIS setting dynamically at run time through the use of
Windows Installer properties. This enables you to let end users specify the name of the virtual directory, the TCP port, the
site number, or other IIS settings for the Web sites, applications, virtual directories, application pools, and Web service
extensions that they are installing on the target machine.

InstallShield 2020 User Guide ISP-2600-UG00 1255

Chapter 4
Configuring Servers

Windows Installer uses MsiFormatRecord to resolve the property at run time. The installation writes the property and its
value to the following registry key so that the value is available during uninstallation and repair:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\InstallShield Uninstall
Information\{ProductCode}

Therefore, if your Web site is installed to an end user–specified site number, the Web site, its applications, and its virtual
directories can be successfully uninstalled from that site number.

Tip • If you do not want the IIS data to be stored in the registry, set the IS_IIS_DO_NOT_USE_REG property in your project.

If you use a property for any of the passwords in the Internet Information Services view, the passwords are encrypted when
they are stored in the registry.

Example
The following procedure demonstrates how to let end users specify during installation the user name used for anonymous
access to the Web site. Note that you can substitute a hard-coded value with a property for any of the IIS settings in the
Internet Information Services view that allow you to enter characters. The property that you specify in this view must be
enclosed within square brackets, and the property name must be all uppercase; for example, [MYPROPERTY].

Step 5 of the procedure is slightly different, depending on the project type, since Windows Installer controls the user
interface of Basic MSI installations, and the InstallScript engine controls the user interface of InstallScript MSI installations.

Task To let end users specify the user name:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, click the Web site whose user name end users should be able to specify for anonymous
access.

3. For the Enable anonymous access setting, select Yes.

4. In the Anonymous User Name setting, type the following:

[MYPROPERTY]

5. Use the property in a dialog. This part of the procedure depends on which project type you are using.

• For Basic MSI projects:

a. In the View List under User Interface, click Dialogs.

b. In the Dialogs explorer, expand the All Dialogs folder, and click the language under the dialog that should
contain the User Name control. As an alternative, you can add a new dialog.

c. Add an Edit Field control to the dialog, and set its Property property to the following:

MYPROPERTY

• For InstallScript MSI projects:

a. In the View List under Behavior and Logic, click InstallScript.

b. Find the dialog code in the OnFirstUIBefore event for the dialog that should contain the User Name control,
and add a call to the Windows Installer API function MsiSetProperty. For example, if you want the user

1256 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

name to be the name that the end user specifies on the CustomerInformation dialog, you would add an
MsiSetProperty call as shown in the following lines of code:

Dlg_SdCustomerInformation:
nResult = SdCustomerInformation(szTitle, svName, svCompany, nUser);
MsiSetProperty(ISMSI_HANDLE, "MYPROPERTY", svName);
if (nResult = BACK) goto Dlg_SdWelcome;

6. Build your release.

See Also
MsiFormatRecord (Windows Installer Help Library)
MsiFormatRecord (Windows Installer Help Library)
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
Working with Dialogs in Basic MSI Projects
Working with Dialogs in InstallScript and InstallScript MSI Projects
Dialog Functions
Dialog Customization Functions

Using InstallScript Text Substitution to Dynamically Modify IIS Settings

InstallShield 2020

Project • This information applies to InstallScript projects.

For InstallScript projects, you can configure an IIS setting dynamically at run time through the use of text substitution
string variables. This enables you to let end users specify the name of the virtual directory, the TCP port, the site number, or
other IIS settings for the Web sites, applications, virtual directories, application pools, and Web service extensions that they
are installing on the target machine. The InstallScript run-time code uses the TextSubSubstitute function to replace the
string variable with the appropriate value.

Example
The following procedure demonstrates how to let end users specify during installation the user name used for anonymous
access to the Web site. Note that you can substitute a hard-coded value with a text substitution string variable for any of
the IIS settings in the Internet Information Services view that allow you to enter characters. The string variable that you
specify in this view must be enclosed within angle brackets; for example, <MYPROPERTY>. The string variable that you
specify is case-sensitive.

Task To let end users specify the user name:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, click the Web site whose user name end users should be able to specify for anonymous
access.

3. For the Enable anonymous access setting, select Yes.

4. In the Anonymous User Name setting, type the following:

<MYPROPERTY>

InstallShield 2020 User Guide ISP-2600-UG00 1257

Chapter 4
Configuring Servers

5. In the View List under Behavior and Logic, click InstallScript.

6. Find the dialog code in the OnFirstUIBefore event for the dialog that should contain the User Name control, and add a
call to the InstallScript function TextSubSetValue. For example, if you want the user name to be the name that the
end user specifies on the CustomerInformation dialog, you would add a TextSubSetValue call as shown in the
following lines of code:

Dlg_SdRegisterUser:
szMsg = "";
szTitle = "";
//{{IS_SCRIPT_TAG(Dlg_SdRegisterUser)
nResult = SdRegisterUser( szTitle, szMsg, szName, szCompany );
TextSubSetValue("<MYPROPERTY>", szName, TRUE);
//}}IS_SCRIPT_TAG(Dlg_SdRegisterUser)
if (nResult = BACK) goto Dlg_SdLicense2;

7. Build your release.

See Also
Text Substitutions
Working with Dialogs in InstallScript and InstallScript MSI Projects
Dialog Functions
Dialog Customization Functions

Deploying Web Services on a Target Machine

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI
• Merge Module

Deploying a Web service onto a target system requires copying the Web service–specific files to a particular location and
assigning a virtual directory name for that folder so that the Web service can be accessed via HTTP.

Tip • To learn how to add a virtual directory to your project, see Creating a Web Site and Adding an Application or a Virtual
Directory.

Task To deploy a Web service on a target machine:

1. In the View List under Application Data, click Files and Folders.

2. Select the folder (target directory) for installing files on the target system. Add your files to this folder.

3. In the View List under Server Configuration, click Internet Information Services.

1258 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Servers

4. In the Web Sites explorer, select the virtual directory that is associated with the Web service.

5. In the Content Source Path (Local or UNC) setting, click the ellipsis button (...). The Browse for Directory dialog box
opens. Enter the same target directory as the one that contains the new files that you added in the Files and Folders
view.

At installation, files are copied to the target directory folder. In addition, the virtual directory is configured for that folder on
the target system if IIS is present.

See Also
Creating a Web Site and Adding an Application or a Virtual Directory
Internet Information Services View

Enabling Forms Authentication on Web Applications

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

You can use the Forms Authentication setting, displayed under the Security > Authenticated Access section of the
Internet Information Services view for a website, to set forms authentication on web applications. Set the Forms
Authentication option to Yes to enable forms authentication.

ASP.NET forms-based authentication works well for sites or applications on public Web servers that receive many requests.
This authentication mode lets you manage client registration and authentication at the application level, instead of relying
on the authentication mechanisms provided by the operating system.

Important • Forms authentication sends the user name and password to the Web server as plain text. You should use Secure
Sockets Layer (SSL) encryption for the Log On page and for all other pages in your application except the Home page.

Task To enable forms authentication on a website:

1. In the View List under Server Configuration, click Internet Information Services.

2. In the Web Sites explorer, select a website.

3. Under Security > Authenticated Access, set the Forms Authentication setting to Yes.

Adding IISROOTFOLDER Support

InstallShield 2020

IISROOTFOLDER is an InstallShield directory variable that is used to determine the root directory of the Web server on a
target system. If you are using IIS functionality in your installation project and you have added a Web site, then
IISROOTFOLDER is automatically added.

InstallShield 2020 User Guide ISP-2600-UG00 1259

Chapter 4
Configuring Servers

Note • All of the files added to the IISROOTFOLDER directory in the Files and Folders view are installed to the Web server’s root
directory on the target machine. If IIS is not installed, the files are copied to the root folder.

See Also
Internet Information Services View

IIS_WEBSITE_NAME Property
InstallShield 2020

The IIS_WEBSITE_NAME property is obsolete. If this property exists from earlier project versions, the upgrader will handle it
automatically. The upgrader will create a Web site and set the site number field to [IIS_WEBSITE_NAME]. For new Web sites,
you can use any property or hard-coded number.

IIS_PORT_NUMBER Property
InstallShield 2020

The IIS_PORT_NUMBER property is obsolete. If this property exists from earlier project versions, the upgrader will handle it
automatically. The upgrader will create a Web site and set the port number field to [IIS_PORT_NUMBER]. When you create
new Web sites, you can use any property or hard-coded number.

1260 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Preparing Installations for Maintenance and Uninstallation

Preparing Installations for Maintenance and

Uninstallation
InstallShield 2020

InstallShield lets your users rerun your installation to change program features or reinstall or remove your application.
When users select your application in Add or Remove Programs in the Control Panel, the installation displays dialog boxes
that let users do any of the following:

• Install individual features that were not previously installed, and uninstall individual features.

• Reinstall your application with the settings selected during the first installation.

• Uninstall your application.

To modify, repair, or uninstall an application, the operating system must have some indication that the application is
present. To allow this, an installation registers an application with the operating system so that it can be easily maintained
or uninstalled. You enter the necessary information in the General Information view.

In all InstallShield installations, maintenance (that is, modification and repair) is handled automatically by default.

In a Windows Installer–based installation, uninstallation is handled automatically—with the sole exception of custom
actions, which must either undo their own effect during uninstallation or have their effect undone by another custom
action that runs only during uninstallation.

In an InstallScript or InstallScript MSI installation, many script functions’ actions are logged for automatic uninstallation;
your uninstallation script must handle those script function actions that are not logged.

See Also
Preparing an InstallScript Installation for Uninstallation

Preparing an InstallScript Installation for Uninstallation

InstallShield 2020

Setting up uninstallation functionality is simple, considering the complexity of the operations that result.
CreateInstallationInfo (or InstallationInfo) and MaintenanceStart (or DeinstallStart) must be called. In an event-based
script, CreateInstallationInfo and MaintenanceStart are called in the default OnMoveData event handler code.

There are other functions that play important roles in setting up uninstallation functionality. For example, all keys created
using the RegDBCreateKeyEx function are recorded for uninstallation, unless logging is disabled. Also, if you call the
Disable function to disable logging, remember to call Enable to enable the logging again for subsequent actions that must
be recorded for uninstallation.

MaintenanceStart (or DeinstallStart) creates the necessary registry key and its necessary values. To create additional
registry values under this key, call RegDBSetItem, or for custom values use code like the following:

RegDBSetDefaultRoot( HKEY_USER_SELECTABLE );
RegDBSetKeyValueEx( "Software\\Microsoft\\Windows\\Current Version\\Uninstall\\" + INSTANCE_GUID, "My
Custom Value", nType, szValue, nSize);

Note • Uninstallation is available only if the initial installation calls FeatureTransferData or FeatureMoveData. (In an
event-based script, the FeatureTransferData function is called automatically.) If your installation installs files by some other

InstallShield 2020 User Guide ISP-2600-UG00 1261

Chapter 4
Preparing Installations for Maintenance and Uninstallation

means (for example, XCopyFile) and you want to make uninstallation available to your end users, deselect all components
and call FeatureTransferData or FeatureMoveData; while this call is executed, you can call SdShowMsg to display a
message.

Including Script Code to Be Executed During Uninstallation

Note • If you call DeinstallStart to enable uninstallation, the installation script is not executed during uninstallation. To
execute script code during uninstallation, call MaintenanceStart instead. (In an event-based installation, MaintenanceStart
is called in the default OnMoveData event handler code.)

Event-Based Scripts
If your script is event-based, the following event handler functions are called during uninstallation:

• OnBegin

• OnMaintUIBefore

• OnMoving

• <Feature name>Uninstalling (for each installed feature)

• <Feature name>Uninstalled (for each installed feature)

• OnMoved

• OnMaintUIAfter

• OnEnd

The code in these event handler functions (whose default code you can override) is executed during the uninstallation. For
instructions on executing certain event handler code only during uninstallation, or only during installation, see Executing
Script Code Only During Uninstallation or Only During Installation.

Procedural Scripts
If your script is procedural (that is, uses a program block) and calls MaintenanceStart rather than DeinstallStart to enable
uninstallation, the script is executed during uninstallation. For instructions on executing certain script code only during
uninstallation, or only during installation, see Executing Script Code Only During Uninstallation or Only During Installation.

Executing Script Code Only During Uninstallation or Only

During Installation
InstallShield 2020

The installation script is executed during uninstallation and maintenance installations if MaintenanceStart rather than
DeinstallStart is called to enable uninstallation. (In an event-based script, MaintenanceStart is called in the default
OnMoveData event handler code.) To execute code only during uninstallation or maintenance installations, enclose it in
the following if-then statement:

if MAINTENANCE then
/* this code is executed only during
uninstallation or maintenance installations */

1262 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Preparing Installations for Maintenance and Uninstallation

endif;

To execute code only during a first installation, enclose it in the following if-then statement:

if !MAINTENANCE then
/* this code is executed only during
a first installation */
endif;

If code is not enclosed in either if-then statement, it is executed during uninstallation, maintenance installations, and first
installations—with the following exceptions in event-based scripts:

• The code in the following event handlers is executed only during uninstallation and maintenance installations:

OnMaintUIBefore

OnMaintUIAfter

• The code in the following event handlers is executed only during the first installation:

OnCCPSearch

OnAppSearch

OnFirstUIBefore

OnFirstUIAfter

InstallScript Functions that Are Logged for Uninstallation

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI —if the InstallScript user interface (UI) style is the traditional style (which uses the InstallScript engine as
an external UI handler)

This information does not apply to InstallScript MSI projects in which the InstallScript UI style is the new style (which uses the
InstallScript engine as an embedded UI handler). To learn more, see Using the InstallScript Engine as an External vs.
Embedded UI Handler for InstallScript MSI Installations.

In general, if logging is enabled, all of the files, folders, registry entries, .ini file entries, shortcuts, shortcut folders, and
services that are created or replaced while logging is enabled are logged for uninstallation. In addition, all of the
InstallScript functions that make changes to the target system during InstallScript installations and InstallScript MSI
installations are logged for uninstallation. Following are some common examples of functions that an installation logs for
uninstallation by default:

• AddFolderIcon

• AddProfString

• CopyFile

• CreateInstallationInfo

• CreateProgramFolder

InstallShield 2020 User Guide ISP-2600-UG00 1263

Chapter 4
Preparing Installations for Maintenance and Uninstallation

• FeatureMoveData

• FeatureTransferData

• RegDBSetAppInfo

• RegDBSetItem

• ReplaceProfString

• ServiceAddService

• ServiceStartService

• VerSearchAndUpdateFile

• VerUpdateFile

• WriteProfString

• XCopyFile

You can disable and re-enable logging by calling Disable (LOGGING); and Enable (LOGGING); in your InstallScript code.
For more information, see Disable and Enable.

See Also
Uninstalling Initialization (.ini) File Entries

Maintenance/Uninstallation Feature
InstallShield 2020

The maintenance/uninstallation feature installs the files needed for maintenance setups and uninstallation, including
engine files; the files’ target location is specified by the value of the system variable DISK1TARGET. This feature is
automatically placed in your .cab files by the release builder and is not displayed in the InstallShield interface.

At run time the maintenance/uninstallation feature is automatically selected for all setup types. Calling FeatureUpdate
deselects this feature. The maintenance/uninstallation feature can also be selected or deselected by calling
FeatureSelectItem and passing the system variable DISK1COMPONENT as the function’s second argument. For example, the
following code deselects the feature:

FeatureSelectItem( MEDIA, DISK1COMPONENT, FALSE );

Removing Files that Were Created by Your Product

InstallShield 2020

By default, files created by your product after the installation is complete are assumed to be user data, and are not
removed when the user uninstalls your application.

1264 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Preparing Installations for Maintenance and Uninstallation

Basic MSI Project

Records you create in the RemoveFile table (using Direct Editor) can specify additional files to remove. For example, if your
application creates a file called Product.ini inside INSTALLDIR and you want the file removed when the component
containing your main executable is removed, add a record with the following contents to the RemoveFile table:

Table 4-1 • Additions to Add to the RemoveFile Table

FileKey remove_file

Component_ ProgramFiles

FileName Product.ini

DirProperty INSTALLDIR

InstallMode 2

InstallScript and InstallScript MSI Projects

In your script, you can call the DeleteFile and DeleteDir functions in uninstallation event handler functions to remove any
files or directories you want removed.

Removing Registry Data Created by Your Product

InstallShield 2020

By default, your product’s uninstallation removes only data that was created by your installation program.

Basic MSI Project

The Registry explorer understands a special uninstallation flag that controls the registry data to be removed during
uninstallation. In particular, using the “-” flag (“Uninstall entire key”) on a registry key causes the key and all its values and
subkeys to be removed during uninstallation.

Note • The RemoveRegistry table—exposed in the Direct Editor—specifies data to be removed only when your product is
installed. For details, see the Windows Installer Help Library.

InstallScript MSI Project

In your script, you can call the RegDBDeleteValue and RegDBDeleteKey functions in your uninstallation event-handler
functions to remove specified registry values and keys.

InstallShield 2020 User Guide ISP-2600-UG00 1265

Chapter 4
Preparing Installations for Maintenance and Uninstallation

1266 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Multiple Packages for Installation Using Transaction Processing

Configuring Multiple Packages for Installation

Using Transaction Processing
InstallShield 2020

Project • The following project types support multiple-package installations that use transaction processing:

• Basic MSI
• InstallScript MSI

Windows Installer 4.5 includes support for installing multiple packages using transaction processing. The packages are
chained together and processed as a single transaction. If one or more of the packages in the transaction cannot be
installed successfully or if the end user cancels the installation, the Windows Installer initiates rollback for all of the
packages to restore the system to its earlier state.

This section of the documentation explains how to specify .msi packages that you want InstallShield to include in your
installation as chained packages. This section also explains how to configure settings such as the properties that should be
passed to the chained packages.

Note • Windows Installer 4.5 includes support for installing multiple packages using transaction processing. Earlier versions
do not launch any chained .msi packages.

If you want your installation to install Windows Installer 4.5, see Adding Windows Installer Redistributables to Projects to learn
how.

See Also
Overview of Multiple-Package Installations that Use Transaction Processing
Adding a New Chained .msi Package to Your Project

Overview of Multiple-Package Installations that Use

Transaction Processing
InstallShield 2020

Project • The following project types support multiple-package installations that use transaction processing:

• Basic MSI
• InstallScript MSI

When you add one or more .msi packages to your installation as chained packages and an end user runs your installation
on a system that has Windows Installer 4.5, the Windows Installer can install all of the packages in a single transaction. If
one or more of the packages in the transaction cannot be installed successfully or if the end user cancels the installation,
the Windows Installer initiates rollback for all packages to restore the system to its earlier state.

InstallShield 2020 User Guide ISP-2600-UG00 1267

Chapter 4
Configuring Multiple Packages for Installation Using Transaction Processing

When the Windows Installer uses transaction processing, it batches together the various script states from the .msi
packages. For example, Windows Installer executes the InstallInitialize action during the Execute sequence; at this point in
the sequence Windows Installer executes all of the immediate actions for all of the packages and puts all of the deferred
actions in the installation script. Next, Windows Installer executes the deferred actions—but not the commit or rollback
actions—in the installation script for all of the packages. In addition, Windows Installer copies the rollback actions to the
rollback script. If the products for each of the packages are successfully installed up until this point, the Windows Installer
runs all of the commit actions for each of the packages; otherwise, the Windows Installer executes the rollback script to
return the target system to its original state.

For more information about this functionality, see Multiple-Package Installations in the Windows Installer Help Library.

Note • Windows Installer 4.5 includes support for installing multiple packages using transaction processing. Earlier versions
do not launch any chained .msi packages.

If you want your installation to install Windows Installer 4.5, see Adding Windows Installer Redistributables to Projects to learn
how.

See Also
Configuring Multiple Packages for Installation Using Transaction Processing
Adding a New Chained .msi Package to Your Project

Adding a New Chained .msi Package to Your Project

InstallShield 2020

Project • The following project types support multiple-package installations that use transaction processing:

• Basic MSI
• InstallScript MSI

InstallShield enables you to add already built Windows Installer packages (.msi files) to your project as chained .msi
packages. Windows Installer 4.5 includes support for installing the multiple packages using transaction processing. The
packages are chained together and processed as a single transaction. If one or more of the packages in the transaction
cannot be installed successfully or if the end user cancels the installation, the Windows Installer initiates rollback for all
packages to restore the system to its earlier state.

The Chained .msi Packages area of the Releases view is where you add to your project one or more .msi packages that you
want to be chained to your main installation.

Note • Windows Installer 4.5 includes support for installing multiple packages using transaction processing. Earlier versions
do not launch any chained .msi packages.

If you want your installation to install Windows Installer 4.5, see Adding Windows Installer Redistributables to Projects to learn
how.

1268 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Multiple Packages for Installation Using Transaction Processing

Task To add an .msi package as a chained package:

1. In the View List under Media, click Releases.

2. Right-click the Chained .msi Packages explorer and then click New Chained Package. InstallShield adds a new item
with a default name.

3. Enter a new name, or right-click it later and click Rename to give it a new name.

The name is not displayed at run time; it is an internal name that is used to differentiate between different chained
.msi packages in the main installation.

4. Select the new chained package item. InstallShield displays its settings in the right pane.

5. For the Installation (run-time path) setting, click the Browse button. The Browse for File dialog box opens.

6. Select the Windows Installer package (.msi file) that you would like to add, and then click Open. The package that you
select must be an .msi package that can be installed through MsiInstallProduct. Note that it cannot be an
InstallScript MSI package.

InstallShield prompts you to specify whether you want to stream the .msi package—and its uncompressed files, if the .msi
package is not compressed—into your product’s main .msi package:

• If you specify that you want InstallShield to stream the files, InstallShield adds the name of the .msi package to the
Installation (run-time path) setting. InstallShield also automatically adds either the file name (if it is a compressed
.msi package) or the entry *.* (if it is an uncompressed .msi package) to the Streamed files box. For the *.* wild-card
entry, InstallShield streams in the .msi package as well as all of the files in the same folder as the .msi package.

• If you specify that you do not want InstallShield to stream the files, InstallShield adds the following path to the
Installation (run-time path) setting:

[SourceDir]FileName.msi

You can change this path if appropriate. For example, you may want to use a path such as the following one, and also
clear the Delete streamed files after installation check box:

[LocalAppDataFolder]{ProductCodeGUID}\FileName.msi

In this example, the .msi package is cached on the local system, and it is available for maintenance.

Tip • You may not want to stream in the .msi package, since Windows Installer has limitations for the file size of .msi
packages.

7. Configure the chained .msi package settings as needed. To learn more, see Chained .msi Package Settings.

If your main installation includes several chained .msi packages, InstallShield uses the Order column in the
ISChainPackage table of the main installation to determine the order in which the chained packages should be launched
at run time. All uninstallations are processed in reverse order, from highest to lowest order number; all installations are
processed in forward order, from lowest to highest order number.

Note • If you have specified .msi packages in the Chained .msi Packages area in the Releases view, InstallShield does not
build the chained packaged when you build releases for your main installation.

InstallShield 2020 User Guide ISP-2600-UG00 1269

Chapter 4
Configuring Multiple Packages for Installation Using Transaction Processing

See Also
Assigning Release Flags to a Chained .msi Package
Chained .msi Package Settings

Assigning Release Flags to a Chained .msi Package

InstallShield 2020

Project • The following project types support multiple-package installations that use transaction processing:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

You can assign one or more release flags to a chained .msi package that you want to exclude from certain builds. For
example, if you have a chained .msi package that should be included only in a special edition of your product that contains
a special add-on that requires the chained .msi package, you can flag that chained package and include it only when it is
needed.

Task To add a release flag to a chained .msi package that you have added to your installation project:

1. In the View List under Media, click Releases.

2. In the Chained .msi Packages explorer, select the package that should contain the release flag.

3. For the Release flags setting, type a string. The string can be any combination of letters or numbers. To have more
than one flag on a chained package, use a comma to separate the flags.

To learn more about filtering chained .msi packages based on release flags, see Release Flags.

See Also
Chained .msi Package Settings

Removing a Chained .msi Package from Your Project

InstallShield 2020

Project • The following project types support multiple-package installations that use transaction processing:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

1270 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Configuring Multiple Packages for Installation Using Transaction Processing

Task To remove a chained .msi package from your project:

1. In the View List under Media, click Releases.

2. In the Chained .msi Packages explorer, right-click the chained .msi package that you want to remove from your
project, and then click Remove.

InstallShield removes the chained .msi package from your project. Note that InstallShield does not delete the .msi
package, or any of its files, from your file system.

InstallShield 2020 User Guide ISP-2600-UG00 1271

Chapter 4
Configuring Multiple Packages for Installation Using Transaction Processing

1272 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Building, Testing, and Deploying Installations

InstallShield 2020

Once you have configured the features, components, files, shortcuts, registry entries, end-user dialogs, and other elements
of your installation project, you are ready to create and build a release for your installation. InstallShield lets you create
multiple releases for a project and configure each release for a different media type and according to different sets of
requirements. Building releases packages the content of your installation, creating a disk image that you can copy to your
distribution media and distribute or deploy as needed.

Testing is an essential part of creating a reliable installation. InstallShield enables you to selectively test run just the end-
user interface portion of a release. You can also run your installation by simply clicking a button in InstallShield; when you
run an installation by using this method, your installation executes exactly as it would on an end user’s machine. All files
are transferred, shortcuts and registry entries are made, and the user interface is displayed.

Before you release your product, you may want to validate your installation project. Validating a Windows Installer project
involves applying a set of internal consistency evaluator (ICE) rules to your installation project. These ICEs are designed by
Microsoft to help you determine whether your resulting installation package contains a valid database that performs its
actions correctly.

With the debugging tools in InstallShield, you can debug your InstallScript script or Windows Installer release to identify
the sources of problems. When you debug a script, you execute your script, statement by statement, and trace the flow of
control by watching the execution point as it moves through the script. You can also monitor the value of any variable in
your script at any point during script execution. When you debug a Windows Installer release, InstallShield runs through
each action and dialog box until it reaches your breakpoint, when it halts execution. At this point, you can view and set
properties.

See Also
Working with Releases
Validating Projects
Releases View

Creating and Building Releases

InstallShield 2020

Once you have designed your project in InstallShield, you are ready to create a release that you can configure and build to
distribute to end users. The release is built according to the options you set for it in the Release Wizard or in settings that
are displayed in the Releases view.

Working with Product Configurations

InstallShield 2020

Project • The following project types support product configurations:

• Basic MSI
• InstallScript MSI
• Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1273

Chapter 4
Building, Testing, and Deploying Installations

Every release that you build is a member of a product configuration. A product configuration provides a means for
grouping together releases that share similar properties, such as the product name, product code, and package code.

Product configurations also enable you to keep a history of your builds without having to set up a folder structure outside
InstallShield. For example, when your product is in development, you might have many releases of the same version. You
do not necessarily want to overwrite each release every time that you rebuild the product. With product configurations,
you can maintain your previous build history and incorporate new releases at the same time.

In the past, you may have had to maintain this type of historical record of your builds outside InstallShield. You had to
create a directory structure on a drive, label each folder manually, and then copy the release into its directory. With
product configurations, all of this is done for you in InstallShield.

Task To create a product configuration:

1. In the View List under Media, click Releases.

2. Right-click the Releases explorer and then click New Product Configuration.

InstallShield adds a new product configuration to the Releases explorer. InstallShield lists the product configuration
settings on the General tab.

For descriptions about each of the product configuration settings, see General Tab for a Product Configuration.

Tip • You can also create product configurations through the Release Wizard. You can specify existing product configurations
from the command line (using the -a parameter), but you cannot define the settings of a release through the command line.

See Also
Releases View

Selecting the Appropriate Type of Architecture Validation for Builds

InstallShield 2020

Project • The following project types support product configurations:

• Basic MSI
• Merge Module

As x64 Windows-based systems that do not have 32-bit Windows-on-Windows (WOW64) support become more common,
you may want to perform architecture validation when building a release in InstallShield. Architecture validation enables
you to detect potentially problematic cases in which your installation may try to install product files or use run-time
binaries that may not match the architecture of a target system.

For example, if end users may run your installation on x64 Windows Server Core systems that do not have WOW64 support,
architecture validation can help you identify any x86 product files or x86 custom action files in your installation; x86
binaries cannot be loaded on x64 target systems without WOW64 support.

In addition, if you are mixing x64 and x86 product files (or x64 and x86 custom actions) in a single project and generating
separate x86 and x64 .msi packages, you can use architecture validation to identify any x64 product or custom action files
in your x86 releases, since these files cannot be loaded on x86 target systems.

1274 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Architecture validation also enables you to generate pure x86 .msi packages that contain only x86 versions of the built-in
InstallShield custom action DLLs, or pure x64 .msi packages that contain only x64 versions of the built-in InstallShield
custom action DLLs. To enable this functionality, InstallShield uses two predefined path variables:
ISRedistPlatformDependentFolder and ISRedistPlatformDependentExpressFolder. By default, the values of these path
variables are subfolders that contain x86 versions of the InstallShield custom action DLLs; the subfolders are in the
following directory: InstallShield Program Files Folder\Redist. InstallShield modifies the values of these path
variables at build time if necessary to include the x64 versions (instead of the x86 versions) of the InstallShield custom
action DLLs in releases; these files are in different subfolders in InstallShield Program Files Folder\Redist.

Overview of Architecture Validation

InstallShield offers the following levels of support for build-time architecture validation:

• None—Bypass build-time architecture validation.

• Lenient—This type of validation lets you build x86 and x64 .msi packages (as indicated by the Template Summary
property), and mix x86 and x64 product files and custom action files in both of those types of packages.

At build time, the ISRedistPlatformDependentFolder and ISRedistPlatformDependentExpressFolder path variables

point to the x86 locations that contain x86 InstallShield custom action DLLs. InstallShield includes these x86 custom
action DLLs in the build if your project includes support that requires these custom actions.

Lenient validation does not trigger build errors if the architecture that the Template Summary property specifies does
not match the architecture for one or more of the custom action files that are being included in the release.

Lenient validation does not trigger build warnings if the architecture that the Template Summary property specifies
does not match the architecture for one or more of the product files that are being included in the release.

Lenient is the default option.

• Strict—With this type of validation, InstallShield attempts to build a pure x86 or pure x64 .msi package, depending on
whether the Template Summary property specifies Intel (for x86) or x64.

If the Template Summary property specifies Intel, the ISRedistPlatformDependentFolder and

ISRedistPlatformDependentExpressFolder path variables point to the x86 locations that contain x86 InstallShield
custom action DLLs. However, if the Template Summary property specifies x64 and you are using strict validation,
these path variables point to the x64 locations that contain x64 InstallShield custom action DLLs. If your project
includes support that requires any of these custom actions, InstallShield adds the appropriate x86 or x64 versions of
the DLLs to the build.

Strict validation may trigger build errors if the architecture that the Template Summary property specifies does not
match the architecture for one or more of the custom action files that are being included in the release. Thus, during
build-time validation of an x86 package, InstallShield generates a build error for each x64 custom action file in the
package. During build-time validation of an x64 package, InstallShield generates a build error for each x86 custom
action file in the package.

Strict validation may trigger build warnings if the architecture that the Template Summary property specifies does not
match the architecture for one or more of the product files that are being included in the release. Thus, during build-
time validation of an x86 package, InstallShield generates a build warning for each x64 product file in the package.
During build-time validation of an x64 package, InstallShield generates a build warning for each x86 product file in the
package.

Tip • For information on the Template Summary property, see Using the Template Summary Property.

InstallShield 2020 User Guide ISP-2600-UG00 1275

Chapter 4
Building, Testing, and Deploying Installations

For additional tips on targeting 64-bit operating systems, see Targeting 64-Bit Operating Systems with Basic MSI and
InstallScript MSI Installations.

Selecting the Type of Architecture Validation

InstallShield lets you specify which type of architecture validation you want to use for each product configuration that is
defined in the Releases view of your project.

Task To select the type of architecture validation that you want InstallShield to perform at build time:

1. In the View List under Media, click Releases.

2. In the Releases explorer, select the product configuration that you want to configure.

3. On the General tab, in the Architecture Validation setting, select the appropriate option. Available options are:

• None

• Lenient

• Strict

Troubleshooting Build Errors and Warnings for Strict Architecture Validation

If you are using strict architecture validation to build an .msi package that specifies x64 for the Template Summary
property, InstallShield may generate errors and warnings such as the following ones at build time:

error -7319: 32-bit Standard DLL Custom Action MyCustomAction must not be included in a strict 64-bit
package.

warning -7326: Including 32-bit PE file C:\SourceFiles\x86\Myx86File.exe in a strict 64-bit package.

In many cases, an x64 target system can run an x86 file. However, if the x64 system does not have WOW64 support, it may
not be able to run an x86 file.

Depending on your requirements, you may want to replace the x86 file or custom action that is referenced in a build error
or warning with an x64 file or custom action. In other scenarios, you may want to ignore a build error or warning. For
example, if a file’s component has a condition that prevents the component from being installed on x64 systems, you may
want to ignore its corresponding build warning. In some cases, you may decide to reexamine your requirements—that is,
you may want to avoid supporting x64 target systems that do not have WOW64 support.

Similarly, you may encounter build errors and warnings if you are using strict architecture validation to build an x86 .msi
package; for example:

error -7320: 64-bit Standard DLL Custom Action MyCustomAction must not be included in a strict 32-bit
package.

warning -7327: Including 64-bit PE file C:\SourceFiles\x64\Myx64File.exe in a strict 32-bit package.

An x86 system cannot run any x64 files or custom actions. Depending on your requirements, you may choose to make
changes to your project or ignore the build errors and warnings. In some cases, you may decide to reexamine your
requirements.

See Also
Targeting 64-Bit Operating Systems

1276 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Working with Releases

InstallShield 2020

Project • For installation projects: Before building your installation project, ensure that you have completed designing and
configuring the settings for every element in your project, including the features, components, files, shortcuts, registry entries,
and end-user interface.

For merge module projects: Before building your package, ensure that you have completed designing and configuring the
settings for every element in your merge module, including components, files, shortcuts, and registry entries.

Once you have designed your project in InstallShield, you are ready to create a release that you can configure and build to
distribute to end users. You can create multiple releases for a project and configure each release for a different media type
and according to different sets of requirements. InstallShield offers several methods for creating and building a release:

• Use the Release Wizard. (This method is not available in Advanced UI or Suite/Advanced UI projects.)

• Use the Releases view.

• Build from the command line using ISCmdBld.exe.

• Build a release through the automation interface. (This method is not available in Advanced UI or Suite/Advanced UI
projects.)

For information on building an InstallShield release from within Visual Studio, see Building Releases in Microsoft Visual
Studio.

Tip • Make sure that Windows Explorer is not pointing to the Disk1 folder or a subfolder when you build your release. If
Windows Explorer is pointing to the Disk1 folder, the build process fails and generates an error.

See Also
Release Wizard
Build Errors and Warnings
Cloning Releases
Rebuilding Releases
Performing Quick Builds
Build Method

Using the Release Wizard to Create and Build a Release

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

InstallShield 2020 User Guide ISP-2600-UG00 1277

Chapter 4
Building, Testing, and Deploying Installations

The Release Wizard provides an easy way for you to build a product release and specify the settings for that release.

Task To launch the Release Wizard and build your installation package, do one of the following:

• Click the Release Wizard button on the toolbar.

• On the Build menu, click Release Wizard.

• In the Releases view, right-click a release and click Release Wizard.

Follow the instructions in the panels of the Release Wizard. For a list of errors returned by the wizard, see Build Errors and
Warnings.

See Also
Building Releases in Microsoft Visual Studio
Release Wizard

Using the Releases View to Create and Build a Release

InstallShield 2020

The Releases view lets you specify the settings for a release and build it. The procedure for creating and building a release
depends on what project type you are using.

Creating and Building a Release in Basic MSI, InstallScript MSI, and Merge Module
Projects

Task To create and build a release:

1. In the View List under Media, click Releases.

2. In the Releases explorer, right-click the product configuration that should contain the new release, and then click
New Release. For information on how to create a new product configuration, see Working with Product
Configurations. InstallShield adds a new release under the product configuration. Its settings are displayed on the
tabs.

3. Configure the release’s settings as appropriate.

4. Right-click the release and then click Build.

Creating and Building a Release in Advanced UI and Suite/Advanced UI Projects

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

1278 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Task To create and build a release:

1. In the View List under Media, click Releases.

2. Right-click the Releases explorer, and then click New Release. InstallShield adds a new release. Its settings are
displayed on the tabs.

3. Configure the release’s settings as appropriate.

4. Right-click the release and then click Build.

Creating and Building a Release in an InstallScript or InstallScript Object Project

Task To create and build a release:

1. In the View List under Media, click Releases.

2. Right-click the Releases explorer, point to New Release, and click the type of media that you want to create.
InstallShield adds a new release to the explorer. Its settings are displayed on the tabs.

3. Configure the release’s settings as appropriate.

4. Right-click the release and then click Build.

See Also
Building Releases in Microsoft Visual Studio
Configuring Release Settings

Setting the Release Location

InstallShield 2020

The disk image folders for your installation are built in the release location. All additional files and folders that are
necessary for storing uncompressed application files are placed in subfolders of the disk image folders. The release
location is a subfolder of your project’s location.

To see your release after you have built it, click Disk Images under the product name and the release name in the Releases
view. If you have not changed the release location, InstallShield places the built installation package into the following
folder:

InstallShield Project Folder\project name\product configuration\release name\DiskImages\Disk1

You can set the release location either in the Advanced Settings panel of the Release Wizard or in the Release Location
property in the Releases view.

See Also
Changing the Default Project Location

InstallShield 2020 User Guide ISP-2600-UG00 1279

Chapter 4
Building, Testing, and Deploying Installations

Building a Release from the Command Line

InstallShield 2020

You can build a release from the command line using ISCmdBld.exe for Windows Installer–based projects, for InstallScript
projects, and for Advanced UI or Suite/Advanced UI projects. If your project includes InstallScript, ISCmdBld.exe also
compiles it before building the release.

Using ISCmdBld.exe to build an installation can be useful if you are trying to build from a batch file. Also, building a release
from the command line using ISCmdBld.exe will handle the conversion of .ipr and .ipo files (object project files created
using InstallShield Professional) to an .ism file, in addition to building the release.

Tip • An .ism file in either binary or XML format is accepted by the command-line build. The command-line build also works
with Advanced UI and Suite/Advanced UI project files (.issuite).

You can build a release from the command line using ISCmdBld.exe with the Standalone Build. For more information, see
Standalone Build.

See Also
ISCmdBld.exe
Using ISCmdBld.exe to Build a Release from the Command Line
Building Releases in Microsoft Visual Studio

Using ISCmdBld.exe to Build a Release from the Command Line

InstallShield 2020

ISCmdBld.exe is located by default in the InstallShield folder’s System subfolder. Do not move ISCmdBld.exe from its
installed location.

For the syntax and available command-line parameters for ISCmdBld.exe, see ISCmdBld.exe.

See Also
Using Source Code Control at the Command Line

Passing Command-Line Build Parameters in an .ini File

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

If you want to pass numerous parameters during a command-line build, or if you consistently pass the same parameters, it
might be convenient to use an .ini file. The following statement illustrates running ISCmdBld.exe to build a release with
parameters as specified in the MySetup.ini file.

1280 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

ISCmdBld.exe -i "C:\InstallShield 2020 Projects\MySetup.ini"

You need to include the same information in the .ini file as you would if you were passing the parameters at the command
line. There are four sections for this file:

• [Project]—In this section, include entries for the path to the project file (.ism), as well as the name of the product
configuration. If you are building a patch, include an entry for the name of the patch configuration that you are
building.

• [Release]—In this section, include entries for release configuration information such as the compression type
(compressed or uncompressed), build flags, Setup.exe settings, and the release name.

• [Mode]—In this section, include any of the available optional entries, such as the Silent=yes entry if you want to build
your release while suppressing any build errors or warning messages. This section also lets you indicate whether a log
file should be created.

• [BuildLocation]—In this section, you can optionally specify the release output location.

Not all sections are required. As with passing parameters directly from the command line, parameters for requirements
such as silent build and build location are optional. In the example .ini file below, these parameters are in the [Mode] and
[BuildLocation] sections. You can omit these entries from your .ini file if you want to accept the defaults. By default, no
log file is created, the installation is not run in silent mode, and your release is created in the project location that is
specified on the File Locations tab of the Options dialog box.

Sample .ini File

The following tables contain sample entries from each of the four sections in a sample .ini file. The first column of each
table shows a sample entry. The other columns provide the corresponding command-line parameter and description.

InstallShield 2020 User Guide ISP-2600-UG00 1281

Chapter 4
Building, Testing, and Deploying Installations

Entries in the [Project] Section

Table 4-1 • Sample Entries in the [Project] Section of the .ini File

Corresponding
ISCmdBld.exe
Command-Line
Entry Parameter Description

Name="C:\InstallShield 2020 -p Path to the .ism file.

Projects\Othello.ism"

BuildLabel=Label1 -a Name of the product configuration for the release that

you are building. If it does not exist, it is created.

Product=Othello Name of your product. This entry lets you override the
value that is specified in the General Information view.

PatchConfigName=“Version 1.2” -patch_config Name of the patch configuration in the Patch Design
view that you want to build.

CompileScript=no -n Ensures that Setup.rul is not compiled as part of the

build process.

Note • CompileOnly should not be used with

CompileScript.

Entries in the [Release] Section

Table 4-2 • Sample Entries in the [Release] Section of the .ini File

Corresponding
ISCmdBld.exe
Command-Line
Entry Parameter Description

BuildFlags=flags -f Release flags to be included in the installation,

separated by commas.

Configuration=COMP -c Compressed vs. uncompressed.

Name=Othello Beta -r Release name.

SetupEXE=yes -e Creates a Setup.exe file.

1282 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Entries in the [Mode] Section

Table 4-3 • Sample Entries in the [Mode] Section of the .ini File

Corresponding
ISCmdBld.exe
Command-Line
Entry Parameter Description

CubFile="C:\Program -m Validate the installation or merge module package

Files\InstallShield\2020\Support\Vali after it is built using the specified .cub file. Include the
dation\MyValidation.cub" full path and name to the .cub file.

To use multiple .cub files, separate each path with a

semicolon (;). Enclose long file names in quotation
marks.

For example, the following entry indicates that

validation should be performed with the InstallShield
Validation Suite for Windows 8 (ISWin8.cub) and the
Full MSI Validation Suite (darice.cub):

CubFile="C:\Program
Files\InstallShield\2020\Support\Validation\IS
Win8.cub;C:\Program
Files\InstallShield\2020\Support\Validation\da
rice.cub"

Silent=yes -s Runs in silent mode.

StopOnFirstError=yes -x Aborts the build when the first error is encountered.

CompileOnly=no -q3 Compiles only Setup.rul and streams Setup.inx into

the Binary table of the .msi file, if one was previously
built.

Note • The entries CompileOnly,

BuildTablesRefreshFiles, and BuildTablesOnly are
mutually exclusive. Only one can be set to yes.

CompileOnly should not be used with CompileScript.

BuildTablesRefreshFiles=no -q2 Builds the Windows Installer tables and refreshes files.

Note • The entries CompileOnly,

BuildTablesRefreshFiles, and BuildTablesOnly are
mutually exclusive. Only one can be set to yes.

InstallShield 2020 User Guide ISP-2600-UG00 1283

Chapter 4
Building, Testing, and Deploying Installations

Table 4-3 • Sample Entries in the [Mode] Section of the .ini File (cont.)

Corresponding
ISCmdBld.exe
Command-Line
Entry Parameter Description

BuildTablesOnly=yes -q1 Builds only the Windows Installer tables for your
release.

Note • The entries CompileOnly,

BuildTablesRefreshFiles, and BuildTablesOnly are
mutually exclusive. Only one can be set to yes.

UpgradeOnly=no -u Allows you to upgrade—but not build—your release.

Verbose=yes -v Generates an engine log file.

WarningAsError=yes -w Treats any build warnings as build errors.

MSIVersion=2.0 -g Version of Windows Installer required on target

system.

Note • This entry applies to the Standalone Build only.

DotNetVersion= -j Minimum version of Microsoft .NET Framework

required on the target system. This parameter is
optional and defaults to the latest version of the .NET
Framework supported by InstallShield.

Note • This entry applies to the Standalone Build only.

DotNetPath="C:\..." -t Path to the Microsoft .NET Framework on the build

machine.

Note • This entry applies to the Standalone Build only.

SkipValidators=yes -h Enables you to turn off the upgrade validators that

normally run at the end of the build.

Note • This entry applies to the Standalone Build only.

1284 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-3 • Sample Entries in the [Mode] Section of the .ini File (cont.)

Corresponding
ISCmdBld.exe
Command-Line
Entry Parameter Description

MergeModulePath="C:\..." -o Search path for merge modules (.msm files).

For more information, see Specifying the Directories

that Contain Merge Modules.

Note • This entry applies to the Standalone Build only.

PrerequisitePath="C:\..." -prqpath Search path for InstallShield prerequisite files (.prq).

For more information, see Specifying the Directories

that Contain InstallShield Prerequisites.

Note • This entry applies to the Standalone Build only.

LicCheckTimeOut="40" -licCheckTimeOut Sets the time period to check the availability of the
<seconds> license from the license server.

Entries in the [BuildLocation] Section

Table 4-4 • Sample Entries in the [BuildLocation] Section of the .ini File

Corresponding
ISCmdBld.exe
Command-Line
Entry Parameter Description

Path="C:\InstallShield 2020 -b Release output location.

Projects\Othello"

For more information about the .ini file entries, see Building a Release from the Command Line.

See Also
Standalone Command-Line Build

Using ISBuild.exe to Build from the Command Line

InstallShield 2020

Project • This information applies to InstallScript projects.

InstallShield 2020 User Guide ISP-2600-UG00 1285

Chapter 4
Building, Testing, and Deploying Installations

ISBuild.exe, a command-line tool that is available for legacy InstallScript projects, is a shell that calls into ISCmdBld.exe.
ISCmdBld.exe handles the conversion of .ipr and .ipo (object projects created using InstallShield Professional) files to an
.ism file and builds the release.

For a list of command-line parameters for ISBuild.exe, see ISBuild.exe.

See Also
ISCmdBld.exe

Building a Self-Extracting Executable File from the Command Line

InstallShield 2020

Project • This information applies to InstallScript projects.

You can build a self-extracting executable file from the command line using ReleasePackager.exe. This can be useful if you
are building from a batch file.

ReleasePackager.exe is located by default in the InstallShield folder’s System subfolder. Do not move
ReleasePackager.exe from its installed location.

For syntax and available arguments and options for ReleasePackager.exe, see ReleasePackager.exe.

See Also
Using Source Code Control at the Command Line

Rebuilding Releases
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

You can rebuild a release at any time using the default entries that you already provided in the settings in the Releases
view. The release that currently has focus is rebuilt.

Task To rebuild a release, do one of the following:

• Click the Build button.

• On the Build menu, click Build.

1286 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• In the Releases view, right-click a release name and then click Build.

You can run the Release Wizard again to rebuild a release. Because the wizard stores the release settings in your
InstallShield project file, the wizard displays all of the options that you set when you last built the release, even if you
deleted the release.

To see your new installation package, click Disk Image(s) for the appropriate release in the Releases view. InstallShield
places the built installation package into the following folder if you have not changed the default release location:

C:\InstallShield 2020 Projects\project name\product configuration\release name\DiskImages\Disk1

Note • Make sure that Windows Explorer is not pointing to the Disk1 folder or a subfolder when you build your release. If it is
pointing to the Disk1 folder, the build process can continue indefinitely. If Windows Explorer is accessing a subfolder, the build
generates an error.

See Also
Running Installations from the InstallShield Interface
Building Releases in Microsoft Visual Studio

Performing Quick Builds

InstallShield 2020

When you are testing your installation, you might not want to continually build all of your installation files if no files have
been changed. InstallShield provides you with two quick build options: Build Tables Only and Build Tables & Refresh Files.

Build Tables Only

As the name of this option implies, only the Windows Installer tables are built. If you have not built this installation already,
a new .msi file is created, but no files are added to your installation. If you have built your installation already, the .msi file
is updated when all the tables are built, but no files are transferred. You can use this option to test the installation’s user
interface.

Task To build only your installation’s Windows Installer tables, do one of the following:

• On the Build menu, click Build Tables Only.

• In the Releases view, right-click the release that you would like to build and click Build Tables Only.

Build Tables & Refresh Files

If you would like a near-complete build without having to transfer all of the installation’s files to a new location, you can
perform a build that rebuilds your .msi file and updates the Files table, thereby including any new or changed files in your
installation. Changed files are updated only if the size or time stamp differs from the copy already included in the build.
References to deleted files are removed from the installation, but the file remains in the build location. This type of build
works only when the media is an uncompressed network image.

Task To build your Windows Installer tables and refresh the installation’s files, do one of the following:

• On the Build menu, click Build Tables & Refresh Files.

InstallShield 2020 User Guide ISP-2600-UG00 1287

Chapter 4
Building, Testing, and Deploying Installations

• In the Releases view, right-click the release that you would like to build and click Build Tables & Refresh Files.

Performing Batch Builds

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module

You might need to build multiple releases with different configurations simultaneously. This functionality is known as a
batch build.

Task To perform a batch build through InstallShield:

1. In the View List under Media, click Releases.

2. In a Basic MSI, InstallScript MSI, or Merge Module project: Right-click a product configuration and click Batch Build.

In an InstallScript or InstallScript Object project: Right-click the Releases explorer and click Batch Build.

The Batch Build dialog box opens to prompt you to select the product configurations and releases that you would like to
build.

Specifying Commands that Run Before, During, and After Builds

InstallShield 2020

Edition • This functionality is available in the Premier edition of InstallShield.

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• Merge Module
• Suite/Advanced UI

Some project-specific differences are noted where applicable.

1288 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

InstallShield lets you specify commands that you want to be run at various stages of the build process. For example, if you
are developing a Basic MSI project, you may want to modify the .msi package that InstallShield creates at build time before
InstallShield digitally signs it and streams it into the Setup.exe file. You can specify a command that runs a script that
makes the required changes to the .msi package at the appropriate time during the build.

When you are entering a command, you can use any path variables and environment variables that are defined in your
project, instead of using a hard-coded path. You can also use the following variables that are defined specifically for build
event commands.

Table 4-5 • Build Event Variables

Variable Project Types Description

<ISReleaseName> Basic MSI, This variable indicates the name of the release that
InstallScript, InstallShield is building.
InstallScript MSI,
Merge Module,
Suite/Advanced UI

<ISProductConfigName> Basic MSI, This variable indicates the name of the product
InstallScript, configuration that contains the release that
InstallScript MSI, InstallShield is building. (Note that this is always
Merge Module Media for InstallScript projects.)

<ISReleasePath> Basic MSI, This variable indicates the build location of the
InstallScript, release that InstallShield is building. It is set through
InstallScript MSI, the Release Location setting on the Build tab for a
Merge Module, release in the Releases view.
Suite/Advanced UI

<ISReleaseUsesShallowFolderPaths> Basic MSI, This variable is set to true or false to indicate whether
InstallScript MSI InstallShield uses a shallow folder directory structure
when building your release.

At build time, InstallShield sets temporary <ISReleaseName>, <ISProductConfigName>, <ISReleasePath>, and

<ISReleaseUsesShallowFolderPaths> environment variables; InstallShield also sets temporary environment variables for
all of the defined path variables in your project. You can refer to the value of one of these environment variables in a batch
file by surrounding the variable name with percent signs (%); for example:

set PATH = %<ISReleaseName>%;%PATH%

When the build is complete, InstallShield deletes the temporary environment variables that it set.

Task To specify one or more commands that run before, during, or after a build:

1. In the View List under Media, click Releases.

2. In the Releases explorer, click the release that you would like to configure.

3. Click the Events tab.

4. In one or more of the following settings, enter the commands that you want InstallShield to run:

InstallShield 2020 User Guide ISP-2600-UG00 1289

Chapter 4
Building, Testing, and Deploying Installations

• Prebuild Event

• Precompression Event (This event is not available in Suite/Advanced UI projects.)

• Postbuild Event

Enter each command as it would be launched from the command prompt. Thus, for example, if you specify a path that
includes spaces, enclose the path within quotation marks.

For details about each setting, see Events Tab for a Release.

To specify more than one command for any of those settings, click the ellipsis button (...) in the setting. A dialog box
opens, enabling you to enter one or more commands. Enter each command on a separate line.

If you enter more than one command for an event settings, InstallShield runs each command at build time in the order that
they are listed for that setting. The build waits until a command finishes before proceeding to the next one.

Tip • A verbose build log shows each of the build events that are run at build time. To troubleshoot build events, generate a
verbose log file and search for strings such as “Launching prebuild events”, “Launching precompression build events”, and
“Launching postbuild events”. These areas of the log list details about the commands that are run at build time.

To generate a verbose build log, pass the -v parameter when launching IsCmdBld.exe from the command line.

See Also
ISCmdBld.exe

Resolving Build Errors and Warnings

InstallShield 2020

When you build a release, the Output window opens across the bottom of the InstallShield user interface. The Tasks tab of
this window lists any build errors and warnings that occur during the build process.

Task To learn how to resolve a build error or warning that you encounter, do one of the following:

• On the Tasks tab of the Output window, click an error code to launch your Internet browser and see Knowledge Base
articles and HelpNet topics for the selected build error or warning.

• See Build Errors and Warnings, which provides tips on how to resolve build errors and warnings.

Changing Project Settings from the Command Line

InstallShield 2020

The InstallShield automation interface enables you to query and modify many project settings from an unattended build
process, using, for example, a VBScript script or Visual Basic application.

The framework of any script that uses the automation interface to access a project appears as follows (you can copy this
script into a text file called Framework.vbs and then double-click the file icon):

Set oProject = CreateObject("IswiAutoAutomation Interface Version.ISWiProject")

oProject.OpenProject "C:\MySetups\MyProject.ism"

1290 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

' perform queries and changes here

oProject.SaveProject ' necessary only if modifying the project

oProject.CloseProject

See Also
Automation Interface
Automating Installation Development and Build Processes

Canceling Builds
InstallShield 2020

Task To cancel a build after it has started:

Click the Stop Build button on the toolbar.

Standalone Build
InstallShield 2020

InstallShield provides a Standalone Build module that enables you to install only the part of InstallShield that compiles the
installations, plus any redistributables that you want to include. For instructions on installing the Standalone Build and any
redistributables on a build machine, see Installing the Standalone Build on a Build Machine.

The InstallShield 2020 Standalone Build can coexist with other major versions of the Standalone Build on the same
machine (in different folders).

Upgrading Projects
The Standalone Build automatically upgrades projects that were created with InstallShield Developer 7.0 or later.
However, it does not upgrade projects that were created with InstallShield for Windows Installer.

Using the Command-Line Build

You can run the Standalone Build from the command line. For more information, see Standalone Command-Line Build.

Using the Standalone Automation Interface

The Standalone Build includes a standalone version of the automation interface—the Standalone Automation Interface.

See Also
Using the Automation Interface on a 64-Bit System

Installing the Standalone Build on a Build Machine

InstallShield 2020

Edition • Support for multilanguage installations is available with InstallShield Premier Edition only.

InstallShield 2020 User Guide ISP-2600-UG00 1291

Chapter 4
Building, Testing, and Deploying Installations

Installing the Standalone Build

The installation for the Standalone Build consists of a single, compressed executable file. It includes all of the files that are
required for building multilanguage installations.

Task To install the Standalone Build on a build machine:

1. Locate the executable file for the Standalone Build installation:

• If you have the InstallShield DVD, the file is on the DVD and you can find it using the DVD Browser.

• If you downloaded InstallShield, the Standalone Build installation file is available for download as documented
in the InstallShield download and license instructions (http://www.installshield.com/instructions/sab.asp).

2. Double-click the executable file and run the installation. For detailed information on configuring licensing for the
Standalone Build, see the InstallShield download and license instructions (http://www.installshield.com/
instructions/sab.asp).

During the installation, the Custom Setup dialog shows two Standalone Build features that are disabled by default. Enable
these features if you want to be able to use them.

• Automation Interface—This feature installs and registers the files that you need to use the automation interface with
the Standalone Build.

• InstallScript Objects Support—This feature installs and registers the InstallScript Object support files that enable
you to build InstallScript projects that contain InstallScript Objects.

Files that Are Registered During the Standalone Build Installation

When you install the Standalone Build, the installation installs and registers each of the following merge modules if they
are not present:

• ATL 3.0 (ATL.msm)

• Microsoft C Runtime Library (MSVCRT.msm)

• Microsoft C Runtime Library 7.1 (VC_User_CRT71_RTL_X86_---.msm)

• MSXML3 (msxml3_wim32.msm)

• MSXML4 (msxml4sxs32.msm or msxml4sys32.msm)

• Visual C++ 8.0 ATL (x86) WinSXS MSM (Microsoft_VC80_ATL_x86.msm)

• Visual C++ 8.0 ATL.Policy (x86) WinSXS MSM (policy_8_0_Microsoft_VC80_ATL_x86.msm)

• Visual C++ 8.0 CRT (x86) WinSXS MSM (Microsoft_VC80_CRT_x86.msm)

• Visual C++ 8.0 CRT.Policy (x86) WinSXS MSM (policy_8_0_Microsoft_VC80_CRT_x86.msm)

The Standalone Build installation also installs and registers the Microsoft Scripting Runtime Library (scrrun.dll) if it is not
present. It is installed to the [SystemFolder].

If you copy the Standalone Build files from one machine to another instead of running the installation on that second
machine, you must manually install the technologies that are included in these merge modules and the scrrun.dll file if
they are not already present. You can obtain the installation packages for the merge module technologies from the
Microsoft Web site (http://www.microsoft.com).

1292 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Files that Are Registered During the Installation of the Optional Automation Support Feature
The Automation Interface feature in the Standalone Build installation installs and registers the files that you need in order
to use the automation interface with the Standalone Build. Following is the list of files that need to be registered:

• Program Files Folder\Common Files\InstallShield\Shared\IsmAuto.tlb

• Program Files Folder\Common Files\InstallShield\Shared\Ismmupdater.tlb

• Program Files Folder\Common Files\InstallShield\Shared\ISWIBuild.tlb

• Program Files Folder\Common Files\InstallShield\Shared\IsAppServices.tlb

• Program Files Folder\Common Files\InstallShield\Shared\IsUpgrade.tlb

• Standalone Build Program Files Folder\System\ISWiAutomationAutomation Interface Version.dll

If you copy the Standalone Build files from one machine to another instead of running the installation on that second
machine, and if you want to be able to use the automation interface with the Standalone Build, you must manually register
these files.

Files that Are Registered During the Installation of the Optional InstallScript Objects Support Feature
The InstallScript Objects Support feature installs and registers the InstallScript Object support files that enable you to build
InstallScript projects that contain InstallScript Objects. Following is the list of files that need to be registered:

• Standalone Build Program Files Folder\System\DObjAutomation Interface Version.dll

• Standalone Build Program Files Folder\System\ISBE.dll

• Standalone Build Program Files Folder\System\ISMKAutomation Interface Version.dll

• Standalone Build Program Files Folder\System\StockWiz.dll

If you copy the Standalone Build files from one machine to another instead of running the installation on that second
machine, and if you want to be able to build InstallScript projects that contain InstallScript Objects, you must manually
register these files.

Manually Registering Files for the Standalone Build

To manually register one of the aforementioned DLL files for the Standalone Build, use Regsvr32.exe, which is installed in
the System32 folder.

To manually register one of the .tlb files, use the following file:

Standalone Build Program Files Folder\System\RegTypLib.exe

See Also
Adding Redistributables to the Build Machine for the Standalone Build
Installing the Standalone Build and InstallShield on the Same Machine
Using the Automation Interface on a 64-Bit System

InstallShield 2020 User Guide ISP-2600-UG00 1293

Chapter 4
Building, Testing, and Deploying Installations

Adding Redistributables to the Build Machine for the Standalone Build

InstallShield 2020

Most of the redistributables—including merge modules, objects, and InstallShield prerequisites—are not installed
automatically with the Standalone Build because they would require significantly more hard disk space. This allows you to
install on the build machine only the redistributables that are required by your InstallShield projects. The only one that is
included is the .NET Framework 2.0 redistributable.

Tip • The Standalone Build uses the same basic directory structure that InstallShield uses for its program files. Therefore, if
you need to copy a redistributable or some other file from a machine that has InstallShield to a machine that has the
Standalone Build, use the same relative path. For example, if a file is in the InstallShield Program Files
Folder\Modules\i386 directory on the machine that has InstallShield, copy that file to the Standalone Build Program
Files Folder\Modules\i386 directory on the machine that has the Standalone Build.

Task To add a .NET redistributable to your build machine:

1. Locate the required redistributables on the machine that has the full version of InstallShield. The file is typically
located in InstallShield Program Files Folder\Redist or a subfolder of the Redist folder. If an InstallShield
redistributable is not available on your machine, you must download it first. For more information, see
Redistributable Downloader Wizard.

2. Copy the redistributable from the machine that has InstallShield to the Standalone Build Program Files Folder on the
build machine.

Task To add a redistributable for Basic MSI or InstallScript MSI projects to your build machine:

1. Locate the required redistributables on the machine that has the full version of InstallShield. If an InstallShield
redistributable is not available on your machine, you must download it first. For more information, see Downloading
Redistributables to Your Computer.

• The two default locations for InstallShield merge modules are:

InstallShield Program Files Folder\Modules\i386

Common Files\Merge Modules

• The default location for the InstallShield objects is:

InstallShield Program Files Folder\Objects

• All InstallShield prerequisites are stored in the following location:

InstallShield Program Files Folder\SetupPrerequisites

• If you built your own merge modules in InstallShield, you would find them in any of the locations that are listed
on the Merge Modules tab of the Options dialog box.

2. Copy the redistributable from the machine that has InstallShield to appropriate location on the build machine.

• Add merge modules to the following folder:

Standalone Build Program Files Folder\Modules\i386

1294 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• Add objects to the following folder:

Standalone Build Program Files Folder\Objects

• Add InstallShield prerequisites to the following folder:

Standalone Build Program Files Folder\SetupPrerequisites

Task To add an InstallShield prerequisite for InstallScript projects to your build machine:

1. Locate the required InstallShield prerequisite on the machine that has the full version of InstallShield. If an
InstallShield redistributable is not available on your machine, you must download it first. For more information, see
Downloading Redistributables to Your Computer.

All InstallShield prerequisites are stored in the following location:

InstallShield Program Files Folder\SetupPrerequisites

2. Copy the InstallShield prerequisite from the machine that has InstallShield to appropriate location on the build
machine:

Standalone Build Program Files Folder\SetupPrerequisites

Task To add to your build machine one of the other InstallShield redistributables for InstallScript projects:

1. Download the installation for the redistributable. The installations are available through FlexNet Connect. For more
information, see Obtaining Updates for InstallShield.

2. Run the redistributable installation on the build machine. When the InstallShield Wizard displays the Choose
Destination Location dialog, browse to the following location:

Standalone Build Program Files Folder\ObjectsPro

If the ObjectsPro folder has not been created yet, you will need to add that folder.

The InstallScript object installations install and register the required object files.

Task To add to your build machine one of your own InstallScript redistributables or a third-party redistributable:

1. Locate the redistributable.

2. Place it in the following location on the build machine:

Standalone Build Program Files Folder\ObjectsPro

If the ObjectsPro folder has not been created yet, you will need to add that folder.

See Also
Specifying the Directories that Contain InstallShield Prerequisites
Specifying the Directories that Contain Merge Modules
Installing the Standalone Build on a Build Machine

InstallShield 2020 User Guide ISP-2600-UG00 1295

Chapter 4
Building, Testing, and Deploying Installations

Standalone Command-Line Build

InstallShield 2020

The Standalone Build lets you use ISCmdBld.exe to build releases from the command line. For instructions, see Building a
Release from the Command Line.

For a list of command-line parameters that ISCmdBld.exe supports, see ISCmdBld.exe.

See Also
Specifying the Directories that Contain InstallShield Prerequisites
Specifying the Directories that Contain Merge Modules

Standalone Automation Interface

InstallShield 2020

The Standalone Build includes a standalone version of the automation interface—the InstallShield Standalone Automation
Interface. This interface uses the same ISWiAutomationAutomation Interface Version.dll file that is installed with
InstallShield, but it is installed to a different location.

Note • If you install the Standalone Build on the same machine as InstallShield, the first ISWiAutomationAutomation
Interface Version.dll file that is installed is the one that is registered. To learn more, see Installing the Standalone Build
and InstallShield on the Same Machine.

Future versions of the Standalone Build will have new ProgIDs and new GUIDs. This enables you to install multiple versions
of the Standalone Automation Interface side by side on the same build machine.

Registering ISWiAutomationAutomation Interface Version.dll

The Standalone Automation Interface is contained in the file ISWiAutomationAutomation Interface Version.dll. If you
installed the Standalone Build by running the installation for the Standalone Build, this file is already registered. If you
copied the files for the Standalone Build instead of running the installation, you need to register this file manually using
Regsvr32.exe, which is installed in the System32 folder. The ISWiAutomationAutomation Interface Version.dll file is
installed in the System subfolder of the Standalone Build Program Files folder.

See Also
Automation Interface
Automating Installation Development and Build Processes
Using the Automation Interface on a 64-Bit System

Installing the Standalone Build and InstallShield on the Same Machine

InstallShield 2020

In most cases, the Standalone Build is not installed on the same machine where InstallShield is installed. If you do install
both on the same machine, you need to be aware that the Standalone Automation Interface uses the same
ISWiAutomationAutomation Interface Version.dll file that InstallShield uses, but it is installed to a different location.
In addition, both the Standalone Automation Interface and InstallShield use the same ProgID: IswiAutoAutomation
Interface Version.ISWiProject. This enables you to use the same automation script with both the Standalone
Automation Interface and InstallShield, without requiring you to change your code to reflect the appropriate ProgID.

1296 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

When you first install either InstallShield or the Standalone Build, the installation registers ISWiAutomationAutomation
Interface Version.dll. If you next install the other tool, that second installation detects that
ISWiAutomationAutomation Interface Version.dll is already registered, so it does not re-register it. As long as one
instance of ISWiAutomationAutomation Interface Version.dll is registered, you can use both the Standalone Build and
InstallShield with the automation interface.

If you uninstall the first instance that you originally installed, the installation unregisters ISWiAutomationAutomation
Interface Version.dll. Therefore, you must manually register ISWiAutomationAutomation Interface Version.dll so
that you can use the automation interface with the product that still remains. For example, if you install InstallShield,
install the Standalone Build, and then uninstall InstallShield, you must next manually register the
ISWiAutomationAutomation Interface Version.dll file for the Standalone Build; otherwise, you cannot use the
Standalone Automation Interface.

To manually register ISWiAutomationAutomation Interface Version.dll, use Regsvr32.exe, which is installed in the
System32 folder. The ISWiAutomationAutomation Interface Version.dll file is installed in the System subfolder of the
InstallShield and Standalone Build Program Files folders.

See Also
Installing the Standalone Build on a Build Machine

Microsoft Build Engine (MSBuild)

InstallShield 2020

InstallShield supports the Microsoft Build engine (MSBuild) included with the .NET Framework. MSBuild support enables
you to build Visual Studio solutions with InstallShield projects in build lab environments where Visual Studio is not
installed.

Overview
MSBuild is an extensible build framework designed to remove the build dependence on Visual Studio. The .NET Framework
functions in a role similar to the InstallShield Standalone Build, providing the capability to build projects or solutions from
the command line or any other host of MSBuild. For more information on MSBuild, see the MSDN Library.

MSBuild Tasks
The flexibility and extensibility of MSBuild is controlled through atomic groupings of internal build steps referred to as
tasks. One example of a task that ships with MSBuild is Csc, which can compile code from a Visual C# project. InstallShield
installs an MSBuild task called InstallShield, which builds an InstallShield project, and a targets file that provides default
build steps for the project. This customized task, along with the targets file, enables MSBuild to perform all required
actions to build the InstallShield project as part of a Visual Studio solution.

InstallShield 2020 User Guide ISP-2600-UG00 1297

Chapter 4
Building, Testing, and Deploying Installations

This table describes the parameters of the InstallShield task. The Project Type column lists the applicable project types

Table 4-6 • MSBuild InstallShield Task

Parameter Type Project Type Description

InstallShieldPath String Basic MSI, This parameter specifies the path to folder containing
InstallScript, the InstallShield application.
InstallScript
MSI, Merge
Module

Project String Basic MSI, This parameter specifies the location of the project file
InstallScript, (.ism).
InstallScript
MSI, Merge
Module

ProductConfiguration String Basic MSI, This parameter specifies the product configuration for
InstallScript the release.
MSI, Merge
Module

ReleaseConfiguration String Basic MSI, This parameter specifies the release name.
InstallScript,
InstallScript
MSI, Merge Note • You must specify the ReleaseConfiguration or
Module the PatchConfiguration. If you do not specify one of
these, or if you specify both of these, a build error occurs.

PatchConfiguration String Basic MSI, This parameter specifies the name of the patch
InstallScript configuration in the Patch Design view that is being
MSI built.

Note • You must specify the ReleaseConfiguration or

the PatchConfiguration. If you do not specify one of
these, or if you specify both of these, a build error occurs.

OutDir String Basic MSI, This parameter specifies the fully qualified path to the
InstallScript, folder where you want the output folders and files to
InstallScript be placed.
MSI, Merge
Module

1298 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-6 • MSBuild InstallShield Task

Parameter Type Project Type Description

MergeModulePath String[ ] Basic MSI, This parameter specifies one or more folders that
InstallScript, contain the merge modules (.msm files) that are
InstallScript referenced by your project.
MSI
InstallShield provides additional ways for specifying
the folders that contain merge modules. For more
information, see Specifying the Directories that
Contain Merge Modules.

PrerequisitePath String[ ] Basic MSI, This parameter specifies one or more semicolon-
InstallScript, delimited folders that contain the InstallShield
InstallScript prerequisite files (.prq files) that are referenced by
MSI your project.

InstallShield provides additional ways for specifying

the folders that contain InstallShield prerequisite files.
For more information, see Specifying the Directories
that Contain InstallShield Prerequisites.

ReleaseFlags String[ ] Basic MSI, This parameter enables you to specify any release flags
InstallScript that you want to include in your release. Separate
MSI multiple flags with commas.

PathVariables ITaskItem[ ] Basic MSI, This parameter enables you to override the path
InstallScript, variables for the project. Using this parameter, you can
InstallScript specify the path to the path variable and also define a
MSI, Merge value for the name of the path variable using the
Module PathVariable subelement.

To reference a file in a sibling project that is within the

same Visual Studio solution folder, use the predefined
path variable called VSSolutionFolder. For more
information, see Using the VSSolutionFolder Path
Variable with Visual Studio Solutions.

For more information on MSBuild ITaskItem[ ]

properties, see the MSDN Library.

PreprocessorDefines ITaskItem[ ] Basic MSI, This parameter enables you to add or override the
InstallScript, preprocessor defines for the project. Using this
InstallScript parameter, you can specify the definition of the
MSI preprocessor define and also define a value for the
name of the preprocessor define using the Token
subelement.

For more information on MSBuild ITaskItem[ ]

properties, see the MSDN Library.

InstallShield 2020 User Guide ISP-2600-UG00 1299

Chapter 4
Building, Testing, and Deploying Installations

Table 4-6 • MSBuild InstallShield Task

Parameter Type Project Type Description

OutputGroups ITaskItem[ ] Basic MSI, This parameter specifies the project output groups
InstallScript, from the Visual Studio solution. Using this parameter,
InstallScript you can specify the path to the source location of the
MSI, Merge project output group and also define these additional
Module values using these subelements as listed:

• Name—Name of the project

• OutputGroup—Name of the project output group

• TargetPath—Target path of the project output

group (different from its source location)

For more information on MSBuild ITaskItem[ ]

properties, see the MSDN Library.

1300 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-6 • MSBuild InstallShield Task

Parameter Type Project Type Description

Build String Basic MSI, This parameter specifies what type of build to perform.
InstallScript, You can choose from these types of builds:
InstallScript
• Complete—This option builds the entire release.
MSI, Merge
Module • Compile—This option compiles the Setup.rul
script file. In Basic MSI and Merge Module
projects, this option also streams ISSetup.dll
into the Binary table of the .msi package.

• Tables—This option builds only the Windows

Installer tables for the database. If you have not
built this installation already, a new .msi file is
created, but no files are added to your
installation. If you have built your installation
already, the .msi file is updated when all the
tables are built, but, again no files are transferred.
Ideally, this option is to be used to test the user
interface of your installation. This option is
applicable to Basic MSI, InstallScript MSI, Merge
Module projects.

• TablesAndFiles—For Basic MSI, InstallScript MSI,

and Merge Module projects, this option builds the
Windows Installer tables and refreshes the files.
This type of build can be run only after a complete
build has been performed, and it works only when
the media is an uncompressed network image.

For InstallScript projects, this option rebuilds only

those portions of the release that have changed
since the last build. If this parameter is not used,
the entire file media library is rebuilt.

• UpgradeOnly—This option enables you to

upgrade—but not build—a Basic MSI project that
was created in an earlier version of InstallShield.

BuildCompressed Boolean Basic MSI, This parameter specifies whether your release is
InstallScript compressed into one file or remains uncompressed in
MSI, Merge multiple files.
Module

InstallShield 2020 User Guide ISP-2600-UG00 1301

Chapter 4
Building, Testing, and Deploying Installations

Table 4-6 • MSBuild InstallShield Task

Parameter Type Project Type Description

BuildSetupExe Boolean Basic MSI, For Basic MSI and InstallScript MSI projects, this
InstallScript parameter specifies whether you want to create a
MSI, Merge Setup.exe file along with your installation.
Module
For merge module projects, this option specifies
whether you want to build the merge module and also
copy it to the merge modules folder, or just build the
.merge module without copying it.

ProductVersion String Basic MSI, This parameter specifies the product version. This is
InstallScript especially helpful if you want to increment the build
MSI, Merge version (the third field) of the product version.
Module
For information on valid product version numbers, see
Specifying the Product Version.

PropertyOverrides ITaskItem[ ] Basic MSI, This parameter enables you to override the value of a
InstallScript Windows Installer property or create the property if it
MSI, Merge does not exist. To use this parameter, include a
Module property list of items whose value is the new property
value, and whose metadata Property is the name of
the property.

This parameter is exposed as the

InstallShieldPropertyOverrides ItemGroup
passthrough to the PropertyOverrides property on the
InstallShield task.

RunMsiValidator ITaskItem[ ] Basic MSI, This parameter enables you to specify one or more
InstallScript .cub files to use for validating the installation package
MSI, Merge or merge module after it is built.
Module
To learn more about validation, see Validating
Projects.

RunUpgradeValidation Boolean Basic MSI, This parameter specifies whether or not to run
InstallScript upgrade validation.
MSI

StopOnFirstError Boolean Basic MSI, This parameter specifies whether or not to stop the
InstallScript build after an initial error.
MSI, Merge
Module

MsiVersion String Basic MSI, This parameter specifies the minimum version of
InstallScript Windows Installer that the installation can accept on
MSI, Merge the target machine.
Module

1302 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-6 • MSBuild InstallShield Task

Parameter Type Project Type Description

DotNetFrameworkVersion String Basic MSI, This parameter specifies the minimum version of the
InstallScript .NET Framework that the installation can accept on
MSI the target machine.

DotNetUtilPath String Basic MSI, Regasm.exe and InstallUtilLib.dll are utilities that
InstallScript are included with each version of the .NET Framework.
MSI This parameter specifies the path for the directory that
contains the 32-bit version of these files that you want
to use at build time for releases that include .NET
installer classes and COM interop. This is not the path
to .NET Framework redistributable files.

Note • If you are using InstallShield on a 64-bit system,

ISCmdBld.exe determines the location of the
corresponding 64-bit version of the .NET Framework
based on the path that you specify for this parameter,
and ISCmdBld.exe uses the 64-bit location of
Regasm.exe and InstallUtilLib.dll when
appropriate.

Disk1Folder Output Basic MSI, This parameter specifies the location of the output
String InstallScript, folder.
InstallScript
MSI, Merge
Module

SummaryInfoComments String Basic MSI, Use this parameter to set Summary Information
InstallScript, Stream comments at build time, such as including the
InstallScript build number.
MSI, Merge
The comments that are added using this property can
Module
be viewed on the Properties dialog box of the built
installer.

MSIPackageFileName String Basic MSI, Use this parameter to specify the MSI package file
InstallScript name at build time. Specify the file name—without the
MSI period or the file extension—that InstallShield should
use for the .msi file.

InstallShield 2020 User Guide ISP-2600-UG00 1303

Chapter 4
Building, Testing, and Deploying Installations

Table 4-6 • MSBuild InstallShield Task

Parameter Type Project Type Description

InstallShieldDigitalCertifica String Advanced UI, This parameter specifies the digital certificate
tePassword Basic MSI, password, this is an optional parameter. If it is not
InstallScript, specified, the password configured in the project is
InstallScript used to sign the files.
MSI,
InstallScript
Object, Merge
Module, Suite/
Advanced UI

MSBuild Scripts
MSBuild natively understands one file format: its XML build script, which is used as the project file format for Visual C# and
Visual Basic .NET projects (.csproj and .vbproj). MSBuild also has internal hooks to handle solution files and the Visual C++
project file format (.sln and .vcproj).

The InstallShield integration with Visual Studio uses an MSBuild-compatible XML format project file (.isproj), which enables
MSBuild to seamlessly build Visual Studio solutions that include InstallShield projects. To build solutions in a standalone
environment, install the InstallShield Standalone Build on the build machine.

Customizing the .isproj File

To incorporate changes for your InstallShield project into your .isproj file, add a PropertyGroup element or an ItemGroup
element near the top of your .isproj file, or update an existing PropertyGroup or ItemGroup element. Then add
InstallShield-related parameters as needed.

The following sample code from an .isproj file demonstrates how to do the following:

• Set the product version.

• Set the product name.

• Set a custom public property called MY_PROPERTY to the value My Value.

• Override a path variable called MyPathVariableName with a new value of C:\MyPath.

• Specify the following search paths for InstallShield prerequisites: <ISProductFolder>\SetupPrerequisites and
<ISProjectFolder>\MyCustomPrerequisites.

<PropertyGroup>
<InstallShieldProductVersion>1.2.3</InstallShieldProductVersion>
</PropertyGroup>
<ItemGroup>
<InstallShieldPropertyOverrides Include="My New Product">
<Property>ProductName</Property>
</InstallShieldPropertyOverrides>
<InstallShieldPropertyOverrides Include="My Value">
<Property>MY_PROPERTY</Property>
</InstallShieldPropertyOverrides>
<InstallShieldPathVariableOverrides Include="C:\MyPath">
<PathVariable>MyPathVariableName</PathVariable>

1304 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

</InstallShieldPathVariableOverrides>
<InstallShieldPrerequisitePath Include="&lt;ISProductFolder&gt;\SetupPrerequisites"/>
<InstallShieldPrerequisitePath Include="&lt;ISProjectFolder&gt;\MyCustomPrerequisites"/>
</ItemGroup>

See Also
Using MSBuild to Build a Release from the Command Line

Using MSBuild to Build a Release from the Command Line

InstallShield 2020

Note • If you use MSBuild to build Visual Studio solutions with InstallShield projects, MSBuild requires .NET Framework 3.5 or
later.

MSBuild provides an easy way to build a release from the command line on a machine on which Visual Studio is not
installed. The only components you must have installed on the machine are the .NET Framework and the InstallShield
Standalone Build. Place a copy of your Visual Studio solution on the machine, and run MSBuild.

Task To use MSBuild from the command line:

1. Open the Command Prompt window.

2. Change the directory to the one that contains MSBuild.exe:

C:\Windows\Microsoft.NET\Framework\Version Folder\

3. Type the command-line statement to build the release build of the Visual Studio integration project. For example:

MSBuild.exe C:\Folder Containing My Visual Studio Solution\My Solution.sln /

property:Configuration=Release

See Also
Microsoft Build Engine (MSBuild)

Configuring Release Settings

InstallShield 2020

When you create a release, it has default settings. You can edit all of the release settings in the Releases view. When you use
the Release Wizard, you can also edit the settings of a release.

Task To edit the settings of a release:

1. In the View List under Media, click Releases.

2. In the Releases explorer, select the release whose settings you would like to configure. The settings are displayed on
tabs in the right pane.

3. Select a setting on one of the tabs to modify its value. Information about the setting is displayed in the help pane or
when you press F1 from within the Releases view.

InstallShield 2020 User Guide ISP-2600-UG00 1305

Chapter 4
Building, Testing, and Deploying Installations

See Also
Releases View

Creating a Single Executable File for Distribution

InstallShield 2020

Project • This information applies to InstallScript projects.

To package a build as a single executable file, use the Create a single file executable option in the General Options panel
of the Release Wizard, or the Singe Exe File Name setting in the Releases view, as described in the following procedures.

Note • The single executable file that you create accepts any command-line parameter that Setup.exe accepts.

Task To package a build as a single executable file by using the Release Wizard:

1. Launch the Release Wizard.

2. Navigate to the General Options panel.

3. Select the Create a single file executable check box.

4. By default, the file name <project name>.exe is entered in the File Name box. If you want the self-extracting
executable file to have a different name, type a new file name in the box or select a path variable whose value defines
the file name.

5. In the Icon box, you can specify the fully qualified name of the file that contains the icon that InstallShield should use
when it creates the Setup.exe file at build time.

To specify a file, type an explicit path or path variable, or click the browse button to open the Change Icon dialog box,
in which you can click the Browse button to select a file.

By default, the icon with index 0 is used; to specify a different icon, either select an icon in the Change Icon dialog box
or append the icon’s index or resource ID (preceded by a minus sign) to the file name. For example,
C:\Temp\MyLibrary.dll,2 indicates the icon with an index of 2, and C:\Temp\MyLibrary.dll,-100 indicates the icon
with a resource ID of 100.

6. If you want the executable file to extract the installation files to the target machine and not run the installation, enter
-extract_all:<path> in the Setup Command Line box, where <path> is the desired target folder; for example:

-extract_all:"C:/ProductName Setup Files"

7. Complete the Release Wizard; in the Summary panel, select the Build the Release check box and then click the
Finish button.

Task To package a build as a single executable file by using the settings in the Releases view:

1. In the View List under Media, click Releases.

2. In the Releases explorer, select the release that you want to package as a single executable file.

1306 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

3. Select the Setup.exe tab.

4. For the Single .exe File Name setting, type a file name or a path variable (enclosed in angle brackets—for example,
<MY EXE FILE NAME>) whose value defines the file name.

5. In the Setup.exe Icon File setting, specify the fully qualified name of the file that contains the icon that InstallShield
should use when it creates the Setup.exe file at build time.

To specify a file, type an explicit path or path variable, or click the ellipsis button (...) to open the Change Icon dialog
box, in which you can click the Browse button to select a file.

By default, the icon with index 0 is used; to specify a different icon, either select an icon in the Change Icon dialog box
or append the icon’s index or resource ID (preceded by a minus sign) to the file name. For example,
C:\Temp\MyLibrary.dll,2 indicates the icon with an index of 2, and C:\Temp\MyLibrary.dll,-100 indicates the icon
with a resource ID of 100.

6. If you want the executable file to extract the installation files to the target machine and not run the installation, enter
the following for the Setup Command Line setting:

-extract_all:<path>

where <path> is the desired target folder; for example:

-extract_all:"C:/ProductName Setup Files"

7. Build the release.

To learn how to digitally signing your executable file, see Digital Signing and Security. For information about requiring end
users to enter a password in order to launch the self-extracting executable file, see Password-Protecting Installations.

See Also
Setup.exe and Update.exe Command-Line Parameters
Using Path Variables

Leaving Files Uncompressed in a Disk Image

InstallShield 2020

Project • This information applies to InstallScript projects.

Task To place some or all features’ files uncompressed in the disk image, use the Media Layout panel in the Release Wizard:

1. Launch the Release Wizard and navigate to the Media Layout panel.

2. Do either of the following:

• To place all features’ files uncompressed in the disk image: Select the CDROM Folder(s) option. All features’ files
are placed in the disk image in the folders specified by the features’ CD-ROM Folder properties. If no folder is
specified for a feature, that feature’s files are placed in the root of the disk image.

• To place some features’ files uncompressed in the disk image:

a. Select the Custom option, and then click Next. The Custom Media Layout panel opens.

InstallShield 2020 User Guide ISP-2600-UG00 1307

Chapter 4
Building, Testing, and Deploying Installations

b. In the Features in cabinets box, select or clear the check boxes next to the features. If a feature’s files are
stored in cabinet files, clear the check box. If a feature’s files should be placed in the disk image in the folder
specified by the feature’s CD-ROM Folder property, select the check box. If no folder is specified, that
feature’s files are placed in the root of the disk image.

Tip • If you want most of your features stored in cabinet files, click Clear All and then select the features to be placed
uncompressed in the disk image. Conversely, if you want most of your features placed uncompressed in the disk image,
click Select All and then clear the check boxes for the features to be stored in cabinet files.

3. Complete the Release Wizard.

Note • Regardless of whether you selected Yes or No for the Compressed setting of a feature’s component, by selecting the
uncompressed (CD-ROM folder) option for the feature, its files will be uncompressed on the distribution media.

Specifying the Required Execution Level for Your Setup Launcher on Windows Vista and Later
Platforms
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• Suite/Advanced UI

InstallShield lets you specify the minimum execution level required by your installation’s Setup.exe file for running the
installation (the setup launcher, any InstallShield prerequisites, the .msi file, and any Advanced UI or Suite/Advanced UI
packages) on Windows Vista and later platforms. You can configure this for each individual release in your project.

Task To specify the required execution level for a release:

1. In the View List under Media, click Releases.

2. In the Releases explorer, click the release that you would like to configure.

3. Click the Setup.exe tab.

4. For the Required Execution Level setting, select the appropriate option.

The available options are:

• Administrator—Setup.exe requires administrative privileges to run. Administrators must provide consent, and non-
administrators must provide credentials.

1308 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• Highest available—Setup.exe prefers administrative privileges. Administrators must provide consent to run it; non-
administrators run it without administrative privileges. This is the default option for InstallScript and InstallScript MSI
projects.

• Invoker—Setup.exe does not require administrative privileges, and all users can run it without administrative
privileges. Setup.exe does not display any UAC messages prompting for credentials or for consent. This is the default
option for Advanced UI, Basic MSI, and Suite/Advanced UI projects.

For Advanced UI, InstallScript, InstallScript MSI, and Suite/Advanced UI projects, and for Basic MSI projects if the Setup
Launcher setting is set to Yes, InstallShield embeds a Windows application manifest in the Setup.exe launcher as a
resource. This manifest specifies the selected execution level. Operating systems earlier than Windows Vista ignore the
required execution level. The execution level is defined in the manifest as follows:

<requestedExecutionLevel
level="asInvoker"
uiAccess="false"/>

Other valid values for the level attribute are highestAvailable and requireAdministrator.

If the Setup Launcher setting is set to No for a Basic MSI project, InstallShield does not embed the Windows application
manifest in the Setup.exe launcher.

The benefit of elevating the required execution level in Basic MSI projects is that privileges can be elevated only once if
necessary to run Setup.exe, and that these privileges can be carried over to all of the installation’s InstallShield
prerequisites and the Execute sequence of the .msi package without requiring multiple prompts for approval. Thus, if two
of your InstallShield prerequisites require administrative privileges, for example, you can change this setting to
Administrator, and then end users are prompted only once during the installation, before Windows Installer runs the
Setup.exe file.

A similar benefit exists for Advanced UI and Suite/Advanced UI projects, where privileges can be elevated only once if
necessary to run Setup.exe, and that these privileges can be carried over to all of the installation’s Advanced UI or Suite/
Advanced UI packages without requiring multiple prompts for approval.

Note, however, that if you elevate the privileges and also launch the application at the end of the installation, the elevated
privileges are carried over to the application. In most cases, running an application with elevated privileges on Windows
Vista and later platforms is discouraged.

Important • InstallShield runs with elevated privileges. If you launch your installation from within InstallShield, those
elevated privileges are carried over to your installation; thus, your installation automatically has elevated privileges. That
may not reflect the behavior that end users will see if they are using Windows Vista or later. Therefore, if you are using
Windows Vista or later on your development system, consider opening the release folder and launching the installation
directly (instead of from within InstallShield).

To quickly access your release folder so that you can launch your release directly, click the Open Release Folder on the
Standard toolbar, or on the Tools menu, click Open Release Folder.

Note that an end user’s installation experience is more secure when installations are run with only the permissions that
they need. Unless an application is designed to be run only by system administrators, it should be run with the least
privilege.

See Also
Working with InstallShield Prerequisites that Are Included in Installation Projects
Minimizing the Number of User Account Control Prompts During Installation

InstallShield 2020 User Guide ISP-2600-UG00 1309

Chapter 4
Building, Testing, and Deploying Installations

Specifying Whether a Product Should Be Advertised If Its InstallShield Prerequisites Are Run
with Elevated Privileges
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

Depending on how it is configured, an installation that includes InstallShield prerequisites may display a User Account
Control (UAC) prompt for elevated privileges on Windows Vista and later systems at several different points during the
installation:

1. When the end user launches the Setup.exe file

2. When the Setup.exe file launches a setup prerequisite that requires elevated privileges

3. When the Setup.exe file launches a feature prerequisite that requires elevated privileges

4. When the Windows Installer begins the Execute sequence of the .msi package

If you select Administrator for your installation’s Required Execution Level setting in the Releases view, Windows Vista and
later typically display only one UAC prompt; it is displayed when the end user launches the Setup.exe file. However, if you
select Invoker for this setting, Windows Vista and later may display more than one UAC prompt during the installation. For
example, Windows Vista and later may display a UAC prompt for a setup prerequisite that requires elevated privileges and
another UAC prompt for the Execute sequence of the .msi package. If this scenario applies to your installation, you may
want to specify that your installation should advertise and then run your .msi package to help end users avoid the UAC
prompt for the .msi package. If this scenario does not apply to you, it is recommended that you avoid advertising the .msi
package because it would not avoid a UAC prompt.

Tip • The Require Administrative Privileges setting in the General Information view is where you specify whether the .msi
package requires administrative privileges. The Behavior tab in the InstallShield Prerequisite Editor is where you specify
whether a prerequisite requires administrative privileges. For more information about other InstallShield settings that may
affect whether Windows Vista and later displays UAC prompts, see Minimizing the Number of User Account Control Prompts
During Installation.

Task To specify whether your .msi package should be advertised:

1. In the View List under Media, click Releases.

2. In the Releases explorer, click the release that you would like to configure.

3. Click the Setup.exe tab.

4. For the Advertise If Prerequisites Are Elevated setting, select the appropriate option.

The available options are:

• Advertise: Silent—Indicates that if setup prerequisites in the installation are successfully installed with elevated
privileges, the .msi package should be advertised and run silently (without a user interface). Then the Execute
sequence of the main installation does not require an additional UAC prompt for consent or credentials.

1310 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• Advertise: Full UI—Indicates that if setup prerequisites in the installation are successfully installed with elevated
privileges, the .msi package should be advertised and run with a full user interface. Then the Execute sequence of the
main installation does not require an additional UAC prompt.

• No—Indicates that the .msi package should not be advertised. When end users run the installation, one or more UAC
prompts may be displayed to install the setup prerequisites. If the Execute sequence of the .msi package also requires
elevation, an additional UAC prompt may be displayed before the Windows Installer begins the Execute sequence.

Important • The package must support advertisement in order for either of the advertise options to work. Advertisement is
not instantaneous, and it adds extra delays to the installation. In addition, unexpected behavior may occur if the end user
clicks Cancel after advertisement but before the main part of the installation has finished. For example, advertised shortcuts
for your product may appear on the desktop before the main installation begins, and a confused user canceling the main
installation may leave your package advertised but not fully installed. Therefore, in some cases, it may be better to leave this
setting as No to allow the extra UAC prompt and avoid product advertisement.

A common goal is for an installation to display only one UAC prompt. The advertise options for the Advertise If
Prerequisites Are Elevated setting facilitate this but do not guarantee it in all situations. For example, any time that an
installation causes a restart, the installation process returns to limited privileges after the restart. The subsequent privilege
elevation may display an additional UAC prompt, whether the elevation is required for a setup prerequisite, for a feature
prerequisite, or for the .msi package. When the restart comes between the last prerequisite and the .msi package, the .msi
package is not advertised. Following are some examples of different outcomes that may occur when you select one of the
advertise options for this setting:

• The prerequisites require elevation and install successfully on the target machine. The product is advertised and
installed. The product installation does not display a UAC prompt.

• One of the prerequisites in the installation may require a restart. After the restart for the prerequisite occurs, either no
additional prerequisites are installed or none of the other prerequisites that are installed require elevation. Since the
last prerequisite that is installed in this scenario is not a simple success of an elevated prerequisite, advertisement of
the .msi package does not occur.

• None of the prerequisites in the installation need to be installed because they are already present on the target
machine; therefore, advertisement of the .msi package does not occur.

• None of the prerequisites in the installation require elevation; therefore, advertisement of the .msi package does not
occur.

• Elevated prerequisites are successfully installed. However, for this situation, the package is a minor upgrade for a
product that is already installed. That is, the product code in the package matches the product code of the product
that is already present on the target machine. Advertisement of the .msi package does not occur. UAC prompts may or
may not be displayed; it depends on whether a suitable digital certificate is included in the earlier installation and in
the patch.

See Also
Specifying the Behavior for an InstallShield Prerequisite that Requires a Restart
Setup Prerequisites vs. Feature Prerequisites

InstallShield 2020 User Guide ISP-2600-UG00 1311

Chapter 4
Building, Testing, and Deploying Installations

Password-Protecting Installations
InstallShield 2020

For added security, you can password-protect your installation package. When you password-protect your installation, any
end user who wants to install your package must enter a case-sensitive password to open your installation.

You can activate password protection in the Password & Copyright panel of the Release Wizard.

Specifying the Run-Time Location for InstallShield Prerequisites at the Release Level
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI

InstallShield lets you specify the run-time location of the InstallShield prerequisites that are included with your
installation.

Task To specify where all of the InstallShield prerequisites should be located for a release, do one of the following:

• Use the InstallShield Prerequisites panel of the Release Wizard.

• In the Releases view, select the release. Then on the Setup.exe tab, for the InstallShield Prerequisites Location
setting, select the appropriate option.

Task To specify different locations for each InstallShield prerequisite:

1. In the Redistributables view (in Basic MSI and InstallScript MSI projects) or the Prerequisites view (in InstallScript
projects), specify the appropriate location for each InstallShield prerequisite. For more information, see Specifying a
Run-Time Location for a Specific InstallShield Prerequisite.

2. In the View List under Media, click Releases.

3. Select the release that you want to build.

4. Click the Setup.exe tab.

5. For the InstallShield Prerequisites Location setting, select Follow Individual Selections.

Tip • As an alternative, you can select the Follow Individual Selections option in the InstallShield Prerequisites panel of the
Release Wizard.

Note that if an InstallShield prerequisite is added to a project as a dependency of another prerequisite, the location for the
prerequisite dependency follows the location setting of the prerequisite that requires it.

1312 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

If you build a release that includes InstallShield prerequisites and both of the following are true, one or more build errors
may be generated:

• You specify for the InstallShield prerequisites location that the prerequisites should be extracted from Setup.exe or
copied from the source media (instead of being downloaded from the Web to the end user’s computer).

• The prerequisite files are not on your computer.

To eliminate the build errors, remove the InstallShield prerequisite from your project, download the InstallShield
prerequisite from the Internet to your computer, or change the InstallShield prerequisites location for the release to the
download option; then rebuild the release.

See Also
Release Wizard
Working with InstallShield Prerequisites that Are Included in Installation Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to Basic MSI and InstallScript MSI Projects
Adding InstallShield Prerequisites, Merge Modules, and Objects to InstallScript Projects
Specifying URLs for Downloading InstallShield Prerequisites

Specifying the Run-Time Location for Advanced UI or Suite/Advanced UI Packages at the

Release Level
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

InstallShield lets you specify the run-time location of the packages that are included with your Advanced UI or Suite/
Advanced UI installation.

Tip • If you are configuring an Advanced UI or Suite/Advanced UI project for an update setup launcher, the run-time location
of the packages must be either extracted from the setup launcher or downloaded from the Web. The update setup launcher
cannot rely on packages that are stored on the source media.

For more information, see Supporting Downloadable Updates for an Advanced UI or Suite/Advanced UI Installation.

Task To specify where all of the packages should be located for a release:

1. In the View List under Media, click Releases.

2. Select the release that you want to build.

InstallShield 2020 User Guide ISP-2600-UG00 1313

Chapter 4
Building, Testing, and Deploying Installations

3. Click the Setup.exe tab.

4. In the Package Location setting, select the appropriate option.

Task To specify different locations for each package:

1. In the View List under Organization, click Packages.

2. Specify the appropriate location for each InstallShield prerequisite. For more information, see Specifying a Run-Time
Location for a Specific Package in an Advanced UI or Suite/Advanced UI Project.

3. In the View List under Media, click Releases.

4. Select the release that you want to build.

5. Click the Setup.exe tab.

6. In the Package Location setting, select Follow Individual Selections.

Note that if a package is added to a project as a dependency of another package, the location for the package dependency
follows the location setting of the package that requires it.

If you build a release that includes package and both of the following are true, one or more build errors may be generated:

• You specify for the package location that the packages should be extracted from Setup.exe or copied from the source
media (instead of being downloaded from the Web to the end user’s computer).

• The package files are not on your computer.

To eliminate the build errors, remove the package from your project, add the package to your computer, or change the
package location for the release to the download option; then rebuild the release.

See Also
Guidelines for Adding Packages to an Advanced UI or Suite/Advanced UI Project

Specifying the Uninstallation Order of Packages in a Suite

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition • The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project
type is available in the Premier edition of InstallShield. For information about the differences between these two project types,
see Advanced UI Projects vs. Suite/Advanced UI Projects.

You can specify the uninstallation order of packages in a suite project using the Uninstallation Order property on the
Setup.exe tab of the Releases view.

1314 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Task To specify the uninstallation order of packages in a suite project:

1. In the View List under Media, click Releases.

2. Select the release that you want to build.

3. Click the Setup.exe tab.

4. In the Uninstallation Order setting, select one of the following options:

• Same as Packages Order—Uninstall the packages in the same order that packages were installed (as defined in
the project).

• Reverse of Packages Order—Uninstall the packages in the reverse order that packages were installed (as
defined in the project).

UninstallOrder Method in Automation Interface

You can also use the UninstallOrder method in the automation interface to set the Uninstallation Order property.
Specify one of the following values:

• euoForward(0)—Uninstall the packages in the same order that packages were installed (as defined in the project).

• euoReverse(1)—Uninstall the packages in the reverse order that packages were installed (as defined in the project).

Digital Signing and Security

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• InstallScript Object
• Merge Module
• Suite/Advanced UI

You can digitally sign your installation and your application files to assure end users that neither your installation nor the
code within your application has been tampered with or altered since publication.

The Signing tab is where you specify the digital signature information—including the digital certificate files that a
certification authority grated to you—that InstallShield should use to sign your files.

The Signing tab is also where you specify which files in your installation should be digitally signed by InstallShield at build
time. InstallShield enables you to sign any and all of the following files in a release, depending on what type of project you
are using:

• Windows Installer package (.msi file) for Basic MSI and InstallScript MSI projects

• Merge module package (.msm file) for Merge Module projects

InstallShield 2020 User Guide ISP-2600-UG00 1315

Chapter 4
Building, Testing, and Deploying Installations

• Setup.exe file for Advanced UI, Basic MSI, InstallScript, InstallScript MSI, and Suite/Advanced UI projects

• Media header file for InstallScript projects

• Any files in your release, including your application files

Windows Logo • All executable files (including .exe, .dll, .ocx, .sys, .cpl, .drv, and .scr files) in an installation must be digitally
signed for the Windows logo program.

To learn more about the various settings on the Signing tab, see Signing Tab for a Release.

Certification Authorities
A certification authority is an organization such as VeriSign that issues and manages digital certificates (also known as
digital IDs). The certification authority validates the requester’s identity according to prescribed criteria and issues a digital
certificate. Obtaining a digital certificate requires providing the certificate authority with specific information about your
company and your product.

For a list of certification authorities, see the Windows Root Certificate Program member list on the MSDN Web site.

SHA-1 vs. SHA-256 Certificates

InstallShield enables you to use digital certificates that use the SHA-256 or SHA-1 hashing algorithm for signing your
installations and files at build time.

SHA-256 is favored over SHA-1, which is being deprecated because of the potential for security vulnerabilities. Microsoft
announced that Windows will stop trusting items that were signed and timestamped with SHA-1 certificates after January
1, 2016. In addition, certification authorities—the organizations that issue certificates—are phasing out the creation of
SHA-1 certificates. Thus, it is recommended that you replace any SHA-1 certificates in your InstallShield projects with SHA-
256 certificates. For the latest information and more specific details, check with your certification authority.

If your project is configured to sign with a SHA-256 certificate, InstallShield uses a SHA-256 hash in the signature of the files
that it signs at build time. If your project is configured to sign with a SHA-1 certificate, InstallShield uses a SHA-1 hash. Note
that use of a SHA-1 certificate triggers build warning -7346 to alert you about the SHA-1 usage.

Beginning with InstallShield 2016, support for SHA-256 digital certificates for Windows Installer and InstallScript projects
was enhanced to:

• Give you the ability to specify a digest type

• Allow you to specify a SHA-256 timestamp server in settings.xml

• Handle similarly-named certificates in the Certificate Store

Important • Any new signatures created or timestamped after Jan 1, 2016 must be SHA-256-based signatures. Any files
signed with an SHA-1 certificate need to have a timestamp showing a date and time prior to Jan 1, 2016 in order to continue to
be supported. Those files will still be allowed through the 'Mark-of-the-web" system until Jan 14, 2020, when all SHA-1 support
will stop in all current versions of Windows.

1316 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Using Certificate Files or Certificates in Certificate Stores to Generate a Digital

Signature
When you are specifying the digital signature information that you want to use for signing your files and installations,
InstallShield lets you choose between the following options:

• You can specify the .pfx certificate file on your machine that you want to use.

• You can reference a certificate store that contains the certificate that you want to use.

Option 1—.pfx File

You can use a personal information exchange file (.pfx) to digitally sign your installation and your application. The
following tools enable you to create a .pfx file from a .pvk file and .spc file:

• PVK2PFX.exe—This is part of the Windows Platform SDK, and it is also included with Microsoft Visual Studio 2005.

• pvkimprt.exe—You can download this PVK Digital Certificate Files Importer tool from the downloads area on the
Microsoft Web site (http://www.microsoft.com/downloads/details.aspx?FamilyID=F9992C94-B129-46BC-B240-
414BDFF679A7&displaylang=EN).

The .pfx file is typically associated with a password.

Option 2—A Certificate in a Certificate Store

If you store your digital certificate in a certificate store, you can reference in your project the certificate store that contains
the certificate that you want to use. If you use this method for signing, you will need to specify information such as the
store name (Personal, Trusted Root Certification Authorities, Enterprise Trust, Intermediate Certification Authorities), the
store location (user or machine), and the subject that identifies the specific certificate that you want to use.

If you configure your project to use a certificate that was imported with password protection into a store, Windows
prompts for the password at build time when InstallShield is attempting to sign your project’s files. The strong key
protection that Windows uses does not permit InstallShield to provide the password to the cryptographic provider.

Adding a Timestamp to Digital Signatures

When you specify digital signature information for a release, InstallShield timestamps the digital signature at build time by
default. A digital certificate’s timestamp indicates the day and time when a file was signed; it also helps to prove that the
certificate was not expired at the moment of signing. A timestamp from a trusted timestamp server typically extends the
life of the digital signature beyond the certificate’s validity period, protecting against certificate expiration.

To learn how to change the default timestamp server that InstallShield uses, or for information on how to disable
timestamping, see Changing the Timestamp Server for Digital Signatures.

See Also
Changing the Timestamp Server for Digital Signatures

Digitally Signing a Release and Its Files at Build Time

InstallShield 2020

InstallShield lets you configure digital signing settings for a release. At build time, InstallShield uses the settings that you
have configured to sign your installation package, your Setup.exe file, and any other files in your release that meet the
criteria that you have defined.

InstallShield 2020 User Guide ISP-2600-UG00 1317

Chapter 4
Building, Testing, and Deploying Installations

Task To configure digital signing for your release and its files:

1. In the View List under Media, click Releases.

2. In the Releases explorer, click the release that you want to sign.

3. Click the Signing tab.

4. Configure the following settings as appropriate:

• Certificate URL

• Digital Certificate File—Click the ellipsis button (...) in this setting. The Certificate Selection dialog box opens,
enabling you to specify either the location of the .pfx file or information about the certificate store that contains
the certificate.

• Certificate Password—Note that if you configure your project to use a certificate that was imported with
password protection into a store, Windows prompts for the password at build time when InstallShield is
attempting to sign your project’s files. The strong key protection that Windows uses does not permit InstallShield
to provide the password to the cryptographic provider.

• Signature Description

5. In the Sign Output Files setting, specify which files (Setup.exe, the .msi package, both of those files, or neither of
those files) you want to be signed.

6. In the Sign Files in Package setting, specify whether you want to sign additional files in your installation.

If you select Yes, use the other settings under the Sign Files in Package setting to indicate which files and file patterns
should be signed and which should not be signed.

Note that the files and file patterns that should not be signed override any files and file patterns that should be signed.
For example, if you specify *.exe in an Include setting and in an Exclude setting, InstallShield does not sign any .exe
files.

Tip • For detailed information about any of the settings on the Signing tab, see Signing Tab for a Release.

At build time, InstallShield signs the files as specified on the Signing tab. If the release is for an installation that includes
merge modules, note that the files are signed before the merge module is merged.

See Also
Certificate Selection Dialog Box
Signing a Patch Package
Signing a QuickPatch Package
Working with Releases
Changing the Timestamp Server for Digital Signatures

1318 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Digitally Signing a Release After It Has Been Built From the Command Line
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript Object

As an alternative to having InstallShield sign your application at build time, you can use the iSign application (iSign.exe)
to digitally sign a release of an InstallScript project from the command line after you have built the release.

iSign.exe is in the following directory:

InstallShield Program Files Folder\System

For syntax and available command-line parameters for iSign.exe, see iSign.exe.

Release Flags
InstallShield 2020

Project • The following project types include support for release flags:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

When you build your release, you can include and exclude features, InstallShield prerequisites, and chained .msi packages
depending on the type of release. For example, if you are creating a trial version of your product and do not want to include
all the features in the build, you can flag features and then specify those flagged features under the product configuration
or the release.

Task To filter features, InstallShield prerequisites, and chained .msi packages based on release flags:

1. Assign release flags to the features, InstallShield prerequisites, and chained .msi packages.

For detailed information on how, see Assigning Release Flags to Features, Assigning Release Flags to InstallShield
Prerequisites, or Assigning Release Flags to a Chained .msi Package.

2. Specify which flags to include in the release if appropriate.

The scenario of a trial version versus a full version is a good example of why you might use release flags. The table below
gives an example of four different features that may be available in a product, depending on which version the end user
receives.

InstallShield 2020 User Guide ISP-2600-UG00 1319

Chapter 4
Building, Testing, and Deploying Installations

In this example, the full version comes with the application’s executable file, help files, a spellchecker, and an add-on pack
that is included as a chained .msi package. The trial version does not include the add-on pack, but it does include an
upgrade pack. Rather than having to create two separate installation projects for what is essentially one product, you can
flag those features that are specific to certain versions. For example, the add-on feature is flagged as Full and the upgrade
feature as Trial.

Table 4-7 • Sample Release Flags

Feature, InstallShield Prerequisite, or

Chained .msi Package Version Release Flag

Windows Installer 4.5 Redistributable All Versions Not applicable

(InstallShield prerequisite)

Program_Executable (feature) All Versions Not applicable

Help_Files (feature) All Versions Not applicable

Spellchecker (feature) Full Version Full

Add_Ons (chained .msi package) Full Version Full

Upgrade_Pack (feature) Trial Version Trial

If you build your release through the Release Wizard, you are given the option of including any flagged features, flagged
InstallShield prerequisites, and flagged chained .msi packages into your release. By default, the release contains all
features, InstallShield prerequisites, and chained .msi packages. If you specify the release flag Full in the Filtering Settings
panel of the Release Wizard, only the Spellchecker feature and the Add_Ons chained .msi package—along with all features
and InstallShield prerequisites without release flags—are built into your release. The upgrade pack is not included in the
installation.

Tip • By default, all features, InstallShield prerequisites, and chained .msi packages are included in a release. When you
specify a release flag in either the Releases view or the Release Wizard, only the unflagged features, the unflagged
InstallShield prerequisites, the unflagged chained .msi packages, the features that contain the specified flag, the InstallShield
prerequisites that contain the specified flag, and the chained .msi packages that contain the specified flag are included in your
installation. InstallShield does not include in the release any features, InstallShield prerequisites, or chained .msi packages
that have a release flag that you did not include in the Releases view or Release Wizard.

See Also
Conditionally Launching Custom Actions Based on Release Flags

Product Configuration Flags vs. Release Flags

InstallShield 2020

Project • The following project types include support for product configuration flags and release flags:

• Basic MSI

1320 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• InstallScript MSI
• Suite/Advanced UI

You can specify which flags to include in your installation both on the release, known as release flags, and on the product
configuration, known as product configuration flags. Although release flags are exposed both as a setting of the release and
in the Release Wizard’s Filtering Settings panel, you can edit the product configuration flags only on the General tab of the
product configuration in the Releases view.

Product configuration flags complement release flags. That is, any feature flags that you specify for the product are
combined with the flags on the individual release that you are building, and all of the features, InstallShield prerequisites,
and chained .msi packages with the specified flags are built into the release. Be careful when specifying flags in the Release
Wizard, because you cannot see which flags are included at the product configuration level.

To demonstrate how product configuration and release flags interact, consider a project with the following features,
InstallShield prerequisites, and chained .msi packages.

Table 4-8 • Sample Features, InstallShield Prerequisites, and Chained .msi Packages

Feature, InstallShield Prerequisite, or

Chained .msi Package Version Release Flag

Windows Installer 4.5 Redistributable All Versions Not applicable

(InstallShield prerequisite)

Program_Executable (feature) All Versions Not applicable

Help_Files (feature) All Versions Not applicable

Spellchecker (feature) Full Version Full

Add_Ons (chained .msi package) Full Version Full

Upgrade_Pack (feature) Trial Version Trial

The following table explains which features, InstallShield prerequisites, and chained .msi packages are included in your
installation based on the combination of product configuration flags and release flags:

Table 4-9 • Combining Product Configuration Flags and Release Flags

Features, InstallShield Prerequisites, and

Product Configuration Flags Release Flags Chained .msi Packages in Installation

<None> <None> Windows Installer 4.5 Redistributable,

Program_Executable, Help_Files, Spellchecker,
Add_Ons, Upgrade_Pack

<None> Full Windows Installer 4.5 Redistributable,

Program_Executable, Help_Files, Spellchecker,
Add_Ons

Trial <None> Windows Installer 4.5 Redistributable,

Program_Executable, Help_Files, Upgrade_Pack

InstallShield 2020 User Guide ISP-2600-UG00 1321

Chapter 4
Building, Testing, and Deploying Installations

Table 4-9 • Combining Product Configuration Flags and Release Flags (cont.)

Features, InstallShield Prerequisites, and

Product Configuration Flags Release Flags Chained .msi Packages in Installation

Full Trial Windows Installer 4.5 Redistributable,

Program_Executable, Help_Files, Spellchecker,
Add_Ons, Upgrade_Pack

See Also
Conditionally Launching Custom Actions Based on Release Flags
Using Release Flags with Features
Assigning Release Flags to InstallShield Prerequisites
Assigning Release Flags to a Chained .msi Package

Filtering Based on Release Flags

InstallShield 2020

Project • The following project types include support for product configuration flags and release flags:

• Basic MSI
• InstallScript MSI
• Suite/Advanced UI

Once you have assigned release flags to your features and InstallShield prerequisites, you can create a release that
includes the ones that are based on those flags. By default, all features, InstallShield prerequisites, and chained .msi
packages are included in a release. Once you specify a flag in either the Releases view or the Release Wizard, only the
unflagged features, the unflagged InstallShield prerequisites, the unflagged chained .msi packages, the features that
contain the specified flag, the InstallShield prerequisites that contain the specified flag, and the chained .msi packages that
contain the specified flag are included in your installation. To include only unflagged features, unflagged InstallShield
prerequisites, and unflagged chained .msi packages, specify a flag that does not exist. For example, you might use
NoFlags. This way, only unflagged features, unflagged InstallShield prerequisites, and unflagged chained .msi packages
are built into a release.

It is possible to include a subfeature but not its parent feature. In such a case, the subfeature is built into the release as a
top-level feature, and its parent is excluded from the release.

You can filter features, InstallShield prerequisites, and chained .msi packages in the Release Wizard or in the Releases view.
Both methods are described below.

Filtering in the Release Wizard

The easiest way to create a release is to use the Release Wizard. The Filtering Settings panel of this wizard enables you to
specify which flags you want to include in your release.

Filtering in the Releases View

You can also use the Releases view to specify flags to include. You can include flags both at the product configuration level
and on the release itself. For more information, see Product Configuration Flags vs. Release Flags.

1322 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Task To specify product configuration flags:

1. In the View List under Media, click Releases.

2. In the Releases explorer, click the product configuration that you want to modify. Its settings are displayed on the
General tab in the right pane.

3. For the Product Configuration Flags setting, enter the flags that you would like to include. To include more than one
flag, separate each with a comma.

Task To specify release flags:

1. In the View List under Media, click Releases.

2. In the Releases explorer, click the release that you want to modify. Its settings are displayed on tabs in the right pane.

3. For the Release Flags setting, enter the flags that you would like to include in this release. To include more than one
flag, separate each with a comma.

See Also
Conditionally Launching Custom Actions Based on Release Flags
Using Release Flags with Features
Assigning Release Flags to InstallShield Prerequisites
Assigning Release Flags to a Chained .msi Package

Using One Project to Create Installations for Multiple Product Configurations

InstallShield 2020

Project • This information applies to InstallScript projects.

You may want to release your product with more than one configuration—for example, an evaluation release and a full
release. Within a single project, you can build releases containing different subsets of the project’s features; with a single
installation script using preprocessor directives, you can build releases with different run-time behaviors.

Task To determine a release’s included features at build time:

1. Launch the Release Wizard and navigate to the Features panel.

2. Select the Specify the features to be included below option.

3. In the Features explorer, select the check boxes of the features that you want to include in the product configuration,
and clear the check boxes of the features that you do not want to include.

4. Complete the other panels in the Release Wizard.

InstallShield 2020 User Guide ISP-2600-UG00 1323

Chapter 4
Building, Testing, and Deploying Installations

Task To determine a release’s run-time behavior using preprocessor directives:

1. In your script, use preprocessor directives to execute different code for different product configurations; for example:

#ifdef EVAL_RELEASE
/* Evaluation-specific code */
#elif FULL_RELEASE
/* Full release-specific code */
#endif

2. In the Compiler Preprocessor Defines box (on the General Options panel of the Release Wizard) or the Compiler
Preprocessor Defines setting (on the Build tab in the Releases view), specify the preprocessor constant that
corresponds to the code that you want the release to execute.

3. Build the release.

Typical Web Installation vs. One-Click Install

InstallShield 2020

When downloading an application from the Internet, many end users experience a long and confusing series of instructions
explaining how to download and run the application properly. The typical download can take as many as 10 steps. It can be
a frustrating and time-consuming process that is not always successful. End users who fail to download the application
properly must rely on product support to assist them, or they give up completely and never gain access to the application.
This results in time lost for both the consumer and the development team.

With a One-Click Install setup, however, the end user can download an application with minimum effort and can begin
using the application immediately. Compare the installation processes for both typical and One-Click Install setups below.

Typical Internet Installation Process

A typical Internet installation might happen like this:

1. The end user navigates to the Web page and clicks the link to download the application.

2. A dialog opens. The dialog prompts the end user to agree to a software licensing agreement.

3. The end user is given the opportunity to save the installation’s executable file to disk. The end user must remember
this location to access the installation’s executable file later.

4. The file transfer begins.

5. The end user must search for the installation executable file and then launch it.

6. The installation executable file unpacks and executes.

7. If any other resources are necessary for the proper execution of the application, the end user must download them at
this time.

8. The installation executes and begins to walk the end user through the installation process.

9. The end user makes several choices, such as the disk location of the application executable file.

10. The application file transfer begins.

11. The end user locates the application executable file on disk and launches the application.

1324 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

One-Click Install Installation Process

With a One-Click Install setup, installations are easier and faster for the end user. A One-Click Install setup can happen like
this:

1. The end user navigates to the Web page and clicks the download button.

2. A dialog opens. The dialog shows the progress of the file transfer. Once the installation has been downloaded, the
installation runs.

3. The end user begins using the application.

One-Click Install setups keep the end user on your Web page, instead of searching for an executable file to run. One-
Click Install setups make it possible for the end user to concentrate on using the application, not struggling to download it.

One-Click Install Installations in InstallScript Projects

InstallShield 2020

Project • This information applies to InstallScript projects.

A One-Click Install installation includes a setup player (Setup.ocx) that downloads and then launches the Setup.exe file
with the appropriate command line. This enables end users who are using Windows Vista and later with limited privileges
to run the installation; if elevated privileges are required because of the required execution level specified in the
installation’s manifest, the appropriate User Account Control (UAC) prompt is displayed when the Setup.exe file is
launched. If end users have an earlier version of Windows on their systems, the manifest is ignored, but the other behavior
is the same.

The Setup.exe file for One-Click Install installations does not include any COM information.

Like any other installation, an Internet installation can use features such as updating, maintenance mode, multi-instance
installation, silent installation—in short, any feature that is available for any InstallShield installation.

The following InstallScript functions are Internet-enabled:

Table 4-10 • Internet-Enabled InstallScript Functions

Function Description

CopyFile Copies a file that is specified by a valid URL, or transmits a CGI or ASP request.

ExistsDir Checks the existence of a folder that is specified by a valid URL.

GetFileInfo Gets information about a file that is specified by a valid URL.

GetLine Reads lines from a file that is specified by a valid URL.

InstallShield 2020 User Guide ISP-2600-UG00 1325

Chapter 4
Building, Testing, and Deploying Installations

Table 4-10 • Internet-Enabled InstallScript Functions (cont.)

Function Description

Is Checks the following:

• Whether the installation is being run from the Internet

• The existence of a file or folder that is specified by a valid URL

• Whether a given string is a URL

• The validity of a URL

OpenFile Opens a file that is specified by a valid URL.

ParseUrl Retrieves the parts of the specified URL.

ReadBytes Reads bytes from a file that is specified by a valid URL.

SeekBytes Repositions the file pointer within a file that is specified by a valid URL.

One-Click Install Objects

InstallShield 2020

Project • This information applies to InstallScript projects.

The objects within One-Click Install’s setup player are Player and Ether. The Player object is the highest level of the object
model, followed by Ether.

Player Object
InstallShield 2020

Before you can use the setup player, you must create an instance of it. For more information, see Using the Setup Player.

The Player has one method and one property.

• Open (<URL>)—Specifies the location of the data .cab files and returns a reference to an Ether object. The argument
consists of a URL representing the path to a web server, a UNC path, or the path to the location of the files on your
local drive.

• LastError—Integer value representing an error code thrown by a method, usually Open().

Examples
Player.Open("http://www.mydomain.com/myproduct");
Player.Open("file://\\server\myproduct");
Player.Open("file://c:/my installations/myproduct/media/default");

1326 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

LastError Method

InstallShield 2020

Project • This information applies to InstallScript projects.

This is the LastError method of the Player object. This is an integer value containing the error code for an error thrown by a
method of the Player, usually Open().

Syntax
var nError = player.LastError;

Example
var ether = Player.Open("http://www.installshield.com")

Parameters
None.

Return Values
Table 4-11 • Return Values for the LastError Method

Return Code Description

-2147186688 No permissions were granted. Clicking Deny on the Java Security dialog throws this error.

-2147186686 Failed to update or install the Setup Player ActiveX control. Verify your ability to download from
the URL specified in the Codebase attribute of the APPLET tag.

-2147186685 Failed to instantiate ISPlayer or initialization of the ISPlayer failed.

-2147186684 Failed to call player.Open.

-2147186683 Player.Open call timed out waiting for applet initialization.

-2147166892 Requested URL not found. Verify that your installation files are available at the URL specified
during the player.Open call.

-2147166895 Unable to access protected resource. This error is returned when attempting to access an
installation that requires authentication and the end user does not enter the correct
information.

-2147012889 The server name could not be resolved. Verify that the URL used in your player.Open call.
Misspelling the domain name the URL is a common cause of this error.

Note • For the first six errors listed, the end user can check the Java console for detailed error information.

InstallShield 2020 User Guide ISP-2600-UG00 1327

Chapter 4
Building, Testing, and Deploying Installations

Open Method

InstallShield 2020

Project • This information applies to InstallScript projects.

The Open method of the Player object accepts one string argument that specifies the URL of the installation’s cabinet files.

Syntax
var ether = Player.Open("<URL string>")

Example
var ether = Player.Open("http://www.installshield.com")

Parameters

Table 4-12 • Valid Parameter for the Open Method

Parameter Description

<URL string> Specifies the URL of the installation’s cabinet files.

Return Values
The Open method returns a reference to an Ether object.

Ether Object
InstallShield 2020

The Ether object supports the following methods:

Table 4-13 • Methods Supported by the Ether Object

Method Description

GetLastError Returns a numeric value indicating the result of the installation.

IsPlaying Returns a Boolean value indicating if the installation is running.

Play Starts the installation.

SetProperty Sets a property to a certain value.

1328 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

GetLastError Method

InstallShield 2020

After calling the Ether object’s Play method, call the GetLastError method to find out the result of the installation.
GetLastError tells you if an error occurred, if the installation finished successfully, or if the installation was canceled.

Syntax
ether.GetLastError( );

Example
It is best to poll GetLastError as in the following example:

var intervalID = 0;

function startInstall() {
if (ether)
{
ether.Play();
if (intervalID == 0)
intervalID = window.setInterval("IsSetupFinished()", 3000);
}
}

function IsSetupFinished()
{
var nResult = ether.GetLastError();
if (nResult != 0)
{
if (nResult == SETUP_FINISHED) // setup has completed successfully
/* to do */ ;
if (nResult == SETUP_ERR_CANCELLED) // setup was cancelled
/* to do */ ;

clearInterval(intervalID);
intervalID = 0;
}
}

Parameters
None.

Return Values
A complete list of GetLastError return values is in Disk1\_graphics\Utilities.js under the release’s Disk Images folder,
and is given below.

• SETUP_RUNNING

• SETUP_FINISHED

• SETUP_ERR_GENERAL

• SETUP_ERR_LOADMEDIA

InstallShield 2020 User Guide ISP-2600-UG00 1329

Chapter 4
Building, Testing, and Deploying Installations

• SETUP_ERR_INSTALLKERNEL

• SETUP_ERR_STARTKERNEL

• SETUP_ERR_OPENCAB

• SETUP_ERR_INSTALLSUPPORT

• SETUP_ERR_SETTEXTSUB

• SETUP_ERR_INITINFO

• SETUP_ERR_GETSETUPDRIVER

• SETUP_ERR_INITPROPERTIES

• SETUP_ERR_RUNINSTALL

• SETUP_ERR_UNINSTALLSUPPORT

• SETUP_ERR_EXTRACTBOOT

• SETUP_ERR_DOWNLOADFILE

• SETUP_ERR_CANCELLED

IsPlaying Method

InstallShield 2020

The IsPlaying method of the Ether object returns a Boolean value indicating whether the installation is running.

Syntax
var <variable> = ether.IsPlaying();

Example
var bPlaying = ether.IsPlaying();

Parameters
None.

1330 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Return Values

Table 4-14 • Return Values for the IsPlaying Method

Return Value Description

true Indicates that the installation is running.

false Indicates that the installation is not running.

Play Method

InstallShield 2020

The Play method of the Ether object starts the installation.

To see an example of the use of this method, build a release using the Create a default Web page option in the Release
Wizard’s Internet Options panel or the Release property grid’s Create Default Web Page property, then examine the code in
the generated Web page (Setup.htm).

Syntax
ether.Play();

Parameters
None.

Return Values
None.

SetProperty Method

InstallShield 2020

The SetProperty method of the Ether object accepts two arguments. The first, a string, represents the name of the property
is::CmdLine. The second is a string specifying Setup.exe command-line parameters.

Syntax
ether.SetProperty("is::CmdLine","Setup.exe command-line options");

InstallShield 2020 User Guide ISP-2600-UG00 1331

Chapter 4
Building, Testing, and Deploying Installations

Example
ether.SetProperty("is::CmdLine","-l0x0407");

Parameters
The following table contains the parameters for the SetProperty method.

Table 4-15 • Parameters for the SetProperty Method

Property Name Property Value

is::CmdLine A string specifying Setup.exe command-line parameters. For a list of supported

parameters, see Setup.exe and Update.exe Command-Line Parameters.

Return Values
None.

Digital Signatures for One-Click Install Installations

InstallShield 2020

When an end user runs a One-Click Install installation, the setup player (Setup.ocx) needs to verify the digital signatures
for following files:

• Setup.ocx

• Setup.exe

• Data1.hdr

• ISSetup.dll

If any of those files are unsigned or the signature is corrupted, the setup player displays a single prompt to inform the end
user that the signature could not be verified. If all files are properly signed and your certificate is not yet always trusted, the
setup player displays a prompt to ask the end user to authorize it (similar to the one that is displayed when you run an
executable file that you downloaded).

InstallShield signs the Setup.ocx file for you. The certificate that is used to sign the Setup.exe, the Data1.hdr, and
ISSetup.dll files must match. This happens automatically if you select the options for signing the Setup.exe file and the
media header.

See Also
Digital Signing and Security

Replacing Obsolete Properties and Methods

InstallShield 2020

InstallShield’s simplified model for Internet installations eliminates several methods and properties that the Ether object
and its subobjects had in InstallShield Professional 6.x. The following is a list of those methods and properties, and how to
replace them if you are converting an InstallShield Professional 6.x installation Web page to work with an InstallShield
installation.

1332 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

AskDestPath
To display the equivalent dialog during the installation, call the InstallScript function AskDestPath in your installation
script. To pass a destination path to the installation from the Web page, set a script-defined property.

CommandLine
Replace a line like the following:

ether.CommandLine = "<string value>";

with a line like the following:

ether.SetProperty("is::CmdLine","<string value>");Features, SetState

To offer the equivalent functionality during the installation, call the InstallScript function SdFeatureTree in your
installation script. To pass a feature selection to the installation from the Web page, set a script-defined property; in
addition, in the installation script, use its value to conditionally call FeatureSelectItem.

Features, GetState
To get a feature’s selection state during the installation, call the InstallScript function FeatureIsItemSelected in your
installation script. A Web page cannot get a feature’s selection state.

FileToOpen
To open a file during the installation, call the InstallScript function LaunchApplication in your installation script. To pass a
file name to the installation from the Web page, set a script-defined property.

GetDownloadSize, FileLevelCosting
To get the required disk space during the installation, call the InstallScript function FeatureGetTotalCost in your
installation script. (Feature dialogs such as SdFeatureTree display the required disk space.) A Web page cannot get the
required disk space.

Language
Replace a line like the following:

ether.Language = "<language code>";

with a line like the following:

ether.SetProperty("is::CmdLine","-l<language code>");LegacyMode

By default, Internet installations run in legacy mode—that is, with the installation’s user-interface events generated as
appropriate. There are two ways to duplicate the effect of setting ether.LegacyMode=false; on your Web page:

• Run the installation silently with the following line:

ether.SetProperty("is::CmdLine","-s");

• Set a script-defined property or check the return value of Is(WEB_BASED_SETUP), and conditionally call the
installation’s user-interface event handler functions in the OnShowUI handler.

InstallShield 2020 User Guide ISP-2600-UG00 1333

Chapter 4
Building, Testing, and Deploying Installations

ProductName
A Web page cannot get this information.

GetTargetDir
A Web page cannot get this information.

GetTextSub
A Web page cannot get this information.

IsInstalled
A Web page cannot get this information.

SetSetupType
To specify a setup type during the installation, call the InstallScript function FeatureSetupTypeSet in your installation
script. To display a setup type selection dialog during the installation, call SdSetupType in your installation script. To pass
a setup type to the installation from the Web page, set a script-defined property.

SetTargetDir
To specify a target directory during the installation, assign a value to the system variable TARGETDIR in your installation
script. To pass the target directory to the installation from the Web page, set a script-defined property.

SetTextSub
To specify a text substitution during the installation, assign a value to the TextSub object’s Value property in your
installation script. To pass a text substitution to the installation from the Web page, set a script-defined property.

Default Web Page (Setup.htm)

InstallShield 2020

Project • This information applies to InstallScript projects.

A default Web page called Setup.htm is created in your disk image folder when you build your One-Click Install installation
using one of the following methods:

• Select the Create a default Web page for the setup check box on the Internet Options panel in the Release Wizard.

• Select Yes for the Create Default Web Page setting on the Internet tab in the Releases view.

You can use this page as it is, customize it however you want, or refer to it as an example of using the Setup Player.

Note that the aforementioned Web page creation settings are disabled if the Generate One-Click Install setting in the
Releases view is set to No.

1334 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

for One-Click Install Installations

InstallShield 2020

Project • This information applies to InstallScript projects.

You must have a Web server that supports HTTP 1.1 on the hosting system. Note that FTP does not support One-Click
Install installations.

Alternate Ways to Call the Setup Player

InstallShield 2020

Project • This information applies to InstallScript projects.

It is not necessary to call the Setup Player from a Web page. It is possible to call the Player from other sources such as a
login script or a Visual Basic or Visual C/C++ application. Any programming tool that supports ActiveX controls can call the
Player.

Sample Visual Basic Script for Calling the Player

Dim player, ether
Set player = CreateObject("Setup.Player.Automation Interface Version")
Set ether = player.open("http://www.mydomain.com/mysetup")

If ether.IsPlaying() Then
MsgBox "Setup is running."
Else
MsgBox "Setup is not running."
End If

Set player = Nothing

Set ether = Nothing

HTTPS and One-Click Install Installations

InstallShield 2020

Project • This information applies to InstallScript projects.

Your One-Click Install installation can be run under the secure hypertext transfer protocol (HTTPS)—that is, HTTP using the
Secure Sockets Layer (SLL). The only modification that your installation requires in order to run with HTTPS is to change
http:// to https:// in URLs that are passed to Internet-enabled functions.

InstallShield 2020 User Guide ISP-2600-UG00 1335

Chapter 4
Building, Testing, and Deploying Installations

Creating One-Click Install Installations

InstallShield 2020

You can create a One-Click Install installation using the Release Wizard.

Task To create a One-Click Install installation for an InstallScript project:

1. Launch the Release Wizard.

2. Navigate to the Internet Options panel.

3. Select the Generate One-Click Install option.

4. Select the Create a default Web page for the setup check box or specify the location of a custom Web page in the
Enter the URL to launch box.

5. Specify other options as desired.

6. Complete the rest of the Release Wizard panels.

7. Build your release.

Task To create a One-Click Install installation for a Basic MSI or InstallScript MSI project:

1. Launch the Release Wizard.

2. Navigate to the Media Type panel.

3. In the Media Type list, click Web.

4. Navigate to the One Click Install panel, and select the Generate One-Click Install option.

5. Specify the file name for your .htm or .cab file.

6. Indicate the browsers that you want your One-Click Install installation to support.

7. Complete the rest of the Release Wizard panels.

8. Build your release.

Using the Setup Player

InstallShield 2020

Project • This information applies to InstallScript projects.

The Setup Player is a Setup.ocx file that downloads and then launches the Setup.exe file with the appropriate command
line. The Setup.ocx file also supports launching a setup executable file with a name other than Setup.exe; for this to work
correctly, the [Startup] section of the Setup.ini file should contain the following key:

LauncherName=SetupLauncher

where SetupLauncher is the file name of the alternate setup launcher.

1336 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

For an example of using the Setup Player in a Web page, build a release using the Create a default Web page option in the
Release Wizard’s Internet Options panel or the Create Default Web Page setting on the Internet tab in the Releases view.
Then examine the code in the generated Web page (Setup.htm).

Once an instance of the Player has been created, you may use the methods and properties associated with each of the
objects within the Player to customize your installation.

See Also
One-Click Install Installations in InstallScript Projects

Passing Data to the Launched One-Click Install Installation

InstallShield 2020

To pass data to a launched One-Click Install installation, use the is::CmdLine parameter and the CMDLINE script variable.

See Also
Setup.exe and Update.exe Command-Line Parameters

Running an Internet Installation Silently

InstallShield 2020

To run an Internet installation silently, pass it the desired Setup.exe command-line options by calling the Ether object’s
SetProperty method, as in the following examples:

ether.SetProperty("is::CmdLine","-s -f1\"C:\\My Folder\\Mydir.iss\"");

ether.SetProperty("is::CmdLine","-s -f1\"C:\\My Folder\\Mydir.iss\" -f2\"C:\\My Folder\\Mydir.log\"");

Note the following:

• When running a silent Internet installation, you must specify the -f1 option; there is no valid default location for the
response file in Internet installations.

• When recording or running a silent Internet installation, you must specify a fully qualified absolute path if using the -
f1 or -f2 option; these options do not accept URLs.

• The second argument to SetProperty must use the escape sequences (\\ and \") to specify backslashes and quotation
marks, as in the preceding examples.

See Also
Setup.exe and Update.exe Command-Line Parameters

Setting the Run-Time Language

InstallShield 2020

Project • This information applies to InstallScript projects.

Edition • Multilingual support is available in InstallShield Premier Edition.

InstallShield 2020 User Guide ISP-2600-UG00 1337

Chapter 4
Building, Testing, and Deploying Installations

When you specify a language by using the following method, the One-Click Install installation runs in this language
regardless of the default language specified in InstallShield or the default language of the target system. If you do not use
this method, the One-Click Install installation determines the run-time language in the same way as any other installation.

Task Add set the run-time language:

1. Add support for the language to your project:

a. On the Project menu, click Settings. The Project Settings dialog box opens.

b. Click the Languages tab.

c. Select the check box for that language that your installation should target.

2. Add that language to the release:

a. On the Build menu, click Release Wizard.

b. In the Setup Languages panel, select the appropriate language.

3. On your Web page, before you call the Play method, call the SetProperty method to specify the appropriate language
identifier.

For example, the language ID for English is 0009. To set English as the runtime language use the following code:

ether.SetProperty("is::CmdLine","-l0009");

Running a One-Click Install Installation in Debug Mode

InstallShield 2020

Project • This information applies to InstallScript projects.

To run your One-Click Install installation in debug mode, enter the following code before invoking ether.Play:

ether.SetProperty( "is::CmdLine", "/d")

Authenticating a User from InstallScript

InstallShield 2020

Project • This information applies to InstallScript projects.

If your One-Click Install installation requires authentication after it is started, you can authenticate the user on the fly using
InstallScript. When authentication is required, the Web server returns HTTP error code 401 to your installation, which
generates an InternetError event. Respond to that event by prompting the user for a user name and password in the
OnInternetError event handler.

The easiest way to do so is to use the InternetErrorDlg API in WinInet.dll and return the value IDRETRY from
OnInternetError. This causes the installation to issue the HTTP request for the file again. If users enter incorrect
information, they will be prompted to enter it again.

1338 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Setup.ini
InstallShield 2020

Project • This information applies to InstallScript projects.

Setup.ini is an initialization file that is created during the build process of InstallScript-based projects to control certain
elements of the installation. The build process fills in only certain key names and values in Setup.ini. After the build
process creates Setup.ini, it is placed in the Disk1 folder in <project folder>\Media\<media name>\Disk Images.

If you want to customize Setup.ini further, modify it with a text editor. You can automate this process by using the
Postbuild Options panel of the Release Wizard or the Execute Batch File property in the Releases view to launch a batch file
or executable file that performs the desired modifications. Do not simply overwrite Setup.ini with a modified copy from a
previous media build; doing so could cause your installation to work improperly.

Setup.ini contains two predefined sections:

• [Startup]

• [Mif]

You can add additional sections to Setup.ini to pass information to your setup script. You can then call the GetProfString
and GetProfInt functions to transfer the information from the Setup.ini file to your installation.

Here is an example Setup.ini file:

[Startup]

EnableLangDlg=Y

Product=My Application

ProductGUID=23EAFFCA-361D-11D3-8B0F-00105A9846E9

CompanyName=My Company Name

Skin=Setup.skin

SmallProgress=N

SplashTime=5

CheckMD5=N

CmdLine=/f1Test1.iss

LauncherName=MyInstall.exe

[Mif]

Type=SMS

Filename=Ishield

SerialNo=IS50-32XYZ-12345

Locale=DEU

InstallShield 2020 User Guide ISP-2600-UG00 1339

Chapter 4
Building, Testing, and Deploying Installations

Note • If you need to access the file later (after Disk1 has been removed), you should copy Setup.ini to the support folder
(SUPPORTDIR) at the beginning of the installation.

The [Startup] Section

InstallShield 2020

You can use the following keynames in the [Startup] section of Setup.ini:

• EnableLangDlg

• Product

• ProductGUID

• CompanyName

• Skin

• SmallProgress

• SplashTime

• CheckMD5

• CmdLine

• LauncherName

EnableLangDlg
The EnableLangDlg keyname tells the installation whether to display the Language dialog during installation initialization.
The Language dialog lets your end user decide which available language the installation should run in. You can set this
value in the Setup Languages panel of the Release Wizard or through the Languages Dialog property in the Releases
view.

For more information about the Language dialog, see How an Installation Determines Which Language to Use for the User
Interface.

Product
The Product keyname identifies an application or product name to be displayed at the beginning of the text string in the
startup message dialog box.

ProductGUID
The ProductGUID keyname specifies the installation’s GUID so that Setup.exe has access to this data during initialization.
The media builder automatically enters the correct value in Setup.ini; do not change the value.

CompanyName
The CompanyName keyname specifies the name of the company name.

1340 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Skin
The Skin keyname specifies the name of the skin file that the installation uses to display end-user dialogs. If this keyname is
not in Setup.ini, no skin is used. You can specify a skin in the User Interface panel of the Release Wizard or through the
Specify Skin property in the Releases view.

SmallProgress
The SmallProgress keyname specifies whether the installation initialization dialog is the small box that was shown by
installations created with InstallShield Professional version 6.31 and earlier, or if it is larger and is consistent with the rest
of the end-user dialogs. Set the value to Y to display the small dialog or N to display the larger dialog. (If the installation
displays a security, Save and/or Run Setup, Choose Setup Language, or Qualifying Product(s) Detected dialog, the
installation initialization dialog is larger and is consistent with the rest of the end-user dialogs, regardless of the value of
this key.) You can set this value in the User Interface panel of the Release Wizard or through the Small initialization dialog
property in the Releases view.

If SmallProgress is set to N, the installation initialization dialog (and the Choose Setup Language dialog, if any) are not
displayed until the startup graphic closes. To specify the length of time for which the startup graphic displays, set the
SplashTime value.

SplashTime
The SplashTime keyname specifies the length of time (in seconds) for which the startup graphic is displayed.

CheckMD5
The CheckMD5 keyname tells the installation whether to compare each file’s MD5 hash value to the value stored in the
installation header file during file extraction. You can set this value with the Verify MD5 signature check box in the General
Options - Advanced dialog box.

Tip • MD5 checking can detect corrupted files, which is useful during Internet installations; not doing MD5 checking can make
file transfer proceed faster.

CmdLine
The CmdLine keyname identifies command-line parameters that are to be passed to Setup.exe if none are passed from the
command line.

Note • If you use the /v parameter at the command prompt when launching Setup.exe, any parameters that are specified
for the CmdLine keyname are ignored.

For more information about available command-line parameters, see Setup.exe and Update.exe Command-Line
Parameters.

LauncherName
If you rename Setup.exe, the LauncherName keyname specifies the file’s new name. This keyname is required if another
installation will launch this installation using the DoInstall function.

InstallShield 2020 User Guide ISP-2600-UG00 1341

Chapter 4
Building, Testing, and Deploying Installations

The [Mif] Section

InstallShield 2020

If the [Mif] section is present, the installation will automatically create a installation .mif file in the Temp folder. You can
also create an .mif file by using the -m command-line option for Setup.exe and optionally its -m1 and -m2 options.

These are the keynames under the [Mif] section of Setup.ini:

• Type

• Filename

• SerialNo

• Locale

Type
Set this key to SMS.

Filename
The Filename key is optional. It provides the alternate name for the .mif file to be created. If this key is not included, the
installation tries to use the AppName key under the [Startup] section of Setup.ini as the .mif file name. If the AppName
key is also not present, the installation creates a file with the default name Status.mif.

The file name should not include an extension, since .mif files must have the .mif extension. The file name should not
include a path—it is placed in the Temp folder by default.

SerialNo
The SerialNo key is also optional. If provided, the information from this key is placed in the Serial Number section in the
.mif file. If this key is not present, the installation instead places quotation marks ("").

Locale
The Locale key tells the installation to place the indicated locale in the .mif file. English (ENU) is the default; refer to
Microsoft documentation for a complete listing of locale strings.

The following is an example of a Setup.ini file for an installation that will automatically create an .mif file.

[Startup]

AppName=InstallShield

[Mif]

Type=SMS

Filename=IShield

SerialNo=IS50-32XYZ-12345

Locale=DEU

See Also
Setup.exe and Update.exe Command-Line Parameters

1342 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Cloning Releases
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module

InstallShield enables you to clone or copy a release in the Releases view. This allows you to create a release with all of its
properties populated as they were in the cloned release. This way, if you want to create more than one release with only a
few differences between them, you can clone a release and change only the settings that you need to change.

Task To copy or clone a release:

1. On the View List under Media, click Releases.

2. Right-click the release that you want to copy and click Clone.

A release named Copy of Release x is created. The release copy has all of the same properties as the original release.
Rename the release and modify the release settings that you want to change.

See Also
Working with Releases
Releases View

Creating Windows App Packages

InstallShield 2020

Project • Windows App creation is available in Basic MSI projects.

Important • The Windows 10 Anniversary Update is required for installing and testing a Windows App package (.appx) with
desktop extensions (Desktop Bridge) included. In addition, InstallShield must be installed on a Windows 10 machine or a
machine with the Windows 10 SDK installed in order to: digitally sign the Windows App package, utilize Windows App logo
variants (described in Windows App Logo Considerations, or to build localized Windows App packages.

The Windows App package (.appx/.msix) format is the simple and secure packaging format used to distribute and install
apps on Windows 8.x and 10 and is the only format allowed for Universal Windows Platform apps. Benefits of Windows App
packages include:

• High availability, reliability, and durability, resulting in applications that operate continuously without failure for
extended periods of time

• A smooth installation experience through static builds that require minimal configuration and no customizable UI

• The option to sell or provide the application through the Windows Store

InstallShield 2020 User Guide ISP-2600-UG00 1343

Chapter 4
Building, Testing, and Deploying Installations

• The ability to leverage UWP functionality such as live tiles as well as the ability to utilize UWP APIs

• The only package format with native support on Windows Nano Server

InstallShield supports creating the Windows App package format and its desktop and server extensions and also provides
testing to help you identify items unsuitable for the Windows App package format. When you select a release in the
Releases view, a per-release tab titled Appx/MSIX includes settings to create a Windows App package. Here, various core
settings can be specified that impact the Windows App package build process.

Windows App packages can be localized using the settings in the Display Properties area on the Appx/MSIX tab. The
supported languages used for the Windows App package build match those in the UI Languages settings on the Build tab
of the release, as long as MakePRI.exe (within the Windows 10 SDK) is found on the build machine. If MakePRI.exe cannot
be found on the build machine, InstallShield will only generate a Windows App package in the default language.

The following instructions provide details on how to create a Windows App package.

Task To convert a Basic MSI project to Windows app package (.appx) format:

1. Open the Basic MSI Project that you want to build a Windows App package for as part of building the .msi release.

2. In the Releases explorer, under the product configuration, click the name of the release for which you want to build a
Windows App package.

3. Click the Appx/MSIX tab and in the Build Windows App Package setting, specify Yes.

4. Select the Package Type as Appx or MSIX or Both.

5. Do the following:

• Use the General area on the Appx/MSIX tab to specify core settings that impact the build process such as
choosing whether to include desktop extensions or server extensions.

• Use the Package Identity Overrides area on the Appx/MSIX tab to uniquely identify the package to Windows.

• Use the Display Properties area on the Appx/MSIX tab to identify the package to an end user.

For descriptions of these settings, refer to the Appx/MSIX Tab for a Release topic.

6. To configure tiles created in the Windows App package, open the Shortcuts view and configure settings in the
Windows App Package Tile Overrides area. For descriptions of the Windows App Package Tile Overrides settings,
refer to the Shortcut Settings topic.

7. Build the release.

8. To scan the .msi package for signs of items that are unsuitable for the Windows App package format, run the
InstallShield MSIX/UWP App Suitability Suite. On the Build menu, point to Validation, and then click InstallShield
MSIX/UWP App Suitability Suite. For more information, refer to the InstallShield MSIX/UWP App Suitability Suite
topic.

For information about how to deploy the Windows App package, refer to Deploying Windows App Packages.

1344 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

See Also
Appx/MSIX Tab for a Release
Shortcut Settings
InstallShield MSIX/UWP App Suitability Suite
Deploying Windows App Packages
Types of Condition Checks in Advanced UI and Suite/Advanced UI Projects
Adding a Sideloading Windows App Package (.appx | .msix) to a Suite/Advanced UI Project

Testing and Running Installations

InstallShield 2020

Before distributing your installation, you should test run it to ensure that you discover any issues rather than your
customers. InstallShield enables you to test the end-user dialogs (without copying any files to the target system), run the
entire installation including transferring files.

• Test Running Installations

• Running Installations from the InstallShield Interface

• Running Installations in Silent Mode

• MSI Silent Mode Installations for InstallScript MSI Projects

• Silent Uninstallations from the Command Line (InstallScript MSI Only)

• Running a Suite Installation with Minimum User Interface from the Command Line

Test Running Installations

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module

You can test run an installation to review the end-user dialogs. The test run displays the full user interface, but it does not
copy any files over to the target system or update the registry.

Task To test run a project, do one of the following:

• In the Releases view, right-click a release and click Test Setup.

• Click the Test button on the toolbar.

See Also
Specifying Whether Windows Installer Installations Should Be Logged

InstallShield 2020 User Guide ISP-2600-UG00 1345

Chapter 4
Building, Testing, and Deploying Installations

Running Installations from the InstallShield Interface

InstallShield 2020

After you run the Release Wizard and build a release of your installation, you can run it from within InstallShield.

Task To run any of your built installation packages, do one of the following:

• Click the Run button on the toolbar.

• In the Releases view, right-click a release and click Run Setup.

• On the Build menu, click Run ReleaseName, where ReleaseName is the name of the release that currently has focus in
the Releases view.

InstallShield runs the release that currently has focus in the Releases view.

If you selected the Uninstall before installing check box in the Options dialog box, the previously run release (if any) is
uninstalled before the current release is run. This option is available on the Preferences tab in the Options dialog box.

You cannot specify any command-line parameters when launching your installation from the InstallShield interface. You
must launch your installation from the command line to pass parameters to the Windows Installer. For more information,
see MsiExec.exe Command-Line Parameters.

Running Installations in Silent Mode

InstallShield 2020

Silent installations are installations that run without an end-user interface. If you want your installation to run silently,
InstallShield allows you to create silent installations for Basic MSI, InstallScript MSI, and InstallScript project types.

Basic MSI Silent Installations

To run a Basic MSI installation silently, type the following at the command line:

msiexec /i Product.msi /qn

If your release settings include Setup.exe, you can run the following command:

Setup.exe /s /v"/qn"

Basic MSI installations do not create or read response files. To set installation properties for a Basic MSI project, run a
command line such as:

msiexec /i Product.msi /qn INSTALLDIR=D:\ProductFolder USERNAME="Valued Customer"

InstallScript MSI and InstallScript Silent Installations

For InstallScript MSI and InstallScript projects, you need to record a response file that records the end-user interaction.
This response file is passed to Setup.exe so that the installation can be run. The traditional silent installation works almost
exactly the same as regular installations. It follows the same script logic as the regular installation.

If you need to install an InstallScript MSI installation without using Setup.exe, you can use the MSI silent mode.

1346 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

InstallScript MSI and InstallScript Silent Installations

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

InstallShield Silent allows automated electronic software distribution, also known as silent installation. With InstallShield
Silent, there is no need for end users to monitor the installation and provide input through dialogs. An InstallShield Silent
installation runs on its own, without any end-user intervention.

If there are multiple instances of your application on a machine, and if a silent update installation for your application runs
on that machine, it applies the update to the first instance that it finds, and it does not display the Qualifying Product(s)
Detected dialog.

To launch InstallShield Silent, use the Setup.exe -s command line parameter.

Windows Logo • To comply with Windows logo requirements, a silent installation must create a response file in which the
default installation options are selected.

You can run your installation with the Setup.exe -r parameter to select installation options and automatically record the
InstallShield Silent response file, or you can create your own. To view a real-world example of a response file, refer to the
Setup.iss file located on InstallShield installation’s Disk1. For a description of the response file format, see Creating the
Response File.

If you need to install an InstallScript MSI installation without using Setup.exe, you can use the MSI silent mode.

Task To create a silent installation:

1. Create the installation.

2. Create the response file.

3. Run the silent installation.

4. Check for errors.

Creating a Silent Installation

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

If you want to create an installation that will be run in silent mode, create your installation in a typical manner, and test the
script in the normal (non-silent) manner.

InstallShield 2020 User Guide ISP-2600-UG00 1347

Chapter 4
Building, Testing, and Deploying Installations

You can easily modify your installation script logic to include flow control based on whether your installation is being run in
silent mode. InstallShield provides a system variable called MODE. The MODE variable contains one of the following constants
to identify the installation’s current mode:

• NORMALMODE—Indicates that the installation is running in normal mode.

• RECORDMODE—Indicates that the Setup.exe file is automatically generating a silent installation file (.iss file), which
is a record of the installation input, in the Windows folder.

• SILENTMODE—Indicates that the installation is running in silent mode.

For more information, see MODE.

Tip • All InstallShield built-in and Sd dialogs automatically handle the values stored in the InstallShield Silent response file
(.iss file). If you are creating custom dialogs, you will need to call SilentReadData to handle the dialog’s return values in silent
mode.

After you have created or modified the installation, the next step in creating a silent installation is to create the response
file.

Creating the Response File

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

A normal (non-silent) installation receives the necessary input from end users in the form of responses to dialogs. However,
a silent installation does not prompt the end user for input. A silent installation must get its end-user input from a different
source. That source is the InstallShield Silent response file (.iss file).

A response file contains information similar to that which an end user would enter as responses to dialogs when running a
normal installation. InstallShield Silent reads the necessary input from the response file at run time.

The format of response files resembles that of an .ini file, but response files have .iss extensions. A response file is a plain
text file consisting of sections containing data entries.

There are two ways in which you can create an InstallShield Silent response file: you can run the installation and have
InstallShield record and create the response file for you, or you can write the response file directly.

Recording a Response File

You have the option of letting InstallShield create the response file for you. Simply run your installation with the Setup.exe
-r command-line parameter. InstallShield will record all your installation choices in Setup.iss and place the file in the
Windows folder.

All InstallShield built-in and Sd dialog functions are designed to write values into the Setup.iss file when InstallShield runs
in record mode (Setup -r). If you are creating custom dialogs, you will need to call SdMakeName and SilentWriteData to
add sections and dialog data to the response file when the installation runs in record mode. Refer to the Sd dialogs’ source

1348 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

code in the <InstallShield location>\Include folder for examples of using these functions to write to Setup.iss. Read
the following section for more information about what data to add to Setup.iss when calling SdMakeName and
SilentWriteData.

Manually Creating a Response File

You can also create the response file completely by hand. As mentioned, the Setup.iss file is similar to an .ini file. The
sections of an InstallShield response file must be in the following order:

1. Silent Header Section

2. Application Header Section

3. Dialog Sequence Section

4. Dialog Data Sections (one per dialog)

Section names are contained in square brackets, as in [InstallShield Silent].

Data entries follow their section names and consist of <name=value> pairs, as in the following example:

Dlg0={23EAFFCA-361D-11D3-8B0F-00105A9846E9}-Welcome-0

Task To create the response file:

1. Create a text file named Setup.iss using any text editor.

2. Enter the silent header into Setup.iss.

3. Enter the application header into Setup.iss.

4. Enter the dialog sequence into Setup.iss.

5. Enter the dialog data into Setup.iss.

6. Save and close Setup.iss.

A sample response file is included to help familiarize you with the format.

Response File Silent Header

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

All response files begin with a response file silent header. The response file silent header enables InstallShield to identify
the file as a legitimate InstallShield response file. It also helps to verify that the response file corresponds to an installation
created with the proper version of InstallShield.

The format of the silent header is shown below. Enter the following lines at the beginning of your Setup.iss file:

InstallShield 2020 User Guide ISP-2600-UG00 1349

Chapter 4
Building, Testing, and Deploying Installations

[InstallShield Silent]
Version=v7.00
File=Response File

The Version=v7.00 line indicates the version of the InstallShield Silent response file, not the version of InstallShield. Use
v7.00 in all response files.

When you are creating response files, be sure to use the same version of InstallShield to create the response file that will be
used to run the silent installation.

Response File Application Header

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The response file application header is the second block of information in the response file, immediately following the
response file silent header. The response file application header enables you to identify response files visually. It is not
used by the installation script or by Setup.exe. You can use the application header to identify exactly which installation the
response file is for, since it is often difficult to determine this by looking at the dialog data.

The format of the application header is shown below. The values assigned to Name, Version, and Company are derived
from the values written to the registry in the call to the CreateInstallationInfo function in your installation script. (In an
event-based script, CreateInstallationInfo is called in the default OnMoveData event handler code.) Enter the following
lines into your Setup.iss file below the silent header:

[Application]
Name=<ProductKey from CreateInstallationInfo>
Version=<VersionKey from CreateInstallationInfo>
Company=<CompanyKey from CreateInstallationInfo>

Response File Dialog Sequence

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The third block of information in the response file, after the silent header and the application header, is the response file
dialog sequence. The dialog sequence section lists all dialogs that you would need to use in a normal installation (including
custom dialogs), in the order in which they would appear. The dialogs are listed under the section heading
[<PRODUCT_GUID>-DlgOrder].

The dialog numbering sequence begins at 0. There is no limit to the number of dialogs that you can list.

1350 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

The order and the number of dialogs is significant. When InstallShield Silent runs, if either the number or the order of the
dialogs does not match the order or the number of the dialogs in the non-silent installation, the silent installation fails and
the log file records the failure. Make one entry for each occurrence of a dialog. A given dialog may be listed more than once
if it appears more than once in the installation.

The format for a dialog sequence entry is as follows:

Dlg<#>=<PRODUCT_GUID>-<DialogIdentifier>

The Dlg<#> part consists of the letters Dlg and a sequence number. The first dialog in the installation is Dlg0. Each dialog
after that increments the value of <#> by one.

<DialogIdentifier> is in the form functionname-<#>, where functionname is the name of the function that created the
dialog, and <#> represents the sequential order of that particular dialog in the installation.

For custom dialogs, you can use any unique alphanumeric name for the functionname portion of <DialogIdentifier>. For
example, you could refer to a custom dialog as MyDialog. If the tenth dialog in the installation were the second occurrence
of the custom dialog MyDialog, there would be an entry in the dialog sequence section such as the following:

Dlg9=<PRODUCT_GUID>-MyDialog-1

The <DialogIdentifier> expression is used to identify the dialog data section for the dialog.

Always end the dialog sequence section with a statement that has the following form:

Count=<number of dialogs>

The statement specifies the exact number of dialogs listed in the dialog sequence section. Count every entry. Since dialog
numbering begins with 0, the value of Count will always be 1 greater than the highest <#> value for a dialog sequence.

The example below lists two dialogs, the Welcome dialog and the AskOptions dialog. Enter your dialog sequence list into
Setup.iss as shown in the example below.

[{23EAFFCA-361D-11D3-8B0F-00105A9846E9}-DlgOrder]
Dlg0={23EAFFCA-361D-11D3-8B0F-00105A9846E9}-Welcome-0
Dlg1={23EAFFCA-361D-11D3-8B0F-00105A9846E9}-AskOptions-0
Count=2

Response File Dialog Data

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The last block of information in a response file is the response file dialog data. The response file dialog data is a collection
of sections containing the values returned by each dialog identified in the dialog sequence section. Each dialog has its own
section. The values listed are the same values that the dialog returns in a normal end-user input-driven installation. You
can also create dialog data sections for custom dialogs.

The format for a dialog data section is shown below:

[<PRODUCT_GUID>-<DialogIdentifier>]
Result=value

InstallShield 2020 User Guide ISP-2600-UG00 1351

Chapter 4
Building, Testing, and Deploying Installations

Keyname1=value
Keyname2=value

The [<PRODUCT_GUID>-<DialogIdentifier>] section header identifies the specific dialog and is followed by the dialog data
entry list. <DialogIdentifier> is the same expression used to list the dialog in the dialog sequence section.

Data entry items are in the format keyname=value. The keyname is a name for a value returned by a dialog and recorded in
the response file. All dialogs, including custom dialogs, return a value for the keyname Result, reflecting the button that
was clicked to end or exit the dialog. Many dialogs will also set or return a value in a variable.

For example, in a non-silent installation, the AskDestPath dialog returns the destination location in the svDir parameter.
The line in the script might look like the following:

nResult = AskDestPath( szTitle, szMsg, svDir, 0 );

The corresponding dialog data entry in the Setup.iss file for a silent installation might look like the following:

[{23EAFFCA-361D-11D3-8B0F-00105A9846E9}-AskDestPath-0]
Result=1
szPath=C:\Program Files\InstallShield\2020

In the above example, Result=1 is equivalent to clicking the Next button in the dialog, and szPath=C:\Program
Files\InstallShield\2020 is the value returned in the svDir parameter of AskDestPath.

The name of the variable used in the script is meaningless relative to the Setup.iss file. However, in the Setup.iss dialog
data sections, each built-in and Sd dialog has its own set of keynames that map to its parameters. The keynames are
important and must be exactly as defined for each dialog. Refer to Dialog Data Keynames List, below.

When you use custom dialogs, you must create a dialog data entry for the Result keyname for each dialog, plus entries for
any other values set or returned by the custom dialogs. Use the Dialog Data Keynames List, below, as an indicator of how to
create keyname=value expressions for your custom dialogs. Call GetProfString or GetProfInt to read the dialog data
information for the custom dialog. GetProfString and GetProfInt allow you to specify the .iss file, the section, and the
keyname, and they return the value assigned to that keyname.

Standard Values for the Result Keyname

All dialogs, including custom dialogs, return a keyname value called Result, indicating which button was clicked to end the
dialog. Unless otherwise indicated, the Result standard values are:

• 12 for the Back button

• 1 for the Next or OK button

Recording Component and Subcomponent Selections

Some dialog functions allow the end user to select components and subcomponents. There are three kinds of dialog data
keyname entries used to record component and subcomponent selections in response files: type, count, and <#>
(described below).

Every set of component selections and every set of subcomponent selections has one type keyname entry, one count
keyname entry, and as many <#> keyname entries as are required to document each individual component or
subcomponent selection.

When you are creating keynames to record component selections, precede the type, count, and <#> keyname entries with
the word Component, thus:

Component-typeComponent-countComponent-0

1352 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

When you are creating keynames to record subcomponent selections, precede the type, count, and <#> keyname entries
with the name of the component to which the subcomponents belong, thus:

Program Files-typeProgram Files-countProgram Files-0Program Files-1

To create complete value entries, use the equal sign to attach the values to the keynames. (The types of values assigned to
each kind of keyname are described below.) The following example shows complete value entries for two components,
Program Files and Binary Files, and two subcomponents of Program Files, Executables and Support Elements:

Component-type=string
Component-count=2
Component-0=Program Files
Component-1=Binary Files
Program Files-type=string
Program Files-count=2
Program Files-0=Executables
Program Files-1=Support Elements

The type keyname indicates the data type of the components or subcomponents list. Since InstallShield dialogs currently
use only string lists for components and subcomponents lists, type is always equal to string, as in Component-
type=string. Future versions may use number lists, in which case type could equal number.

Count Keyname Entry

Count is equal to the number of selections for a given component or subcomponent entry. For example, if two components
were selected for installation in the ComponentDialog dialog, the count dialog data entry would be Component-count=2. If
two subcomponents of the Program Files component were selected, there would be a Program Files-count=2 entry.

<#> Keyname Entry

The number portion of the <#> keyname entry is simply a sequential (one-up) number, beginning with 0, that numbers
each recorded component or subcomponent selection. Since numbering begins with 0, the greatest number value will
always be one less than the value of count.

The value assigned to a <#> keyname entry is the selected component’s or subcomponent’s visible name (the string passed
as the second parameter to ComponentAddItem when the components or subcomponents list was built).

For example, assume the ComponentDialog dialog offers end users a component selection of Program Files, Help Files,
Sample Files, and Utilities. If the end user selects Program Files and Help Files, then the dialog data section for that
instance of the ComponentDialog dialog will have two list item entries and will look something like this:

[{23EAFFCA-361D-11D3-8B0F-00105A9846E9}-ComponentDialog-0]
szDir=C:\MYAPP\FILES
Component-type=string
Component-count=2
Component-0=Program Files
Component-1=Help Files
Result=

The following example shows how subcomponent list selections are recorded. The example is for an instance of the
SdComponentMult dialog. The example shows that two components—Program Files and Help Files—were selected. It
also shows that four subcomponents were chosen: Main Files, Aux. Files, Main Help, and Tutorial Files. Main Files and
Aux. Files are subcomponents of Program Files, and Main Help and Tutorial Files subcomponents of Help Files.

[{23EAFFCA-361D-11D3-8B0F-00105A9846E9}-SdComponentMult-0]
Component-type=string
Component-count=2

InstallShield 2020 User Guide ISP-2600-UG00 1353

Chapter 4
Building, Testing, and Deploying Installations

Component-0=Program Files
Component-1=Help Files
Program Files-type=string
Program Files-count=2
Program Files-0=Main Files
Program Files-1=Aux. Files
Help Files-type=string
Help Files-count=2
Help Files-0=Main Help
Help Files-1=Tutorial Files
Result=1

Dialog Data Keynames List

The dialog data keynames for the InstallShield dialogs are listed in the table below. The first column contains the dialog
names. The second column lists the keynames applicable to each dialog. The third column contains descriptions of the
values associated with the keynames.

Table 4-16 • Dialog Data Keynames

Dialog Keyname Description

AskDestPath-<#> Result Standard values

AskDestPath-<#> szPath The path that is set in the edit field

AskOptions-<#> Result Standard values

AskOptions is special because the number of return values can

change based on the script call. You can use a sequence of
keynames of the form Sel-<#>, where <#> is the number of the
selection variable. Numbering begins with 0. The number of Sel-
<#> entries should match the number of variables (check boxes/
radio buttons) in the particular call to AskOptions. Refer to the
following examples:

• Sel-0—Maps to first selection variable in AskOptions.

• Sel-1—Maps to second selection variable in AskOptions.

• Sel-2—Maps to third selection variable in AskOptions.

AskPath-<#> Result Standard values

AskPath-<#> szPath The path entered in the Destination Directory edit field

AskText-<#> Result Standard values

AskText-<#> szText The text from the edit field

AskYesNo-<#> Result 1 = End user clicked the Yes button

0 = End user clicked the No button

ComponentDialog-<#> Result Standard values

1354 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-16 • Dialog Data Keynames (cont.)

Dialog Keyname Description

ComponentDialog-<#> szDir The path entered in the Destination Directory field

ComponentDialog-<#> Component- String (the only value currently allowed)

type

ComponentDialog-<#> Component- The total number of component selections

count

ComponentDialog-<#> Component- The selected item’s number in the list (numbering begins with 0)
<#>

MessageBox-<#> Result 1 = End user clicked the OK button

RebootDialog-<#> Result 0 (Result is always 0.)

RebootDialog-<#> Choice Indicates the final reboot selection made before restarting the
machine. Maps to the radio buttons and has these possible values:

• 602 = “Yes, I want to restart my computer now.”

• 0 = “No, I will restart my computer later.”

SdAskDestPath-<#> Result Standard values

SdAskDestPath-<#> szDir The path entered in the Destination Directory field

SdAskOptions-<#> Result Standard values

SdAskOptions-<#> Component- String (the only value currently allowed)

type

SdAskOptions-<#> Component- The total number of component selections

count

SdAskOptions-<#> Component- The selected item’s number in the list (numbering begins with 0)
<#>

SdAskOptionsList-<#> Result Standard values

SdAskOptionsList-<#> Component- String (the only value currently allowed)

type

SdAskOptionsList-<#> Component- The total number of component selections

count

SdAskOptionsList-<#> Component- The selected item’s number in the list (numbering begins with 0)
<#>

InstallShield 2020 User Guide ISP-2600-UG00 1355

Chapter 4
Building, Testing, and Deploying Installations

Table 4-16 • Dialog Data Keynames (cont.)

Dialog Keyname Description

SdBitmap-<#> Result Standard values

SdComponentDialog-<#> Result Standard values

SdComponentDialog-<#> szDir The path entered in the Destination Directory field

SdComponentDialog-<#> Component- String (the only value currently allowed)

type

SdComponentDialog-<#> Component- The total number of component selections

count

SdComponentDialog-<#> Component- The selected item’s number in the list (numbering begins with 0)
<#>

SdComponentDialog2-<#> Result Standard values

SdComponentDialog2-<#> Component- String (the only value currently allowed)

type,
<subcompone
nt>-type

SdComponentDialog2-<#> Component- The total number of component or subcomponent selections

count,
<subcompone
nt>-count

SdComponentDialog2-<#> Component- The selected item’s number in the list (numbering begins with 0)
<#>,
<subcompone
nt>-<#>

SdComponentDialogAdv-<#> Result Standard values

SdComponentDialogAdv-<#> szDir The path entered in the Destination Directory field

SdComponentDialogAdv-<#> Component- String (the only value currently allowed)

type

SdComponentDialogAdv-<#> Component- The total number of component selections

count

SdComponentDialogAdv-<#> Component- The selected item’s number in the list (numbering begins with 0)
<#>

SdComponentMult-<#> Result Standard values

1356 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-16 • Dialog Data Keynames (cont.)

Dialog Keyname Description

SdComponentMult-<#> Component- String (the only value currently allowed)

type,
<subcompone
nt>-type

SdComponentMult-<#> Component- The total number of component or subcomponent selections

count,
<subcompone
nt>-count

SdComponentMult-<#> Component- The selected item’s number in the list (numbering begins with 0)
number,
<subcompone
nt>-<#>

SdComponentTree-<#> Result Standard values

SdConfirmNewDir-<#> Result 1 = End user clicked the Yes button

0 = End user clicked the No button

SdConfirmRegistration-<#> Result 1 = End user clicked the Yes button

0 = End user clicked the No button

SdDisplayTopics-<#> Result Standard values

SdFinish-<#> Result 1 = Finish

SdFinish-<#> bOpt1 1 = “Yes, I want to view the README file.” is selected

0 = “Yes, I want to view the README file.” is not selected

SdFinish-<#> bOpt2 1 = “Yes, I want to launch [app name]” is selected

0 = “Yes, I want to launch [app name]” is not selected

SdFinishEx Requires special handling.

SdFinishReboot-<#> Result 1 = Finish

SdFinishReboot-<#> BootOption 0 = Do not restart Windows or the machine

2 = Restart Windows

3 = Reboot the machine

SdLicense-<#> Result 12 = End user clicked the Back button

1 = End user clicked the Yes button

InstallShield 2020 User Guide ISP-2600-UG00 1357

Chapter 4
Building, Testing, and Deploying Installations

Table 4-16 • Dialog Data Keynames (cont.)

Dialog Keyname Description

SdOptionsButtons-<#> Result 12 = End user clicked the Back button

Or, when the Next button is clicked:

101 = Option button one (top) is selected

102 = Option button two is selected

103 = Option button three is selected

104 = Option button four is selected

SdRegisterUser-<#> Result Standard values

SdRegisterUser-<#> szName The text entered in the Name field

SdRegisterUser-<#> szCompany The text entered in the Company field

SdRegisterUserEx-<#> Result Standard values

SdRegisterUserEx-<#> szName The text entered in the Name field

SdRegisterUserEx-<#> szCompany The text entered in the Company field

SdRegisterUserEx-<#> szSerial The text entered in the Serial (number) field

SdSelectFolder-<#> Result Standard values

SdSelectFolder-<#> szFolder The folder name entered in the Program Folder field

SdSetupType-<#> Result 12 = End user clicked the Back button

Or, when the Next button is clicked:

301 = Typical radio button is currently selected

302 = Compact radio button is currently selected

303 = Custom radio button is currently selected

SdSetupType-<#> szDir The path entered in the Destination Directory edit field

SdShowDlgEdit1-<#> Result Standard values

SdShowDlgEdit1-<#> szEdit1 The text entered in the svEdit1 field

SdShowDlgEdit2-<#> Result Standard values

SdShowDlgEdit2-<#> szEdit1 The text entered in the svEdit1 field

SdShowDlgEdit2-<#> szEdit2 The text entered in the svEdit2 field

1358 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-16 • Dialog Data Keynames (cont.)

Dialog Keyname Description

SdShowDlgEdit3-<#> Result Standard values

SdShowDlgEdit3-<#> szEdit1 The text entered in the svEdit1 field

SdShowDlgEdit3-<#> szEdit2 The text entered in the svEdit2 field

SdShowDlgEdit3-<#> szEdit3 The text entered in the svEdit3 field

SdShowFileMods-<#> Result Standard values

SdShowFileMods-<#> nSelection The “Choose what you want Setup to do” radio button selection:

101 = Let Setup modify the AUTOEXEC.BAT file.

102 = Save the required changes to AUTOEXEC.NEW file.

103 = Do not make any changes.

SdShowInfoList-<#> Result Standard values

SdStartCopy-<#> Result Standard values

SdWelcome-<#> Result Standard values

SdWelcomeMaint-<#> Result 301 = Indicates that the Modify button was selected when the Next
button was clicked.

302 = Indicates that the Repair button was selected when the Next
button was clicked.

303 = Indicates that the Remove button was selected when the
Next button was clicked.

SelectDir-<#> Result Standard values

SelectDir-<#> szDir The path selected by this dialog

SelectDirEx-<#> Result Standard values

SelectDirEx-<#> szDir The path selected by this dialog

SelectFolder-<#> Result Standard values

SelectFolder-<#> szResultFolder The folder selected by this dialog

InstallShield 2020 User Guide ISP-2600-UG00 1359

Chapter 4
Building, Testing, and Deploying Installations

Table 4-16 • Dialog Data Keynames (cont.)

Dialog Keyname Description

SetupType-<#> Result 12 = End user clicked the Back button

Or, when the Next button is clicked:

301 = Typical radio button is currently selected

302 = Compact radio button is currently selected

303 = Custom radio button is currently selected

SprintfBox-<#> Result 1 = End user clicked the OK button

Welcome-<#> Result Standard values

Special Handling for SdFinishEx

SdFinishEx calls either SdFinish or SdFinishReboot, depending on the value of the system variable BATCH_INSTALL. For
this reason, SdFinishEx cannot be handled by a response file. To create a silent installation for a script that calls
SdFinishEx, use script code such as the following:

if (MODE = NORMALMODE) then

SdFinishEx (szTitle, szMsg1, szMsg2, szOpt1, szOpt2, bvOpt1, bvOpt2);
else
if !BATCH_INSTALL then
/* Set bvOpt1 and bvOpt2 to the values you want them
to have during a silent installation that does not require
rebooting; for example: */
bvOpt1 = FALSE;
bvOpt2 = TRUE;
else
/* When the silent installation requires rebooting,
if you want to reboot immediately call
the System function as follows: */
System (SYS_BOOTMACHINE);
endif;
endif;

See Also
Understanding When an Installation or Uninstallation Restarts the Target System

Sample Response File

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

The following response file is the .iss file for a silent InstallShield installation.

1360 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

[InstallShield Silent]
Version=v7.00
File=Response File

[Application]
Name=InstallShield
Version=10.50.000
Company=My Software Company

[{77AB941D-5876-11D4-A4A2-006067620F66}-DlgOrder]
Dlg0={77AB941D-5876-11D4-A4A2-006067620F66}-SdBitmap-0
Count=8
Dlg1={77AB941D-5876-11D4-A4A2-006067620F66}-Welcome-0
Dlg2={77AB941D-5876-11D4-A4A2-006067620F66}-SdRegisterUser-0
Dlg3={77AB941D-5876-11D4-A4A2-006067620F66}-AskDestPath-0
Dlg4={77AB941D-5876-11D4-A4A2-006067620F66}-SetupType-0
Dlg5={77AB941D-5876-11D4-A4A2-006067620F66}-SelectFolder-0
Dlg6={77AB941D-5876-11D4-A4A2-006067620F66}-SdStartCopy-0
Dlg7={77AB941D-5876-11D4-A4A2-006067620F66}-SdFinish-0

[{77AB941D-5876-11D4-A4A2-006067620F66}-SdBitmap-0]
Result=1

[{77AB941D-5876-11D4-A4A2-006067620F66}-Welcome-0]
Result=1

[{77AB941D-5876-11D4-A4A2-006067620F66}-SdRegisterUser-0]
szName=John Doe
szCompany=My Software Company
Result=1

[{77AB941D-5876-11D4-A4A2-006067620F66}-AskDestPath-0]
szPath=C:\Program Files\Product Name Version
Result=1

[{77AB941D-5876-11D4-A4A2-006067620F66}-SetupType-0]
Result=301
szDir=C:\Program Files\Product Name Version

[{77AB941D-5876-11D4-A4A2-006067620F66}-SelectFolder-0]
szResultFolder=Product Name Version
Result=1

[{77AB941D-5876-11D4-A4A2-006067620F66}-SdStartCopy-0]
Result=1

[{77AB941D-5876-11D4-A4A2-006067620F66}-SdFinish-0]
Result=1
bOpt1=1
bOpt2=0

InstallShield 2020 User Guide ISP-2600-UG00 1361

Chapter 4
Building, Testing, and Deploying Installations

Running the Silent Installation

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

After you have created the installation and the response file, do the following:

1. Add the response file (which is located in your Windows folder by default) to the Disk1 folder under Advanced Files in
the Support Files/Billboards view.

2. Build your release. If you are creating a self-extracting executable file for your installation, enter -s for the Setup
Command Line property in the General Options panel of the Release Wizard or for the Setup Command Line property
in the Releases view.

Now you are ready to run the installation in silent mode using InstallShield Silent. When running an installation in silent
mode, be aware that no messages are displayed. Instead, a log file named Setup.log captures installation information,
including whether the installation was successful. You can review the log file and determine the result of the installation.
(Note that for certain installation initialization errors, the log file may instead be named Setupexe.log and be created in
SUPPORTDIR if the installation is run from the Internet or in SRCDIR otherwise.)

To launch InstallShield Silent, run Setup.exe with the -s option. If you created a self-extracting executable file, simply
launch it; you included the -s option in step 2 above.

InstallShield also provides the -f1 and -f2 switches so that you can specify the name and location of the response file and
the location of the log file. For more information, see Setup.exe and Update.exe Command-Line Parameters.

To verify if a silent installation succeeded, look at the ResultCode value in the [ResponseResult] section of Setup.log.
InstallShield writes an appropriate return value after the ResultCode keyname.

See Also
Adding Files and Folders to the Disk1 Folder

Checking for Errors Using the Setup.log File

InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI

Setup.log is the default name for the silent installation log file—generated when the end user runs Setup.exe with the /s
argument—and it is by default created in the directory containing the response file Setup.iss. You can specify a different
name and location for Setup.log using the /f1 and /f2 switches to Setup.exe.

The Setup.log file contains three sections. The first section, [InstallShield Silent], identifies the version of InstallShield
Silent used in the silent installation. It also identifies the file as a log file.

The second section, [Application], identifies the installed application’s name and version, and the company name.

1362 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

The third section, [ResponseResult], contains the result code indicating whether the silent installation succeeded. An
integer value is assigned to the ResultCode keyname in the [ResponseResult] section. The installation places one of the
following return values in the ResultCode key.

Project • Note that in an InstallScript MSI installation, there is no initialization process for reading or writing response files. As
a result, the only errors that may occur for InstallScript MSI installation are -3 for silent installations and -6 for recording
installations. Thus, the following table shows applicable project types where appropriate.

Table 4-17 • Return Values for the Setup.log File

Result Code Project Type Description

0 InstallScript, Success.
InstallScript MSI

-1 InstallScript General error.

-2 InstallScript Invalid mode.

-3 InstallScript, Required data not found in the Setup.iss file.

InstallScript MSI

-4 InstallScript Not enough memory available.

-5 InstallScript File does not exist.

-6 InstallScript, Cannot write to the response file.

InstallScript MSI

-7 InstallScript Unable to write to the log file.

-8 InstallScript Invalid path to the InstallShield Silent response (.iss) file.

-9 InstallScript Not a valid list type (string or number).

-10 InstallScript Data type is invalid.

-11 InstallScript Unknown error during setup.

-12 InstallScript Dialog boxes are out of order.

-51 InstallScript Cannot create the specified folder.

-52 InstallScript Cannot access the specified file or folder.

-53 InstallScript Invalid option selected.

The Setup.log file for a successful silent installation appears as follows:

InstallShield 2020 User Guide ISP-2600-UG00 1363

Chapter 4
Building, Testing, and Deploying Installations

[Application]
Name=Sample App 3000
Version=1.00.0000
Company=Sample Software Corporation
Lang=0409

[ResponseResult]
ResultCode=0

MSI Silent Mode Installations for InstallScript MSI Projects

InstallShield 2020

Project • This information applies to InstallScript MSI projects.

If you need to silently install an InstallScript MSI project without using Setup.exe, you can use the MSI silent mode.

Launching MSI Silent Installations for InstallScript MSI Projects

The MSI silent installation is launched in the following cases:

• The installation is launched at the command line by typing the following:

msiexec product.msi /qn

• The installation is activated from an advertised shortcut.

• The installation is activated from install-on-demand.

• When the product is removed when an update package is running.

Unlike the traditional silent mode, the MSI silent mode does not follow the regular logic provided through script. It simply
runs through the InstallExecuteSequence table. (To see this table, navigate to the Direct Editor.) As a result, some events
are not called, including the following:

• All UI installation events—OnFirstUIBefore and OnFirstUIAfter

• All Feature events

The OnMsiSilentInstall Event

What the Event Does

In an InstallScript MSI–based installation, InstallShield runs the OnMsiSilentInstall event handler if the product is not
already installed on the target system. This happens if the installation is activated from an advertised shortcut or if the
installation is launched through the following command line:

msiexec product.msi /qn

You need to override the OnMsiSilentInstall event if you want to support the MSI silent installation mode. This allows you to
perform tasks that are normally performed in the OnFirstUIBefore, OnFirstUIAfter, and feature event handlers.

1364 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Overriding the Event

By default, OnMsiSilentInstall displays a message and then aborts the installation. You can override this event handler by
writing your own implementation of the function. The prototype of this function is as follows:

external prototype OnMsiSilentInstall(HWND hInstall);

where hInstall is the handle to the installation.

The simplest thing that you can do is to implement an empty body of this event so that the installation will not abort. For
example:

function OnMsiSilentInstall(hInstall)
begin
//Do nothing and allow installation to continue.
end;

Again, OnMsiSilentInstall will be called on MSI silent installation and on activation of an advertised shortcut. It will not be
called on Install-On-Demand, auto-repair, and uninstall mode.

Detecting the Mode in which a Silent Installation is Running

To detect whether a traditional silent installation is running from InstallShield script, use the following:

if (MODE = SILENTMODE)

To detect whether an MSI silent mode installation (including /q, advertise, auto-repair, uninstall, or install-on-demand) is
running from InstallShield script, check the Windows Installer property ISSETUP_UISEQUENCE_PROCESSED using the
MsiGetProperty Windows Installer API function. If this property is not set, then it is a silent install. (It indicates that the
InstallUISequence is not executed.)

See Also
Windows Installer API Functions

Silent Uninstallations from the Command Line (InstallScript MSI Only)

InstallShield 2020

Project • This information applies to InstallScript MSI projects.

To initiate a silent uninstallation for a product that was installed through an InstallScript MSI installation, use a response
file.

Task To run an uninstallation using a response file:

1. Prepare a response file for the uninstallation (.iss) by running Setup.exe with the /r argument:

Setup.exe /r

2. Type the following at the command line (items in Italics represent data that is specific to your product’s
uninstallation):

Setup.exe /s /f1"FullPath\YourResponseFile.iss"

InstallShield 2020 User Guide ISP-2600-UG00 1365

Chapter 4
Building, Testing, and Deploying Installations

Running a Suite Installation with Minimum User Interface from the

Command Line
InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

You can use a command line parameter to run a suite installation in minimum UI mode, only displaying a progress panel.

To run a suite installation in minimum UI mode, use the /passive parameter in the command line:

Setup.exe /passive

To uninstall using a minimum UI mode, use the following command:

Setup.exe /passive /remove

Validating Projects
InstallShield 2020

Validating a project involves applying a set of internal consistency evaluator (ICE) rules to your installation or merge
module package. The ICEs are designed to help you determine whether the package contains a valid database that
performs its actions correctly. If a package fails one or more ICEs, InstallShield reports the specific ICE rules that were
violated and offers additional information to help you troubleshoot the problem.

Microsoft created many of the ICEs that are available in InstallShield; Revenera created the custom InstallShield ICEs
(ISICEs) that are available for the some of the InstallShield installation and merge module validation suites. The ISICEs help
you validate your package against best practices for Windows-based installations.

Windows Logo • Validating your project may help you identify whether your installation meets installation requirements for
Microsoft’s Windows logo program. Therefore, if you are interested in being able to use the Windows logo, it is recommended
that you use the InstallShield Validation Suite for Windows 8 and the Full MSI Validation Suite to validate your installation
package. If you create a merge module in InstallShield, use the InstallShield Merge Module Validation Suite for Windows 8
and the Merge Module Validation Suite to validate your merge module. For more details, see Requirements for the Windows
Logo Program.

To learn more about the Windows logo program, visit MSDN.

Edition • The Premier Edition of InstallShield includes the following sets of validation suites:

The InstallShield Premier Edition also includes the following sets of validators:

• InstallShield Virtualization Suitability Suite—ISVICEs validators in this suite help you to determine how ready your
products are for virtualization by checking suitability for Microsoft App-V 4.x, Microsoft App-V 5.x, Microsoft Server App-V,
VMware ThinApp, and Citrix XenApp. The validation suites can enable you to make more informed decisions about how
you would build your product if you are considering offering your customers a virtualized version.

1366 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• InstallShield Best Practice Suite—ISBP validators in this suite alert you if your installation violates best-practice
guidelines.
• InstallShield MSIX/UWP App Suitability Suite—ISUWP validators in this suite scan an .msi package for signs of items
that are unsuitable for the Windows App package format and provides a report that indicates applicability to the known
Windows App variants (Universal App, Desktop Bridge, Windows Store, WSA, and Nano Server).

InstallShield also provides an engine for upgrade and patching validation. You can access this through the Upgrade
Validation Wizard.

See Also
ICEs
ISICEs
InstallShield Best Practice Suite
InstallShield Virtualization Suitability Suite
InstallShield MSIX/UWP App Suitability Suite
Validating Upgrades, Patches, and QuickPatch Packages
Upgrade Validation Wizard

Validating an Installation Package or Merge Module

InstallShield 2020

There are two ways to validate an installation package or a merge module from within InstallShield:

• You can configure InstallShield to validate the installation package or merge module every time that you build a
release. This is disabled by default. For more information, see Specifying Whether Validation Should Be Performed at
Build Time.

If you perform validation at build time, you can specify multiple validation suites.

• You can run validation on demand for a built release. To learn how, see Validating an Installation Package or Merge
Module on Demand.

If you perform validation on demand, you can specify only one validation suite at a time.

Tip • As an alternative, you can validate the installation package or merge module after you build it from the command line
by using ISCmdBld.exe. For more information, see ISCmdBld.exe.

Project • The only way to validate a package for an MSI Database project or an MSM Database project is to perform validation
on demand.

Note • If you want to see validation warnings that apply to your installation or merge module, you must perform validation
on demand; this type of validation message is not available if you perform validation at build time. InstallShield reports the
other types of validation messages—errors and failures—during both validation methods. To learn more about the different
types of validation messages, see Viewing Validation Results.

See Also
Requirements for the Windows Logo Program

InstallShield 2020 User Guide ISP-2600-UG00 1367

Chapter 4
Building, Testing, and Deploying Installations

Specifying Whether Validation Should Be Performed at Build Time

InstallShield 2020

InstallShield enables you to specify whether installation packages and merge modules should be validated each time that
a release is successfully built. InstallShield also lets you specify one or more validation suites that should be used for
validation.

Task To configure validation settings:

1. On the Tools menu, click Options. The Options dialog box opens.

2. Click the Validation tab.

3. Select the check boxes for the types of validation that you would like InstallShield to perform at build time. If you
prefer to validate on demand, and not at build time, clear the check boxes.

4. If you select the Perform validation using check box or the Perform Merge Module validation using check box,
select one or more types of validation that should be performed.

To add a new or custom validator (.cub file), click the Browse button and select it.

Note • If you want to see validation warnings that apply to your installation or merge module, you must perform validation
on demand; this type of validation message is not available if you perform validation at build time. InstallShield reports the
other types of validation messages—errors and failures—during both validation methods.

See Also
Validating an Installation Package or Merge Module on Demand
Requirements for the Windows Logo Program

Specifying Which ICEs, ISICEs, ISVICEs and ISBPs Should Be Run During
Validation
InstallShield 2020

InstallShield lets you customize the list of ICEs, ISICEs, ISVICEs, ISUWPs, and ISBPs that should be used for installation
package validation and merge module validation.

Task To specify which ICEs, ISICEs, ISVICEs, ISUWPs, and ISBPs should be run during validation:

1. On the Tools menu, click Options. The Options dialog box opens.

2. Click the Validation tab.

3. Click the Customize button. The Customize Validation Settings dialog box opens.

4. In the Select CUB file to customize list, click the suite that you want to customize.

5. In the list of ICEs, select the check box for each of the validators that should be used to evaluate the installation
package or merge module. Clear the check box for each of the validators that should not be used for the validation.

1368 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

To configure multiple consecutive validators, select the first file, press and hold SHIFT, and select the last file. Then
either select or clear the check box of one of the selected validators.

6. Click OK.

If you customize the list of ICEs, ISICEs, ISVICEs, ISUWPs, and ISBPs for a validation suite, anytime that validation is
performed—whether it occurs at build time or on demand—only the selected ICEs, ISICEs, ISVICEs, ISUWPs, and ISBPs are
used.

See Also
Requirements for the Windows Logo Program

Validating an Installation Package or Merge Module on Demand

InstallShield 2020

InstallShield enables you to validate an installation package or merge module separately from the build process. Doing so
is especially helpful if you configured InstallShield so that validation is not performed as part of every successful build, but
you do need to run it at some point to test your product for Windows logo compliance or for best-practice compliance.

Task To validate your release on demand:

1. Complete a successful build of a release.

2. On the Build menu, point to Validate, and then click the validation type that you want to run.

See Also
Requirements for the Windows Logo Program

Viewing Validation Results

InstallShield 2020

InstallShield displays the results of the validation scan on the Validations tab of the Output window. In addition,
InstallShield saves the results to an XML document in a ValidationFiles folder within the release folder. You can view this
file either by navigating to your build directory, or by navigating to the Releases view and selecting the Validations folder
under your release.

Validation Messages
Validation messages are broken down into three categories:

• Errors—Describe problems with your database, such as having duplicate component GUIDs.

• Warnings—Describe problems in your database that may occur in certain circumstances.

• Failures—Occur when your database has severe enough problems that the validation tool might not be able to run.

If the scan results for your project include validation messages, the messages and associated codes are also listed on the
Tasks tab of the Output window.

InstallShield 2020 User Guide ISP-2600-UG00 1369

Chapter 4
Building, Testing, and Deploying Installations

Note • If you want to see validation warnings that apply to your installation or merge module, you must perform validation
on demand; this type of validation message is not available if you perform validation at build time. InstallShield reports the
other types of validation messages—errors and failures—during both validation methods. To learn more about these two
validation methods, see Validating an Installation Package or Merge Module.

Tip • You can click a validation code on the Tasks tab of the Output window to see the corresponding Knowledge Base article
or HelpNet topic.

In addition, you can click a validation message on the Tasks tab to jump to the area of the Direct Editor that corresponds to the
validation message. This functionality is available for: ICEs, ISICEs, ISVICEs, ISUWPs, and ISBPs.

ICEs
InstallShield 2020

The validation tool checks your project for compliance with each of the internal consistency evaluators, or ICEs. These ICEs
are those used by Msival2.exe (part of the Microsoft Windows Installer Platform SDK) to validate installation and merge
module packages for Windows logo compliance.

If your installation project or merge module project fails one or more of these ICEs, InstallShield reports the specific ICE
rules that were violated and offers additional information to help you troubleshoot the problem.

To learn about specific ICEs, see ICE Reference in the Windows Installer Help Library.

See Also
Requirements for the Windows Logo Program

ISICEs
InstallShield 2020

The InstallShield validation suites consist of a number of InstallShield ICEs (ISICEs) that help you check your project for
compliance with installation requirements of the Windows logo program.

The following table lists the ISICEs that are available in InstallShield.

Table 4-18 • ISICEs

ISICE Project Type Description

ISICE01 Basic MSI, Validates that the application is installed to ProgramFiles or the user’s
InstallScript MSI, AppData folder by default.
MSI Database

ISICE02 Basic MSI, Validates that all executable files included with the installation or merge
InstallScript MSI, module are digitally signed.
Merge Module,
MSI Database

1370 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-18 • ISICEs (cont.)

ISICE Project Type Description

ISICE03 Basic MSI, Validates that there are no nested-installation custom actions (type 7, 23,
InstallScript MSI, and 39).
Merge Module,
MSI Database

ISICE04 Basic MSI, Validates that there are no custom columns added to standard .msi tables.
InstallScript MSI,
Merge Module,
MSI Database

ISICE05 Basic MSI, Validates that there are no properties or custom tables that begin with MSI
InstallScript MSI, (case-insensitive).
Merge Module,
MSI Database

ISICE06 Basic MSI, Validates that the installation does not include any files protected by
InstallScript MSI, Windows Resource Protection.
Merge Module,
MSI Database

ISICE07 Basic MSI, Validates that MSI components are authored for proper installation and
InstallScript MSI, uninstallation.
Merge Module,
MSI Database

ISICE08 Basic MSI, Validates that deferred custom actions do not have the impersonate bit set.
InstallScript MSI,
Merge Module,
MSI Database

ISICE09 Basic MSI, Validates that the installation includes an MsiPatchCertificate table entry.
InstallScript MSI,
MSI Database

ISICE10 Basic MSI, Validates that each custom action has a path specified for the Help File Path
InstallScript MSI, setting in the Custom Actions view.
Merge Module,
MSI Database

ISICE11 Basic MSI, Validates that .exe files have embedded manifests with required information.
InstallScript MSI,
Merge Module,
MSI Database

InstallShield 2020 User Guide ISP-2600-UG00 1371

Chapter 4
Building, Testing, and Deploying Installations

Table 4-18 • ISICEs (cont.)

ISICE Project Type Description

ISICE12 Basic MSI, Validates that no protected registry keys are modified.
InstallScript MSI,
Merge Module,
MSI Database

ISICE13 Basic MSI, Validates that no .hlp files or WinHelp run-time files are included in the
InstallScript MSI, installation. This ICE is now ISBP17.
Merge Module,
MSI Database

ISICE14 Basic MSI, Validates that no obsolete APIs are imported. This ICE is now ISBP18.
InstallScript MSI,
Merge Module,
MSI Database

ISICE15 Basic MSI, Validates that no deprecated APIs are imported. This ICE is now ISBP19.
InstallScript MSI,
Merge Module,
MSI Database

ISICE16 Basic MSI, Validates that no 16-bit components are distributed in an installation that
InstallScript MSI, targets 64-bit systems.
Merge Module,
MSI Database

ISICE17 Basic MSI, Validates that the installation or merge module does not force a reboot.
InstallScript MSI,
Merge Module,
MSI Database

ISICE18 Basic MSI, Validates that the MsiRMFilesInUse dialog is included.

MSI Database

ISICE19 Basic MSI, Validates properties related to upgrades, that the Upgrade table is present,
InstallScript MSI, and that the installation prevents downgrades.
MSI Database

ISICE20 Basic MSI, Validates that no machine-wide settings are installed by a non-privileged
InstallScript MSI, installation.
MSI Database

ISICE21 Basic MSI, Validates that the app does not depend on the VB6 runtime.
InstallScript MSI,
MSI Database

1372 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-18 • ISICEs (cont.)

ISICE Project Type Description

ISICE22 Basic MSI, Validates that the app does not start automatically on system startup.
InstallScript MSI,
MSI Database

ISICE23 Basic MSI, Validates that the app sets strong and appropriate ACLs.
InstallScript MSI,
MSI Database

ISICE24 Basic MSI, Validates that the installation does not install 16-bit components.
InstallScript MSI,
MSI Database

ISICE25 Basic MSI, Validates that the installation does not install any files to the Windows
InstallScript MSI, directory or its subdirectories.
MSI Database

ISICE26 Basic MSI, Validates that applications support Windows security features by controlling
InstallScript MSI, permissions appropriately.
MSI Database

Tip • In some cases, the following validation error message may be displayed for an ISICE:

File [1] in Component [2] could not be found. All tests against this file's contents may be invalid.
This error occurs if the specified file is missing, and the associated ISICE could not be verified for the file. For example, if an
executable file is missing, ISICE11 cannot verify whether the file has an embedded manifest.

If the aforementioned validation error message is displayed, resolve the missing file issue, and then rerun validation for your
project.

See Also
Viewing Validation Results

ISICE01
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

InstallShield 2020 User Guide ISP-2600-UG00 1373

Chapter 4
Building, Testing, and Deploying Installations

Message (Error)
The application should be installed to either ProgramFiles or AppData folder by default. The current
default location is [1].

[1] is the default installation location for the product.

Description
Users should be able to install products where they need them, and they should have a consistent experience with where
files are stored by default.

ISICE01 verifies that the default destination location for your product is the Program Files folder or the Application Data
folder. If a different location is used, this error message is displayed during validation.

Corrective Action
Change the default location. For more information, see Setting the Default Product Destination Folder (INSTALLDIR).

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE02
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Message (Error)
File [1] in Component [2] is not digitally signed. All [3] files distributed to Windows Vista and later
are required to be signed.

[1] is the name of an executable file, [2] is the name of the component that contains that file, and [3] is the type of file that
must be signed.

Description
ISICE02 verifies that all executable files in your installation have been digitally signed. This includes files with the following
extensions: exe, dll, ocx, sys, cpl, drv, and scr. If an executable file in your installation has not been digitally signed, this
error message is displayed during validation.

Corrective Action
Ensure that all executable files in your installation have been digitally signed. For more information, see Digital Signing and
Security.

1374 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE03
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Message (Error)
Nested custom action [1] of type [2] is not allowed.

[1] is the name of a custom action in your project, and [2] is the Windows Installer type number of custom action.

Description
ISICE03 verifies that your installation does not include any nested-installation custom actions. Nested installations is a
deprecated feature of the Windows Installer. Applications installed with nested installations sometimes fail because they
are difficult for end users to service correctly. Microsoft Corporation recommends that you avoid using nested installations
and nested-installation custom actions to install products that are intended to be released to the public.

To learn more, see Concurrent Installations in the Windows Installer help library.

Corrective Action
To resolve this error, remove the nested-installation custom action from your project. The MSI Type Number value in the
Custom Actions and Sequences view (in Basic MSI, InstallScript MSI, MSI Database, and Transform projects) or the Custom
Actions view (in Merge Module and MSM Database projects) for nested-installation custom actions is 7, 23, or 39.

As an alternative to using a nested installation, you may want to create a create an InstallShield prerequisite, and then add
that InstallShield prerequisite to your installation project. For more information, see Defining InstallShield Prerequisites.

See Also
Working with InstallShield Prerequisites that Are Included in Installation Projects
Summary List of All Custom Action Types (Windows Installer Help Library)
Summary List of All Custom Action Types (Windows Installer Help Library)
Requirements for the Windows Logo Program
ISICEs

InstallShield 2020 User Guide ISP-2600-UG00 1375

Chapter 4
Building, Testing, and Deploying Installations

ISICE04
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Message (Error)
The standard MSI table [1] does not match the MSI schema defined in schema.msi.

[1] is the name of a table in your project.

Description
ISICE04 verifies that your installation does not add custom table columns to standard tables. Adding columns to standard
tables is reserved for future versions of Windows Installer.

Corrective Action
To resolve this error, remove any custom table columns that were added to the table that is mentioned in the error
message. You can do this by exporting the table from the Direct Editor, editing the table in a text editor, and importing the
revised table.

See Also
Database Tables (Windows Installer Help Library)
Database Tables (Windows Installer Help Library)
Requirements for the Windows Logo Program
ISICEs

ISICE05
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

1376 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Messages

Message 1 (Error)
MSI property [1] begins with reserved characters. MSI property names cannot start with "MSI" (case-
insensitive).

[1] is the name of a property in your project.

Message 2 (Error)
Table [1] begins with reserved characters. Custom table names cannot start with "MSI" (case-
insensitive).

[1] is the name of a table in your project.

Description
ISICE05 verifies that your installation does not include any custom properties or custom tables whose names begin with
MSI in any combination of uppercase and lowercase letters. The MSI prefix is reserved for future use in new standard
properties and tables.

Corrective Action
To resolve the property-related error, use the Property Manager to rename the custom property that is mentioned in the
error message.

To resolve the table-related error, use the Direct Editor to export the table, use a text editor to edit the table name in the
exported .idt file, and use the Direct Editor to import the newly renamed table into the Direct Editor. Then delete the
original custom table.

See Also
Naming Custom Tables, Properties, and Actions (Windows Installer Help Library)
Naming Custom Tables, Properties, and Actions (Windows Installer Help Library)
Exporting Tables from the Direct Editor
Importing Tables with the Direct Editor
Removing Tables Through the Direct Editor
Requirements for the Windows Logo Program
ISICEs

ISICE06
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

InstallShield 2020 User Guide ISP-2600-UG00 1377

Chapter 4
Building, Testing, and Deploying Installations

Messages

Message 1 (Error)
File [1] in Component [2] is a Windows Protected File. Protected files may not be distributed to Windows
Vista and later.

[1] is the name of a file in your project, and [2] is the name of the component that contains that file.

Message 2 (Warning)
File [1] in Component [2] has the same file name as a Windows Protected File, but appears to be
distributed to a different path.

[1] is the name of a file in your project, and [2] is the name of the component that contains that file.

Description
ISICE06 verifies that your installation does not install files that are protected by Windows Resource Protection (WRP). WRP
is designed to ensure that protected system resources are updated on Windows Vista and later machines only through
Microsoft-approved installation or update mechanisms.

If your installation installs a file that has the same name as a Windows Protected File, but the file is not installed to the
same location as the Windows Protected File, warning message 2 is displayed.

Corrective Action
To resolve the validation error, remove the file that is mentioned in the error message from your project.

If you encounter the validation warning, determine if the file that is mentioned in the message is a protected file:

• If the file is not a protected file but it has the same name as a protected file, you can ignore this warning.

• If the file is a protected file, remove it from your project to resolve this warning.

If your product requires newer versions of system components, the components must be updated on target machines by
using a Microsoft service pack or a Microsoft-approved installation package that contains the system component. System
components should not be repackaged.

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE07
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

1378 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Messages

Message 1 (Error)
Component.ComponentId for Component [1] is null. All components must have a valid ComponentId for proper
installation and uninstallation. If this is left null, justification must be documented.

[1] is the name of a component in your project that does not have a GUID specified in the Component Code setting in the
Components view.

Message 2 (Error)
Component [1] contains COM data, but it has more than 1 file. Each COM component should contain only 1
COM file.

[1] is the name of a component in your project that contains more than one COM server.

Message 3 (Error)
Component [1] has more than one file as the target of a Desktop or Start Menu shortcut.

[1] is the name of a component in your project that has more than one file specified as the target of a shortcut.

Message 4 (Error)
Component [1] is associated with multiple features and is referenced in the following tables: [2]. These
references require the component to be associated with exactly 1 feature.

[1] is the name of a component in your project that is associated with more than one feature and that has references in any
of the following tables: Class, Extension, MsiAssembly, PublishComponent, TypeLib. [2] is a comma-delimited list of
tables that contain references to the component.

Description
ISICE07 verifies that the components in your installation adhere to component rules, which help to ensure that the
installation or uninstallation of one product does not harm any other product on a target system. These rules also help to
ensure that Windows Installer correctly removes all resources that are connected with a product that is being uninstalled.

Corrective Action
To resolve error 1, open the Components view, select the component that is mentioned in the error message, and click the
Component Code setting. In the help pane that is displayed in the lower-right pane, click Generate GUID. If you have a valid
reason for leaving the Component Code setting blank, you can document it in the application that you submit for the
Windows logo program.

To resolve error 2, move any COM servers to separate components so that each COM server is the key path of its
component.

To resolve error 3, use the Shortcuts view to delete all but one of the shortcuts that are associated with the component
mentioned in the error message.

To resolve error 4, use the Setup Design view or the Features view to remove the component from all but one feature.

InstallShield 2020 User Guide ISP-2600-UG00 1379

Chapter 4
Building, Testing, and Deploying Installations

See Also
Component Settings
Setting Key Paths for Components
Creating Shortcuts and Program Folders
Requirements for the Windows Logo Program
ISICEs

ISICE08
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Message (Error)
Custom Action [1] uses impersonation. Impersonation should not be used when running setups on Windows
Vista or later.

[1] is the name of a custom action in your project.

Description
ISICE08 verifies that your installation does not contain any custom actions that use impersonation. If you select one of the
Terminal Server Aware options for the type of in-script execution setting (in the Custom Actions and Sequences view, in the
Custom Actions view, or on the Respond Options panel of the Custom Action Wizard), the custom action impersonates the
end user during per-machine installations on terminal server machines.

Corrective Action
To resolve this validation error, open the Custom Actions and Sequences view (or the Custom Actions view) and click the
custom action that is mentioned in the error message. Change the value of the In-Script Execution setting to one of the
options that does not include Terminal Server Aware.

See Also
In-Script Execution
Requirements for the Windows Logo Program
ISICEs
Custom Actions and Sequences View (or Custom Actions View)
Custom Action Types

1380 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

ISICE09
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
An MsiPatchCertificate table entry is required for User Account Control (UAC) patching.

Description
ISICE09 verifies that your installation includes an MsiPatchCertificate table entry. In a base installation, this table
provides the signer certificate that will be used to verify the digital signature of subsequent patches when they are applied
by a non-administrator or an administrator who is not using elevated privileges.

Corrective Action
To resolve this validation error, add the MsiPatchCertificate table to your project. To learn how, see Preparing
Installations for Non-Administrator Patches.

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE10
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Message (Error)
Custom action [1] of type [2] is not documented in table [3].

[1] is the name of a custom action in your project, and [2] is its Windows Installer type number. [3] is the name of the table
that is missing an entry for the custom action that is listed.

InstallShield 2020 User Guide ISP-2600-UG00 1381

Chapter 4
Building, Testing, and Deploying Installations

Description
The intended behavior of each custom action must be documented for the Windows logo program. This is especially
helpful if system administrators deploy your product to enterprise environments; they sometimes need to know what the
custom actions do.

ISICE10 verifies that each custom action in your installation is documented by validating that each entry in the
CustomAction table has a corresponding ISCustomActionReference table entry.

Corrective Action
To resolve this validation error, open the Custom Actions and Sequences view (or the Custom Actions view), select the
custom action that is mentioned in the error message, and use the Help File Path setting to specify a path to the document
that describes the behavior of the custom action. When you specify a value in the Help File Path setting, InstallShield adds
a row for that custom action in the ISCustomActionReference table if one has not already been created.

In addition, configure the product configuration for the release so that InstallShield streams the contents of each of the
custom action help files into the .msi file at build time. For more information, see the description of the Include Custom
Action Help setting on the General tab for a product configuration in the Releases view.

Note that if the custom action is a merge module that is consumed in your installation project, specify the path in the
Custom Actions view of the merge module project and then rebuild the merge module.

See Also
ISCustomActionReference Table
Documenting the Behavior of Custom Actions
Guidelines for Creating Custom Actions that Meet Requirements of the Windows Logo Program
Requirements for the Windows Logo Program
ISICEs

ISICE11
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Messages

Message 1 (Error)
Exe [1] in component [2] lacks a manifest.

[1] is the name of an executable file in your project that does not have a manifest, and [2] is the name of the component
that contains the executable file.

1382 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Message 2 (Error)
Exe [1] in component [2] lacks a requestedExecutionLevel level setting in its manifest.

[1] is the name of an executable file in your project that has a manifest that was possibly created for Windows XP but that
was not updated for Windows Vista and later. The manifest does not define the execution level for the executable file. [2] is
the name of the component that contains the executable file.

Message 3 (Error)
Exe [1] in component [2] lacks a requestedExecutionLevel uiAccess setting in its manifest.

[1] is the name of an executable file in your project that has a manifest that was possibly created for Windows XP but that
was not updated for Windows Vista and later. The manifest does not define the UI accessibility value for the executable file.
[2] is the name of the component that contains the executable file.

Message 4 (Warning)
Exe [1] in component [2] is marked to require elevated privileges (highestAvailable) which requires a
waiver from Microsoft.

[1] is the name of an executable file in your project that has a manifest that specifies that elevated privileges are required,
and [2] is the name of the component that contains the executable file.

Message 5 (Warning)
Exe [1] in component [2] is marked to require elevated privileges (requireAdministrator) which requires
a waiver from Microsoft.

[1] is the name of an executable file in your project that has a manifest that specifies that elevated privileges are required,
and [2] is the name of the component that contains the executable file.

Message 6 (Warning)
Exe [1] in component [2] is marked to require uiAccess which requires a waiver from Microsoft.

[1] is the name of an executable file in your project that has a manifest that specifies that the executable file is allowed to
bypass UI protection levels in order to use higher privileges to pass information to other windows on the desktop; that is,
the value of uiAccess is set to true. [2] is the name of the component that contains the executable file.

Description
ISICE11 verifies that every .exe file in your installation has an embedded manifest that defines its execution level. The
execution level is defined in the manifest as follows:

<requestedExecutionLevel
level="asInvoker"
uiAccess="false"/>

Other valid values for the level attribute are highestAvailable and requireAdministrator. Note that if you set the level value
to highestAvailable or requireAdministrator, you must apply for a waiver from Microsoft to obtain Windows logo
certification.

The uiAccess attribute indicates whether the executable file is allowed to bypass UI protection levels in order to use higher
privileges for passing information to other windows on the desktop, such as on-screen keyboards. This attribute should be
set to true only for UI accessibility applications. Note that if you set the UI accessibility value to true, you must apply for a
waiver from Microsoft to obtain Windows logo certification.

InstallShield 2020 User Guide ISP-2600-UG00 1383

Chapter 4
Building, Testing, and Deploying Installations

Corrective Action
To resolve the validation errors (messages 1 through 3), replace the executable file in your installation with one that has an
embedded manifest whose level and uiAccess values are set appropriately.

The validation warnings (messages 4 through 6) are displayed to inform you that if you want to have your product qualify
for the Windows logo program but you keep the requestedExecutionLevel element as it is currently defined in the
executable file’s manifest, you may need to obtain a waiver from Microsoft.

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE12
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Message (Error)
Registry key [1] in Component [2] is a protected registry key. Protected registry keys may not be
modified on Windows Vista and later.

[1] is a registry key that only the Trusted Installer group can modify on Windows Vista or later systems, and [2] is the name
of the component that contains that registry key.

Description
ISICE12 verifies that the installation does not attempt to modify registry keys that are protected by Windows Resource
Protection (WRP) on Windows Vista and later systems. Registry keys that can be modified by only the Trusted Installer
group are protected by WRP.

Corrective Action
To resolve this validation error, use the Registry view to remove the protected registry key from your project, or move it to
a part of the registry that is not protected by WRP.

See Also
Using Windows Installer and Windows Resource Protection (Windows Installer Help Library)
Using Windows Installer and Windows Resource Protection (Windows Installer Help Library)
Requirements for the Windows Logo Program
ISICEs

1384 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

ISICE16
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Message (Error)
File [1] in Component [2] is a 16-bit file. Installations that target 64-bit systems may not include 16-
bit files.

[1] is the name of a 16-bit file in your project, and [2] is the name of the component that contains the file.

Description
If your installation targets 64-bit platforms, ISICE16 verifies that it does not contain any 16-bit files, since 64-bit platforms
do not support 16-bit files.

Corrective Action
To resolve this validation error, replace the 16-bit file with a 64-bit or 32-bit file.

See Also
Windows Installer on 64-bit Operating Systems (Windows Installer Help Library)
Windows Installer on 64-bit Operating Systems (Windows Installer Help Library)
Requirements for the Windows Logo Program
ISICEs

ISICE17
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• Merge Module
• MSI Database

Messages

Message 1 (Error)
Sequence [1] includes the [2] action. Use of the [2] action requires a waiver from Microsoft.

InstallShield 2020 User Guide ISP-2600-UG00 1385

Chapter 4
Building, Testing, and Deploying Installations

[2] is the name of an action in your project, and [1] is the name of the sequence that contains that action.

Message 2 (Error)
Control [1] on Dialog [2] runs the [3] action. Use of the [3] action requires a waiver from Microsoft.

[3] is the name of an action in your project. [2] is the name of the control that includes an event that launches that action.
[2] is the name of the dialog that has the control.

Description
ISICE17 verifies that the installation does not use an action to force a reboot. Currently, the only action that is validated is
ForceReboot.

Corrective Action
The errors are displayed to inform you that if you want to have your product qualify for the Windows logo program but you
keep the specified action in your installation, you may need to obtain a waiver from Microsoft.

To resolve these validation errors, remove the action from sequence or dialog that is mentioned in the message.

Ensure that your project includes the MsiRMFilesInUse dialog to minimize system reboots, and that your application has
been properly instrumented to use the Restart Manager API. For more information, see Minimizing Reboots on Windows
Vista and Later Systems.

See Also
ForceReboot Action (Windows Installer Help Library)
ForceReboot Action (Windows Installer Help Library)
Requirements for the Windows Logo Program
ISICEs

ISICE18
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• MSI Database

Messages

Message 1 (Error)
Dialog [1] is not present in the Dialog table.

[1] is the name of a dialog that should be in your project.

Message 2 (Error)
The Title of Dialog [1] does not include [2] or [ProductName].

[1] is the name of a dialog in your project, and [2] is the value of the [ProductName] variable.

1386 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Description
ISICE18 verifies that the installation includes the MsiRMFilesInUse dialog, and that the dialog’s title bar contains the name
of the product.

Corrective Action
To resolve error 1, ensure that the MsiRMFilesInUse dialog is in your project. All Basic MSI projects include this dialog by
default. For more information about this dialog, see Minimizing Reboots on Windows Vista and Later Systems.

To add the dialog back to a Basic MSI project, you can open another Basic MSI project that contains this dialog, or create a
new Basic MSI project. Then export the dialog to the project that needs it. For more information, see Exporting Dialogs to
Other Projects.

To resolve error 2, add the product name or the [ProductName] property to the Caption property for the MsiRMFilesInUse
dialog.

See Also
Using Windows Installer with Restart Manager (Windows Installer Help Library)
Using Windows Installer with Restart Manager (Windows Installer Help Library)
Dialog Control
Requirements for the Windows Logo Program
ISICEs

ISICE19
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Messages

Message 1 (Error)
The table [1] is not present in the installation package.

[1] is the name of a table that must be in the package.

Message 2 (Error)
UpgradeCode [1] does not detect and prevent downgrades with a properly scheduled Type 19 Custom Action;
the package must prevent downgrades.

[1] is the value of the UpgradeCode property.

Message 3 (Error)
The property [1] is not listed in SecureCustomProperties; this can prevent it from being used correctly
for downgrade prevention.

InstallShield 2020 User Guide ISP-2600-UG00 1387

Chapter 4
Building, Testing, and Deploying Installations

[1] is the name of a property.

Message 4 (Error)
The property [1] must be a valid GUID; [2] is not a valid GUID.

[1] is the name of a property whose value should be a valid GUID. [2] is the invalid value that is currently used for that
property.

Message 5 (Error)
Column [1] of table Upgrade must hold a valid GUID; [2] is not a valid GUID.

[1] is the name of a column in the Upgrade table, and [2] is the value of an entry in the specified column.

Message 6 (Error)
The property [1] must hold a valid numeric version in the format Major.Minor.Build; [2] is not a version
in this format.

[1] is the name of a property whose value should be a version number in the Major.Minor.Build format. [2] is the invalid
value that is currently used for that property.

Message 7 (Error)
Column [1] of table Upgrade must hold a valid numeric version in the format Major.Minor.Build; [2] is not
a version in this format.

[1] is the name of a column in the Upgrade table, and [2] is the value of an entry in the specified column.

Message 8 (Error)
The property [1] must not be null or empty.

[1] is the name of a property that is null or empty.

Message 9 (Error)
Column [1] of table Upgrade must not be null or empty.

[1] is the name of a column in the Upgrade table.

Message 10 (Error)
The property [1] must be provided; [2] is the default value.

[1] is the name of a property in your project that has not been customized. [2] is the default value that InstallShield uses for
that property.

Message 11 (Error)
The property [1] must hold a valid numeric LANGID; [2] is not a numeric LANGID.

[1] is the name of a property whose value should be a valid language identifier. [2] is the invalid value that is currently used
for that property.

Description
ISICE19 validates properties related to upgrades and that the Upgrade table is present. ISICE19 also helps you determine
whether the installation prevents an earlier package from installing over a new package.

1388 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Corrective Action
To resolve errors 1 and 2, ensure that the Upgrades view contains a major upgrade item, that the major upgrade item is
properly configured to prevent the current version of your product from being installed over a future version, and that your
project includes a properly configured and scheduled type 19 custom action. For detailed instructions, see Preventing the
Current Installation from Overwriting a Future Major Version of the Same Product. For more information, see Preventing an
Old Package from Installing Over a Newer Version in the Windows Installer Help Library.

To resolve error 3, add the specified property to the value of the SecureCustomProperties property. You can use the
Property Manager view to set a value for a property. To add multiple values, separate each with a semicolon. For more
information, see SecureCustomProperties Property in the Windows Installer Help Library.

To resolve errors 4 and 5, replace the existing value with a valid GUID. To change the value, open the General Information
view. Then click the setting that is listed in the error message. Enter a valid GUID. Note that if you want to use a new, unique
GUID, you can click the Generate a new GUID button in the setting. For more information, see GUIDs.

To resolve errors 6 and 7, replace the specified value with a valid version number; you can click the error message in the
Output window to move to the location in the Direct Editor that has the invalid value. The version number must contain
only numbers, and it must be in the format aaa.bbb.ccccc, where aaa represents the major version number, bbb represents
the minor version number, and ccccc represents the build number. The maximum value for the aaa and bbb portions is 255.
The maximum value for ccccc is 65,535. For more information, see Specifying the Product Version.

To resolve error 8, enter a value for the specified property. You can use the Property Manager view to set a value for a
property.

To resolve error 9, enter a value for the specified column. You can use the Direct Editor view to set the value; you can click
the error message in the Output window to move to the location in the Direct Editor that needs to be revised. To learn more
about any of the Windows Installer tables, see Database Tables in the Windows Installer Help Library.

To resolve error 10, replace the default value of the specified property with the appropriate value. You can use the Property
Manager view to change the value.

To resolve error 11, replace the existing value of the specified property with a valid language identifier.

See Also
Upgrade Table (Windows Installer Help Library)
Upgrade Table (Windows Installer Help Library)
Property Manager View
Requirements for the Windows Logo Program
ISICEs

ISICE20
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

InstallShield 2020 User Guide ISP-2600-UG00 1389

Chapter 4
Building, Testing, and Deploying Installations

Messages

Message 1 (Error)
Row [1] of Table [2]: installing, modifying, or deleting a registry key in root [3] requires elevated
privileges, but this package does not request elevated privileges.

[1] is the name of the row that contains information about a registry change in your project. [2] is the name of the table that
contains that registry-related data. [3] is the predefined root key for the registry data, as listed in the Root column for the
specified row.

Message 2 (Error)
Row [1] of Table [2]: installing, modifying, or deleting a file in directory [3] requires elevated
privileges, but this package does not request elevated privileges.

[1] is the name of a row that contains information about a directory that end users cannot access without elevated
privileges. [2] is the name of the table that contains that directory data. [3] is the name of the directory.

Message 3 (Error)
Environment variable [1] is a system environment variable, but this package does not request elevated
privileges.

[1] is the name of a system environment variable that is included in your project.

Description
If the Require Administrative Privileges setting in the General Information view is set to No for your project, ISICE20 verifies
that your installation does not attempt to perform tasks that require administrative privileges, such as writing to system
registry or folder locations.

Corrective Action
To resolve ISICE20 errors, do one of the following:

• Select Yes for the Require Administrative Privileges setting in the General Information view. For more information, see
Entering Summary Information Stream Data.

• Change your project so that it does not install, modify, or delete data in system locations. For example, if your project
adds a registry key to HKEY_LOCAL_MACHINE, use the Registry view to move that registry key to
HKEY_CURRENT_USER. If your project adds or modifies a system environment variable, use the Environment
Variables view to change the Type setting of that environment variable from System to User.

See Also
Authoring Packages without the UAC Dialog Box (Windows Installer Help Library)
Authoring Packages without the UAC Dialog Box (Windows Installer Help Library)
Installing a Package with Elevated Privileges for a Non-Admin (Windows Installer Help Library)
Installing a Package with Elevated Privileges for a Non-Admin (Windows Installer Help Library)
Guidelines for Packages (Windows Installer Help Library)
Guidelines for Packages (Windows Installer Help Library)
Minimizing the Number of User Account Control Prompts During Installation
Requirements for the Windows Logo Program
ISICEs

1390 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

ISICE21
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
File [1] in Component [2] depends on the VB6 runtime.

[1] is the name of a file that requires the Visual Basic 6 runtime. [2] is the name of the component that contains that file.

Description
ISICE21 verifies that your product does not depend on the Visual Basic 6 runtime.

Corrective Action
To resolve this validation error, consider the following options:

• If the file is in a component that your product no longer uses, remove the file and its component from your project.
Consider using a newer language such as Visual Basic .NET for the creation of your file.

• Remove the file and its component from your project and replace them with new versions that do not rely on the
Visual Basic 6 runtime.

If neither of those options are feasible for your product, your installation will not qualify for the Windows logo program.

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE22
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Messages

Message 1 (Error)
Shortcut [1] in Component [2] targets the startup folder.

InstallShield 2020 User Guide ISP-2600-UG00 1391

Chapter 4
Building, Testing, and Deploying Installations

[1] is the name of a shortcut in your project, and [2] is the name of the component that contains that shortcut.

Message 2 (Error)
Registry key [1] in Component [2] sets a Run key.

[1] is a registry key in your project, and [2] is the name of the component that contains that shortcut.

Description
ISICE22 verifies that your product does not start automatically when the target system starts.

Error message 1 occurs if your installation creates a shortcut in the Startup folder on the Start Menu.

Error message 2 occurs if your installation sets a Run key in locations of the registry such as the following ones:

• HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion

• HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion

• HKEY_LOCAL_MACHINE\Software\Wow6432Node\Microsoft\Windows\CurrentVersion

• HKEY_CURRENT_USER\Software\Wow6432Node\Microsoft\Windows\CurrentVersion

Corrective Action
To resolve this validation error, remove the shortcut or registry key and—if appropriate—the component that contains it
from your project.

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE23
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
LockObject [1] in Component [2] sets insecure permissions.

[1] is the name of a file, directory, or registry key for which permissions are configured. [2] is the name of the component
that contains that file, directory, or registry key.

Description
ISICE23 verifies that your installation does not expose a target system to security risks through the configuration of
inappropriate permissions for files, directories, and registry keys.

1392 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

For example, if your installation assigns write permission to the Everyone user for a particular folder that your installation
installs, ISICE23 triggers an error to alert you to the security vulnerability to which your installation exposes target systems.

Corrective Action
To resolve this validation error, use strong and appropriate permissions for the file, directory, or registry key that is
mentioned in the error. For more information, see:

• Configuring Permissions for Files and Folders

• Configuring Permissions for Registry Keys

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE24
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
File [1] in Component [2] is a 16-bit file. Installations that target Windows 8 systems may not include
16-bit files.

[1] is the name of a 16-bit file in the installation. [2] is the name of the component that contains that file.

Description
ISICE24 verifies that the installation does not contain any 16-bit files; 64-bit versions of Windows do not support 16-bit files.

Corrective Action
To resolve this validation error, replace the 16-bit file with a 64-bit or 32-bit file.

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE25
InstallShield 2020

Project • This information applies to the following project types:

InstallShield 2020 User Guide ISP-2600-UG00 1393

Chapter 4
Building, Testing, and Deploying Installations

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
The destination of Component [1] is the Windows folder or one of its subfolders.

[1] is the name of a component.

Description
ISICE25 verifies that the installation does not write directly to the Windows folder or any of its subfolders.

Corrective Action
To resolve this validation error, do one of the following:

• Change the destination of the component.

• If the component is installing a font, ensure that the font file is included in the project according to best practices. To
learn how, see Installing Fonts.

• If the component is installing a device driver, ensure that the driver is included in the project according to best
practices. To learn how, see Configuring Device Driver Settings.

See Also
Requirements for the Windows Logo Program
ISICEs

ISICE26
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
File [1] in Component [2] does not have the Option Header bit [3] set.

[1] is the name of a file, and [2]is the name of the component that contains the file. [3] is the parameter (SafeSEH,
NXCOMPAT, or DYNAMICBASE) that was not used when compiling the file.

Description
ISICE26 verifies that the installation supports Windows security features. It checks the PE header of the executable files
that the installation installs to verify that they were compiled using the following command-line parameters:

• /SafeSEH—to ensure safe exceptions handling

1394 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• /NXCOMPAT—to prevent data execution

• /DYNAMICBASE—for address space layout randomization (ASLR)

A single file can trigger multiple ISICE26 errors, one for each of the aforementioned parameters.

Corrective Action
To resolve this validation error, review build the options for your product’s source code, and edit them as needed. In Visual
Studio, these are configured on the Advanced property page for Linker settings.

See Also
Requirements for the Windows Logo Program
ISICEs

InstallShield Virtualization Suitability Suite

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

InstallShield includes a set of validators called the InstallShield Virtualization Suitability Suite. The InstallShield
Virtualization Suitability validators (ISVICEs) in this suite help you check your project’s suitability for various virtualization
technologies.

The following table lists the ISVICEs that are available in InstallShield.

Table 4-19 • ISVICEs

ISICE Project Type Technology Description

ISVICE01 Basic MSI, App-V 4.x, Checks for the presence of files that may normally be
InstallScript MSI, App-V 5.x, part of the Windows operating system.
MSI Database Server App-V,
ThinApp,
XenApp

ISVICE02 Basic MSI, App-V 4.x, Checks for the presence of device driver files.
InstallScript MSI, App-V 5.x,
MSI Database Server App-V,
ThinApp,
XenApp

InstallShield 2020 User Guide ISP-2600-UG00 1395

Chapter 4
Building, Testing, and Deploying Installations

Table 4-19 • ISVICEs (cont.)

ISICE Project Type Technology Description

ISVICE03 Basic MSI, App-V 4.x, Checks for the presence of ClickOnce deployment
InstallScript MSI, App-V 5.x, files.
MSI Database Server App-V,
ThinApp,
XenApp

ISVICE04 Basic MSI, App-V 4.x, Checks for the presence of files that are part of
InstallScript MSI, App-V 5.x, ASP.NET/IIS applications.
MSI Database ThinApp,
XenApp

ISVICE05 Basic MSI, App-V 4.x, Checks for the presence of files that are part of WMI
InstallScript MSI, App-V 5.x, providers.
MSI Database ThinApp,
XenApp

ISVICE06 Basic MSI, App-V 4.x, Checks for the presence of files that are part of J2EE
InstallScript MSI, App-V 5.x, application servers.
MSI Database Server App-V,
ThinApp,
XenApp

ISVICE07 Basic MSI, App-V 4.x, Checks for the presence of files that are part of
InstallScript MSI, App-V 5.x, applications that may not work when virtualized.
MSI Database Server App-V,
ThinApp,
XenApp

ISVICE08 Basic MSI, App-V 4.x, Checks for the presence of files that are part of
InstallScript MSI, App-V 5.x, applications that are known to fail when virtualized.
MSI Database Server App-V,
ThinApp,
XenApp

ISVICE09 Basic MSI, App-V 4.x, Checks for the presence of InstallShield IIS support
InstallScript MSI, App-V 5.x, indicating that an ASP.NET/IIS application is
MSI Database ThinApp, installed.
XenApp

ISVICE10 Basic MSI, App-V 4.x, Checks for the presence of drivers installed through
InstallScript MSI, App-V 5.x, the MsiDriverPackages table.
MSI Database Server App-V,
ThinApp,
XenApp

1396 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-19 • ISVICEs (cont.)

ISICE Project Type Technology Description

ISVICE11 Basic MSI, App-V 4.x, Checks the package to ensure that it contains at least
InstallScript MSI, App-V 5.x, one shortcut.
MSI Database ThinApp,
XenApp

ISVICE12 Basic MSI, App-V 4.x, Checks for the presence of shell extensions.
InstallScript MSI, App-V 5.x,
MSI Database Server App-V,
ThinApp,
XenApp

ISVICE13 Basic MSI, App-V 4.x, Checks for the presence of URL protocol handlers.
InstallScript MSI, Server App-V,
MSI Database ThinApp,
XenApp

ISVICE14 Basic MSI, App-V 4.x, Checks for the presence of support for the Default
InstallScript MSI, Server App-V, Programs list.
MSI Database ThinApp,
XenApp

ISVICE15 Basic MSI, App-V 4.x, Checks for the presence of boot start services.
InstallScript MSI, App-V 5.x,
MSI Database ThinApp,
XenApp

ISVICE16 Basic MSI, App-V 4.x, Checks to ensure that the total installed file size is
InstallScript MSI, Server App-V, less than 4 GB.
MSI Database XenApp

ISVICE17 Basic MSI, App-V 4.x, Checks for the usage of the Windows Installer COM+
InstallScript MSI, App-V 5.x, tables.
MSI Database ThinApp,
XenApp

ISVICE18 Basic MSI, App-V 4.x, Checks for the presence of COM DLL surrogate files.
InstallScript MSI, App-V 5.x,
MSI Database ThinApp,
XenApp

ISVICE19 Basic MSI, ThinApp, Checks to see if this is a 64-bit package. ThinApp and
InstallScript MSI, XenApp XenApp do not support 64-bit applications.
MSI Database

See Also
Viewing Validation Results

InstallShield 2020 User Guide ISP-2600-UG00 1397

Chapter 4
Building, Testing, and Deploying Installations

ISVICE01
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE01 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• Server App-V

• ThinApp

• XenApp

Message (Error)
The file [1] appears to be a file that is closely integrated with the OS. The files that make up
applications like Internet Explorer or Windows Media Player, or frameworks like the .NET Framework,
do not make good candidates for virtualization. These files should instead be installed locally on
the machine.

[1] is the name of a file in the project.

Description
ISVICE01 checks for the presence of files that may normally be part of the Windows operating system. If the release
contains one or more of those type of files, this error message is displayed during validation.

Corrective Action
If your end users may be interested in a virtualized version of your product, and if your InstallShield project contains the
.NET Framework or other items that are closely integrated with Windows, you may want to remove those items from your
project. You could document the technologies that are required for your product and instruct your end users to install
them locally on their machines before using a virtualized version of your product.

See Also
InstallShield Virtualization Suitability Suite

ISVICE02
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

1398 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• InstallScript MSI
• MSI Database

ISVICE02 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• Server App-V

• ThinApp

• XenApp

Message (Error)
The file [1] appears to be a device driver. System-level drivers such as print drivers or USB device
drivers do not work from a virtualized environment. It may be possible to extract this driver such
that it can be installed locally on the machine and allow the rest of the package to be virtualized.

[1] is the name of a file in the project.

Description
ISVICE02 checks for the presence of device driver files. System-level drives such as print drivers or USB device drivers do
not work from a virtualized environment.

Corrective Action
If your end users may be interested in a virtualized version of your product, and if your InstallShield project contains a
device driver, consider removing the device driver component from your project, and creating a separate installation for
the driver. End users can then install the driver locally to their machines before using a virtualized version of your product.

See Also
InstallShield Virtualization Suitability Suite

ISVICE03
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE03 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• Server App-V

InstallShield 2020 User Guide ISP-2600-UG00 1399

Chapter 4
Building, Testing, and Deploying Installations

• ThinApp

• XenApp

Message (Error)
The file [1] appears to be a ClickOnce deployment file. ClickOnce is a per-user installation format that
is often incompatible with the per-machine nature of virtual packages. A ClickOnce application also
may try to automatically update itself, which can result in invalid versioning in virtual
application management systems.

[1] is the name of a file in the project.

Description
ISVICE03 checks for the presence of ClickOnce deployment files. If your project includes ClickOnce deployment files,
ISVICE03 occurs.

Corrective Action
Evaluate how important the ClickOnce deployment files are to the application so that you can determine if it matters
whether the ClickOnce installation behaves as intended. If the ClickOnce deployment files are unimportant, it is probably
safe to deploy a virtualized version of the product with slightly reduced functionality. If the ClickOnce deployment files are
important, a virtualized version of the product may not function well.

See Also
InstallShield Virtualization Suitability Suite

ISVICE04
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE04 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• ThinApp

• XenApp

Message (Error)
The file [1] appears to be a part of an ASP.NET/IIS application. This is not supported by desktop
application virtualization.

[1] is the name of a file in the project.

1400 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Description
ISVICE04 checks for the presence of files that are part of ASP.NET or IIS applications.

Corrective Action
If the ASP.NET or IIS application is not an important part of the product, or if it can be separately installed locally on target
systems, you can ignore this validation error.

See Also
InstallShield Virtualization Suitability Suite

ISVICE05
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE05 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• ThinApp

• XenApp

Message (Error)
The file [1] appears to be a WMI provider. This is not supported by desktop application virtualization.
If the provider is not a critical piece of the package, it may be possible to use the rest of the
package as a virtual application.

[1] is the name of a file in the project.

Description
ISVICE05 checks for the presence of files that are part of Windows Management Instrumentation (WMI) providers.

Corrective Action
If the WMI provider is not an important part of the product, or if it can be separately installed locally on target systems, you
can ignore this validation error.

See Also
InstallShield Virtualization Suitability Suite

InstallShield 2020 User Guide ISP-2600-UG00 1401

Chapter 4
Building, Testing, and Deploying Installations

ISVICE06
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE06 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• Server App-V

• ThinApp

• XenApp

Message (Error)
The file [1] appears to be part of a J2EE application server. This is not supported by desktop
application virtualization.

[1] is the name of a file in the project.

Description
ISVICE06 checks for the presence of files that are part of J2EE application servers.

Corrective Action
If the J2EE application is not an important part of the product, or if it can be separately installed locally on target systems,
you can ignore this validation error.

See Also
InstallShield Virtualization Suitability Suite

ISVICE07
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE07 applies to the following virtualization technologies:

1402 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• App-V 4.x

• App-V 5.x

• Server App-V

• ThinApp

• XenApp

Message (Warning)
The file [1] appears to be a part of an application that is known to not be a good candidate for
virtualization; however, it may be possible to virtualize the rest of the package and install the
unsuitable piece physically.

[1] is the name of a file in the project.

Description
ISVICE07 checks for the presence of files that are part of applications that may not work when virtualized. This includes files
that are from applications such as SQL Server.

Corrective Action
If the unsupported application is not an important part of the product, or if it can be separately installed locally on target
systems, you can ignore this validation error.

See Also
InstallShield Virtualization Suitability Suite

ISVICE08
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE08 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• Server App-V

• ThinApp

• XenApp

InstallShield 2020 User Guide ISP-2600-UG00 1403

Chapter 4
Building, Testing, and Deploying Installations

Message (Error)
The file [1] appears to be a part of an application that is known to not be a good candidate for
virtualization.

[1] is the name of a file in the project.

Description
ISVICE08 checks for the presence of files that are part of applications that may not work when virtualized. This includes files
that are from applications such as antivirus software or server software such as Exchange Server.

Corrective Action
If the unsupported application is not an important part of the product, or if it can be separately installed locally on target
systems, you can ignore this validation error.

See Also
InstallShield Virtualization Suitability Suite

ISVICE09
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE09 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• ThinApp

• XenApp

Message (Error)
IIS [1] item [2] is included in the package. This is not supported by desktop application virtualization.

[1] is the name of a type of IIS item in the project, and [2] is the name of that item.

Description
ISVICE09 checks for the presence of InstallShield IIS support indicating that an ASP.NET or IIS application is installed.

Corrective Action
If the unsupported ASP.NET or IIS application is not an important part of the product, or if it can be separately installed
locally on target systems, you can ignore this validation error.

1404 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

See Also
InstallShield Virtualization Suitability Suite

ISVICE10
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE10 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• Server App-V

• ThinApp

• XenApp

Message (Error)
Component [1] contains a device driver installed through the MsiDriverPackages (DIFxApp) table. System-
level drivers such as print drivers or USB device drivers do not work from a virtualized
environment. It may be possible to extract this driver such that it can be installed locally on the
machine and allow the rest of the package to be virtualized.

[1] is the name of a device driver that is included in the project.

Description
ISVICE10 checks for the presence of drivers that are configured to be installed through the MsiDriverPackages table.

Corrective Action
If your end users may be interested in a virtualized version of your product, and if your InstallShield project contains a
driver, consider removing the driver from your project, and creating a separate installation for the driver. End users can
then install the driver locally to their machines before using a virtualized version of your product.

See Also
InstallShield Virtualization Suitability Suite

InstallShield 2020 User Guide ISP-2600-UG00 1405

Chapter 4
Building, Testing, and Deploying Installations

ISVICE11
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE11 is available for the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• ThinApp

• XenApp

Message (Warning for App-V 4.x and App-V 5.x; Error for ThinApp and XenApp)
This package contains no shortcuts. Shortcuts are usually necessary to define the entry point into the
virtual application.

Description
ISVICE11 checks the package to ensure that it contains at least one shortcut. Shortcuts provide the most visible entry
points for launching applications in a virtual package. Most virtual packages should have at least one shortcut.

Corrective Action
If the package is intended to be used as a dependency by a different virtual package, you can ignore this ISVICE.

If the package is intended to be used as a plug-in, it may be necessary to create a shortcut to the application for which this
is a plug-in.

If end users need to be able to launch the virtual application independently, consider adding a shortcut for the main
executable file.

See Also
InstallShield Virtualization Suitability Suite

ISVICE12
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

1406 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

ISVICE12 is available for the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• Server App-V

• ThinApp

• XenApp

Message (Error for App-V 4.x, App-V 5.x, ThinApp, and XenApp; Warning for Server App-
V)
This package contains a shell extension (key [1]). Shell extensions extend Windows Explorer and cannot
be loaded from a virtual package. This extension may be critical to the use of this application, and
if so this application will not function when virtualized. However, if this extension is non-
critical, the application can still be used.

[1] is the key of a shell extension that is included in the project.

Description
ISVICE12 checks for the presence of shell extensions.

Corrective Action
Evaluate how important the shell extension is to the product so that you can determine if it matters whether the shell
extension behaves as intended. If the shell extension is unimportant, it is probably safe to deploy a virtualized version of
the product with slightly reduced functionality. If the shell extension is important, a virtualized version of the product may
not function well.

See Also
InstallShield Virtualization Suitability Suite

ISVICE13
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE13 is available for the following virtualization technologies:

• App-V 4.x

• Server App-V

• ThinApp

• XenApp

InstallShield 2020 User Guide ISP-2600-UG00 1407

Chapter 4
Building, Testing, and Deploying Installations

Message (Warning)
This package registers a URL protocol (friendly name [1]).

[1] is the friendly name of a URL protocol.

Description
ISVICE13 checks for the presence of URL protocol handlers.

Corrective Action
Evaluate how important the registration of the URL protocol is to the product so that you can determine if it matters
whether the product behaves as intended. If the registration of the URL protocol is unimportant, it is probably safe to
deploy a virtualized version of the product with slightly reduced functionality. If the registration of the URL protocol is
important, a virtualized version of the product may not function well.

Consider performing validation to see if App-V 5.x is a suitable virtualization technology for your product, since it has
support for URL protocol handlers.

See Also
InstallShield Virtualization Suitability Suite

ISVICE14
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE14 is available for the following virtualization technologies:

• App-V 4.x

• Server App-V

• ThinApp

• XenApp

Message (Warning)
This package registers its capabilities in the Default Programs list (key '%1').

[1] is the name of the key that corresponds with registration information for an item in the Default Programs list.

Description
ISVICE14 checks for the presence of support for the Default Programs list.

1408 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Corrective Action
If the Default Programs list registration is not an important part of the product, you can ignore this validation error.

Consider performing validation to see if App-V 5.x is a suitable virtualization technology for your product, since it has
support for registering items in the Default Programs list.

See Also
InstallShield Virtualization Suitability Suite

ISVICE15
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE15 is available for the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• ThinApp

• XenApp

Message (Error)
This package contains a service (name [1]), which starts at boot time. Virtualized services are limited
to the lifetime of the virtual application so services that must start at boot time do not make good
candidates for virtualization. It may be possible to extract this service such that it can be
installed locally on the machine and allow the rest of the package to be virtualized.

[1] is the name of a service in the project.

Description
ISVICE15 checks for the presence of boot start services.

Corrective Action
Evaluate how important the service is to the product so that you can determine if it matters whether the product behaves
as intended. If the service is unimportant, it is probably safe to deploy a virtualized version of the product with slightly
reduced functionality.

If the service is important but you can separate it from the rest of the project, remove it from the project, and create a
separate installation for the service. End users can then install the service locally to their machines before using a
virtualized version of your product.

InstallShield 2020 User Guide ISP-2600-UG00 1409

Chapter 4
Building, Testing, and Deploying Installations

If the service is important but you cannot separate it from the rest of the project, a virtualized version of the product may
not function well.

See Also
InstallShield Virtualization Suitability Suite

ISVICE16
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE16 is available for the following virtualization technologies:

• App-V 4.x

• Server App-V

• XenApp

Message (Error)
This package contains more than 4 GB of files. Since the target virtualization technology has a 4 GB size
limit, this application cannot be successfully virtualized.

Description
ISVICE16 checks to ensure that the total installed file size is less than 4 GB. App-V 4.x, Server App-V, and XenApp do not
support packages that contain more than 4 GB of files.

Corrective Action
Consider performing validation to see if App-V 5.x or ThinApp are suitable virtualization technologies for your product,
since they support sizes larger than 4 GB.

See Also
InstallShield Virtualization Suitability Suite

ISVICE17
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

1410 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• MSI Database

ISVICE17 is available for the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• ThinApp

• XenApp

Message (Error)
This package contains COM+ data (component [1]), which is not supported, so the application may not work
correctly if virtualized.

[1] is the name of a component in the project; the component contains COM+ data.

Description
ISVICE17 checks for use of the Windows Installer COM+ tables.

Corrective Action
Evaluate how important the COM+ application is to the product so that you can determine if it matters whether the product
behaves as intended. If the COM+ application is unimportant, it is probably safe to deploy a virtualized version of the
product with slightly reduced functionality. If the COM+ application is important, a virtualized version of the product may
not function well.

See Also
InstallShield Virtualization Suitability Suite

ISVICE18
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE18 applies to the following virtualization technologies:

• App-V 4.x

• App-V 5.x

• ThinApp

• XenApp

InstallShield 2020 User Guide ISP-2600-UG00 1411

Chapter 4
Building, Testing, and Deploying Installations

Message (Error)
This package contains a COM DLL surrogate (registry key [1]), which is not supported, so the application
may not work correctly if virtualized.

[1] is the name of a registry key in the project.

Description
ISVICE18 checks for the presence of COM DLL surrogate files.

Corrective Action
Evaluate how important the COM DLL surrogate is to the product so that you can determine if it matters whether the
product behaves as intended. If the DLL surrogate is unimportant, it is probably safe to deploy a virtualized version of the
product with slightly reduced functionality. If the DLL surrogate is important, a virtualized version of the product may not
function well.

See Also
InstallShield Virtualization Suitability Suite

ISVICE19
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

ISVICE19 applies to the following virtualization technologies:

• ThinApp

• XenApp

Message (Error)
The package is 64-bit. ThinApp and XenApp do not support 64-bit applications.

Description
ISVICE19 checks to see if you are building a 64-bit package. ThinApp and XenApp do not support 64-bit applications.

Corrective Action
Consider performing validation to see if App-V or Server App-V is a suitable virtualization technology for your product, since
it has 64-bit support.

See Also
InstallShield Virtualization Suitability Suite

1412 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

InstallShield MSIX/UWP App Suitability Suite

InstallShield 2020

Project • This information applies to the Basic MSI project type.

InstallShield includes a set of validators called the InstallShield MSIX/UWP App Suitability Suite. The InstallShield Windows
App Suitability validators (ISUWPs) in this suite scan an .msi package for signs of items that are unsuitable for the Windows
App package (.appx) format. To access this suite, on the Build menu, point to Validation, and then click InstallShield
MSIX/UWP App Suitability Suite. The suite provides a report in the Releases view that indicates all tests that found issues
and for each issue, an associated column in the report indicates applicability to the known Windows App variants
(Universal App, Desktop Bridge, Windows Store, WSA, and Nano Server). For traditional CUBs, these columns are not
populated. The following ISUWP validations are available in InstallShield:

Table 4-20 • ISUWPs

ISUWP Project Type Technology Description

ISUWP01 Basic MSI Windows App Checks for the presence of Windows services.

ISUWP02 Basic MSI Windows App Checks for the presence of drivers installed with the
MsiDriverPackages table.

ISUWP03 Basic MSI Windows App Checks for the presence of shortcuts. InstallShield
requires shortcuts to identify applications. Without
shortcuts to identify applications, the package is
invalid as there are no ways to start your app.

ISUWP04 Basic MSI Windows App Checks for the presence of multiple shortcuts for
Windows Store applications. InstallShield turns
shortcuts into applications, and the Windows Store
may disallow multiple applications.

ISUWP05 Basic MSI Windows App Checks for the presence of shortcuts for Windows
Nano Server applications. InstallShield will turn any
shortcut into a tile if it points to an .exe installed by
the package; however Windows Nano Server cannot
display application tiles.

ISUWP06 Basic MSI Windows App Checks for the presence of 16-bit files. All server
installations are 64-bit platforms and 64-bit platforms
do not support 16-bit files..

ISUWP07 Basic MSI Windows App Checks for the presence of 32-bit files. All server
installations are 64-bit platforms and 64-bit platforms
do not support 32-bit files.

ISUWP08 Basic MSI Windows App Checks for the presence of applications that require
elevated privileges.

InstallShield 2020 User Guide ISP-2600-UG00 1413

Chapter 4
Building, Testing, and Deploying Installations

Table 4-20 • ISUWPs

ISUWP Project Type Technology Description

ISUWP09 Basic MSI Windows App Checks for the presence of applications that are
allowed to bypass UI protection levels.

ISUWP10 Basic MSI Windows App Checks for the presence of COM registration.

ISUWP11 Basic MSI Windows App Checks for the presence of executable files that set a
custom Application User Model ID.

ISUWP12 Basic MSI Windows App Checks for the presence of .NET assemblies that are
incompatible with Windows Nano Server.

ISUWP13 Basic MSI Windows App Checks for the presence of .NET assemblies that do
not support the latest version of .NET Framework.

ISUWP14 Basic MSI Windows App Checks for the presence of files that are part of
ASP.NET/IIS applications.

ISUWP15 Basic MSI Windows App Checks for the presence of InstallShield IIS support
indicating that an ASP.NET/IIS application is
installed.

ISUWP16 Basic MSI Windows App Checks for the presence of built-in InstallShield
support that executes SQL scripts.

ISUWP17 Basic MSI Windows App Checks for the presence of built-in InstallShield
support that modifies text files.

ISUWP18 Basic MSI Windows App Checks for the presence of built-in InstallShield
support that modifies XML files.

ISUWP19 Basic MSI Windows App Checks for the presence of built-in InstallShield
support that creates scheduled tasks.

ISUWP20 Basic MSI Windows App Checks for the presence of file type associations that
are reserved or forbidden.

See Also
Viewing Validation Results

ISUWP01
InstallShield 2020

ISUWP01 applies to Windows App scenarios.

1414 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Message (Error)
This package contains one or more Windows services. Windows App packages that target other devices than
Windows Server do not support Windows services.

Description
ISUWP01 checks for the presence of Windows services.

Corrective Action
If one or more Windows services are required by the application, then server extensions and WSA are required. Including
desktop extensions is not supported in this scenario.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP02
InstallShield 2020

ISUWP02 applies to Windows App scenarios.

Message (Error)
Component [1] contains a device driver installed through the MsiDriverPackages (DIFxApp) table. Windows
App packages do not support device drivers.

[1] is the name of a component in the project.

Description
ISUWP02 checks for the presence of drivers installed with the MsiDriverPackages table.

Corrective Action
If the driver is required, this application cannot be supported purely by Windows Apps.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP03
InstallShield 2020

ISUWP03 applies to Windows App scenarios.

Message (Warning)
This package contains no shortcuts. Shortcuts are usually necessary to define the entry point into the
application.

InstallShield 2020 User Guide ISP-2600-UG00 1415

Chapter 4
Building, Testing, and Deploying Installations

Description
ISUWP03 checks for the presence of shortcuts. InstallShield requires shortcuts to identify applications. Without shortcuts
to identify applications, the package is invalid as there are no ways to start your app.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP04
InstallShield 2020

ISUWP04 applies to Windows App scenarios.

Message (Warning)
This package contains more than one shortcut. Windows Store may not allow more than one application.

Description
ISUWP04 checks for the presence of multiple shortcuts for Windows Store applications. InstallShield turns shortcuts into
applications, and the Windows Store may disallow multiple applications.

Corrective Action
If you wish to distribute this application on the Windows Store, you may need to split the application into multiple
Windows App packages.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP05
InstallShield 2020

ISUWP05 applies to Windows App scenarios.

Message (Warning)
This package contains one or more shortcuts. Windows Nano Server cannot show application tiles.

Description
ISUWP05 checks for the presence of shortcuts for Windows Nano Server applications. InstallShield will turn any shortcut
into a tile if it points to an .exe installed by the package; however Windows Nano Server cannot display application tiles.

Corrective Action
This warning alerts you to a known item that may not function as expected.

See Also
InstallShield MSIX/UWP App Suitability Suite

1416 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

ISUWP06
InstallShield 2020

ISUWP06 applies to Windows App scenarios.

Message (Warning)
File [1] in Component [2] is a 16-bit file. 64-bit systems do not support 16-bit applications.

[1] is the name of a file in the project.

[2] is the name of a component in the project.

Description
ISUWP06 checks for the presence of 16-bit files. All server installations are 64-bit platforms and 64-bit platforms do not
support 16-bit files.

Corrective Action
A corrective action is only necessary if the file is loaded and executed at run-time. Data files that happen to be 16-bit or 32-
bit are not a problem. If the flagged 16-bit file is loaded and executed at run-time, replace it with a 64-bit file.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP07
InstallShield 2020

ISUWP07 applies to Windows App scenarios.

Message (Warning)
File [1] in Component [2] is a 32-bit file. 64-bit systems may not support 32-bit applications.

[1] is the name of a file in the project.

[2] is the name of a component in the project.

Description
ISUWP07 checks for the presence of 32-bit files. All server installations are 64-bit platforms and 64-bit platforms do not
support 32-bit files.

Corrective Action
A corrective action is only necessary if the file is loaded and executed at run-time. Data files that happen to be 16-bit or 32-
bit are not a problem. If the flagged 32-bit file is loaded and executed at run-time, replace it with a 64-bit file.

See Also
InstallShield MSIX/UWP App Suitability Suite

InstallShield 2020 User Guide ISP-2600-UG00 1417

Chapter 4
Building, Testing, and Deploying Installations

ISUWP08
InstallShield 2020

ISUWP08 applies to Windows App scenarios.

Message (Error)
File [1] in Component [2] is an application executable file that requires elevated privileges. Windows
Store does not allow applications that require administrative privileges.

[1] is the name of a file in the project.

[2] is the name of a component in the project.

Description
ISUWP08 checks for the presence of applications that require elevated privileges.

Corrective Action
Remove the requirement for elevated privileges. An app may be using elevated privileges to subvert best-practices about
handling files or registry keys, and such subversion will not work in a Windows App.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP09
InstallShield 2020

ISUWP09 applies to Windows App scenarios.

Message (Error)
File [1] in Component [2] is an application executable file that is allowed to bypass UI protection
levels to drive input to higher privilege windows on the desktop. Windows App packages do not
support applications that are allowed to bypass UI protection levels.

[1] is the name of a file in the project.

[2] is the name of a component in the project.

Description
ISUWP09 checks for the presence of applications that are allowed to bypass UI protection levels.

Corrective Action
Very few applications require bypassing UI protection levels, but those that do are not currently supported by Windows
Apps. If an application requires bypassing UI protection levels, consider using a different package format than a Windows
App package.

See Also
InstallShield MSIX/UWP App Suitability Suite

1418 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

ISUWP10
InstallShield 2020

ISUWP10 applies to Windows App scenarios.

Messages (Warnings)

Message 1 (Warning)
Table [1] contains one or more entries. Applications in Windows App packages cannot expose COM servers
to other applications.

[1] is a table in your project.

Message 2 (Warning)
Registry key [1] in Component [2] is COM data. Applications in Windows App packages cannot expose COM
servers to other applications.

[1] is the name of a registry key in the project.

[2] is the name of a component in the project.

Description
ISUWP10 checks for the presence of COM registration.

Corrective Action
COM registration may or may not be a problem. Internal use of COM is fully supported by the Desktop Bridge, but no
extension currently supports public registration (for use by other apps). If the latter is required, a Windows App package is
unsuitable.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP11
InstallShield 2020

ISUWP11 applies to Windows App scenarios.

Message (Error)
File [1] in Component [2] imports API [3]. Applications in Windows App packages are not allowed to set a
custom Application User Model ID.

[1] is the name of a file in the project.

[2] is the name of a component in the project.

[3] is the name of an API.

Description
ISUWP11 checks for the presence of executable files that set a custom Application User Model ID.

InstallShield 2020 User Guide ISP-2600-UG00 1419

Chapter 4
Building, Testing, and Deploying Installations

Corrective Action
Code-based removal of the offending API call is required. A Windows App will set an Application User Model ID for you.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP12
InstallShield 2020

ISUWP12 applies to Windows App scenarios.

Messages

Message 1 (Error)
File [1] in Component [2] is a .NET assembly that was compiled against .NET Framework. Windows Nano
Server supports only .NET Core applications

[1] is the name of a file in the project.

[2] is the name of a component in the project.

Message 2 (Error)
File [1] in Component [2] is a .NET assembly that was compiled against [3]. Windows Nano Server supports
only .NET Core applications.

[1] is the name of a file in the project.

[2] is the name of a component in the project.

[3] is the name of a framework in the project.

Description
ISUWP12 checks for the presence of .NET assemblies that are incompatible with Windows Nano Server.

Corrective Action
Rebuild your app against .NET Core if you want to support Nano Server.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP13
InstallShield 2020

ISUWP13 applies to Windows App scenarios.

Message (Warning)
File [1] in Component [2] is a .NET assembly that does not support the latest version of .NET Framework.
Windows Store applications always run on the latest version of .NET Framework.

1420 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

[1] is the name of a file in the project.

[2] is the name of a component in the project.

Description
ISUWP13 checks for the presence of .NET assemblies that do not support the latest version of .NET Framework.

Corrective Action
Rebuild or adjust your app.config.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP14
InstallShield 2020

ISUWP14 applies to Windows App scenarios.

Message (Error)
The file [1] appears to be a part of an ASP.NET/IIS application. This is not supported by applications
in Windows App package.

[1] is the name of a file in the project.

Description
ISUWP14 checks for the presence of files that are part of ASP.NET/IIS applications.

Corrective Action
Because files that are part of ASP.NET/IIS applications are not supported by Windows Apps, you will need to remove the file
from the package or use an alternative package format.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP15
InstallShield 2020

ISUWP15 applies to Windows App scenarios.

Message (Error)
IIS [1] item [2] is included in the package. This is not supported by applications in Windows App
packages.

[1] is the name of a type of IIS item in the project, and [2] is the name of that item.

InstallShield 2020 User Guide ISP-2600-UG00 1421

Chapter 4
Building, Testing, and Deploying Installations

Description
ISUWP15 for the presence of InstallShield IIS support indicating that an ASP.NET/IIS application is installed.

Corrective Action
Because files that are part of ASP.NET/IIS applications are not supported by Windows Apps, you need to remove the file
from the package or use an alternative package format.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP16
InstallShield 2020

ISUWP16 applies to Windows App scenarios.

Message (Error)
This package contains one or more SQL scripts that run during an installation. Windows App packages do
not support executing SQL scripts.

Description
ISUWP16 checks for the presence of built-in InstallShield support that executes SQL scripts.

Corrective Action
The flagged configuration must be moved from the installation to the application in order to support the use of a Windows
App package.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP17
InstallShield 2020

ISUWP17 applies to Windows App scenarios.

Message (Error)
This package contains one or more InstallShield Text File Changes items that are performed during an
installation. Windows App packages do not support modifying text files.

Description
ISUWP17 for the presence of built-in InstallShield support that modifies text files.

Corrective Action
The flagged configuration must be moved from the installation to the application in order to support the use of a Windows
App package.

1422 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP18
InstallShield 2020

ISUWP18 applies to Windows App scenarios.

Message (Error)
This package contains one or more InstallShield XML File Changes items that are performed during an
installation. Windows App packages do not support modifying XML files.

Description
ISUWP18 checks for the presence of built-in InstallShield support that modifies XML files.

Corrective Action
The flagged configuration must be moved from the installation to the application in order to support the use of a Windows
App package.

See Also
InstallShield MSIX/UWP App Suitability Suite

ISUWP19
InstallShield 2020

ISUWP19 applies to Windows App scenarios.

Message (Error)
This package contains one or more InstallShield Scheduled Tasks items that are performed during an
installation. Windows App packages do not support creating scheduled tasks.

Description
ISUWP19 checks for the presence of built-in InstallShield support that creates scheduled tasks.

Corrective Action
The flagged configuration must be moved from the installation to the application in order to support the use of a Windows
App package.

See Also
InstallShield MSIX/UWP App Suitability Suite

InstallShield 2020 User Guide ISP-2600-UG00 1423

Chapter 4
Building, Testing, and Deploying Installations

ISUWP20
InstallShield 2020

ISUWP20 applies to Windows App scenarios.

Message (Error)
Extension [1] in Component [2] is a file type that is reserved or forbidden for Windows App packages.

[1] is the name of an extension in the project and [2] is the name of the component it is in.

Description
ISUWP20 checks for the presence of file type associations that are reserved or forbidden.

Corrective Action
Remove the flagged reserved or forbidden file type associations in order to support the use of a Windows App package.

See Also
InstallShield MSIX/UWP App Suitability Suite

InstallShield Best Practice Suite

InstallShield 2020

Edition • The InstallShield Best Practice Suite is available in the Premier edition of InstallShield.

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Note that some of the ISBPs apply to only Basic MSI and MSI Database projects.

InstallShield includes a set of validators called the InstallShield Best Practice Suite. The InstallShield Best Practice (ISBP)
validators in this suite alert you if your installation violates best-practice guidelines.

The following table lists the ISBPs that are available in InstallShield.

Table 4-21 • ISBPs

ISICE Project Description

ISBP01 Basic MSI, Verifies that no feature is named “ALL”.

InstallScript MSI,
MSI Database

1424 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-21 • ISBPs (cont.)

ISICE Project Description

ISBP02 Basic MSI, Verifies that no directory is named “DATABASE”.

InstallScript MSI,
MSI Database

ISBP03 Basic MSI, MSI Verifies that no ComboBox is shorter than 50 units.
Database

ISBP04 Basic MSI, MSI Verifies that properties used on dialogs are secure or restricted public
Database properties.

ISBP05 Basic MSI, MSI Verifies that no ControlEvent condition is NULL.

Database

ISBP06 Basic MSI, Verifies that InstallUISequence custom actions are also sequenced in the
InstallScript MSI, InstallExecuteSequence.
MSI Database

ISBP07 Basic MSI, Verifies that all features have associated components and all components
InstallScript MSI, are associated with features.
MSI Database

ISBP08 Basic MSI, Verifies that ARPINSTALLLOCATION is set after CostFinalize in the
InstallScript MSI, InstallExecuteSequence.
MSI Database

ISBP09 Basic MSI, Verifies that LIMITUI is not set without ARPNOMODIFY.
InstallScript MSI,
MSI Database

ISBP10 Basic MSI, Verifies that AppSearch properties are secure or restricted public properties.
InstallScript MSI,
MSI Database

ISBP11 Basic MSI, Verifies that no precompiled .NET assemblies are being distributed.
InstallScript MSI,
MSI Database

ISBP12 Basic MSI, Verifies that no file is self-registered.

InstallScript MSI,
MSI Database

ISBP13 Basic MSI, MSI Verifies that properties set by dialog controls and used in the installation
Database have a default value.

InstallShield 2020 User Guide ISP-2600-UG00 1425

Chapter 4
Building, Testing, and Deploying Installations

Table 4-21 • ISBPs (cont.)

ISICE Project Description

ISBP14 Basic MSI, Verifies that each file has the correct version information or an MsiFileHash
InstallScript MSI, entry.
MSI Database

ISBP15 Basic MSI, MSI Verifies that no RadioButtonGroup has Text defined.
Database

ISBP16 Basic MSI, Verifies that each component with a 64-bit destination is marked as a 64-bit
InstallScript MSI, component.
MSI Database

ISBP17 Basic MSI, Verifies that no .hlp files or WinHelp run-time files are included in the
InstallScript MSI, installation.
MSI Database

ISBP18 Basic MSI, Verifies that no obsolete APIs are imported.

InstallScript MSI,
MSI Database

ISBP19 Basic MSI, Verifies that no deprecated APIs are imported.

InstallScript MSI,
MSI Database

ISBP20 Basic MSI, Verifies that no registry entries contained in the Registry table attempt to
InstallScript MSI, remove root-level registry keys (such as HKLM\Software) or other keys that
MSI Database would cause adverse issues on target machines.

See Also
Specifying Whether Validation Should Be Performed at Build Time
Validating an Installation Package or Merge Module
Requirements for the Windows Logo Program

ISBP01
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
Feature ALL conflicts with the installation meta-feature ALL.

1426 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Description
ISBP01 verifies that your installation does not have a feature called ALL in uppercase, lowercase, or mixed case letters. In
the context of features, Windows Installer reserves the word ALL for use as a valid value for feature-state properties such as
ADVERTISE, REINSTALL, and ADDLOCAL, which can contain the names of specific features, as well as the word ALL to indicate
all features. Therefore, none of the individual features in a project should be called ALL.

Corrective Action
To resolve this error, change the name of the feature to something other than ALL. For more information, see Creating
Features.

You can also resolve this error by clicking the ISBP01 error message in the Output window. InstallShield displays the
Feature table in Direct Editor view, and highlights the row that contains the feature named ALL. To rename the feature,
select the current name and then type a new one.

See Also
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP02
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
Directory DATABASE conflicts with Windows Installer's undocumented directory DATABASE.

Description
ISBP02 verifies that your installation does not have a directory called DATABASE in uppercase, lowercase, or mixed case
letters. Windows Installer reserves this directory name.

Corrective Action
To resolve this error, click the ISBP02 error message in the Output window. InstallShield displays the Directory table in
Direct Editor view, and highlights the row that contains the directory named DATABASE. To rename the directory, select
the current name and then type a new one.

See Also
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

InstallShield 2020 User Guide ISP-2600-UG00 1427

Chapter 4
Building, Testing, and Deploying Installations

ISBP03
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• MSI Database

Message (Warning)
ComboBox [1] on Dialog [2] has a height less than 50. This results in a ComboBox too short to view
multiple items at once.

[1] is the name of a combo box control, and [2] is the name of the dialog that has that control.

Description
If a combo box control has a height of less than 50 installer units, end users may be able to see only one item in the box at a
time. To improve the usability, consider changing the height to 50 or higher.

Corrective Action
To resolve this warning, click the ISBP03 warning message in the Output window. InstallShield displays the Control table
in Direct Editor view, and highlights the row that contains the combo box control. Then change the value in the Height
column for that control to 50 or higher.

See Also
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP04
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• MSI Database

Messages

Message 1 (Warning)
Dialog [1] Control [2] uses private property [3]. Its value will be unavailable to the execute sequence.

[1] is the name of a dialog in your project, [2] is the name of a control on that dialog, and [3] is the name of a private
property that is being set or used by the control.

1428 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Message 2 (Warning)
Dialog [1] Control [2] uses insecure custom property [3]. Its value may be unavailable to the execute
sequence.

[1] is the name of a dialog in your project, [2] is the name of a control on that dialog, and [3] is the name of a property that is
used by that control.

Description
You cannot set a private property in the user interface sequence of the installation and then pass the value of that private
property to the execute sequence. Therefore, ISBP04 verifies that your installation does not have any dialog controls that
use private properties. If a dialog control does use a private property, warning 1 occurs to alert you that you may need to
take steps to allow a property’s value to be passed to the execute sequence.

In addition, if you set a public property in the user interface sequence of an installation that requests elevated privileges for
the execute sequence, and you want to pass the property’s value to the execute sequence, the property must be listed as a
value for the SecureCustomProperties property, or it must be a restricted public property. Therefore, ISBP04 also verifies
that if your installation has dialog controls that use custom public properties, the custom public properties are listed as
values for the SecureCustomProperties property. If the custom public properties are not listed in the
SecureCustomProperties property, warning 2 occurs to alert you that you may need to take steps to allow a property’s
value to be passed to the execute sequence.

Corrective Action
If you do not need to use the property in the execute sequence, you can disregard the warning message. However, if you do
need to use the property in this sequence, you need to resolve the warning.

If you need to resolve warning 1, change the private property to a public property. To do so, find the dialog control in the
Dialogs view; for the Property property of that control, use all uppercase letters, since public properties must be in all
uppercase. Also update all other instances of that property name in your project so that it matches.

If you need to resolve warning 2, open the Property Manager view. For the Value column of the SecureCustomProperties
property, add the name of the property that is mentioned in the warning message. If this property contains more than one
property, separate each one with a semicolon (;).

See Also
Private Properties (Windows Installer Help Library)
Private Properties (Windows Installer Help Library)
Public Properties (Windows Installer Help Library)
Public Properties (Windows Installer Help Library)
SecureCustomProperties Property (Windows Installer Help Library)
SecureCustomProperties Property (Windows Installer Help Library)
Specifying that a Public Property Should Be a Restricted Public Property
Property Manager View
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

InstallShield 2020 User Guide ISP-2600-UG00 1429

Chapter 4
Building, Testing, and Deploying Installations

ISBP05
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• MSI Database

Message (Warning)
Dialog [1] Control [2] has a NULL condition. To ensure the control event always runs, use a condition of
1.

[1] is the name of a dialog in your project, and [2] is the name of a control on that dialog.

Description
ISBP05 verifies that each event’s condition for each dialog control is not null. This helps to ensure that Windows Installer
triggers the control’s events under the proper circumstances.

Corrective Action
If Windows Installer should trigger the event that has a null condition only if no other event for that control is triggered, you
can disregard the warning message.

If you do need to resolve this warning, locate the dialog in the Dialogs view. Click the Behavior item under the dialog. In the
list of controls, click the one that is mentioned in the warning message. Ensure that in the lower-right pane, the Events tab
is displayed. Then, in the grid in the upper-right pane, enter a condition for the event. To ensure that Windows Installer
triggers the event, enter 1 as the condition.

See Also
ControlEvent Table (Windows Installer Help Library)
ControlEvent Table (Windows Installer Help Library)
Conditional Statement Syntax (Windows Installer Help Library)
Conditional Statement Syntax (Windows Installer Help Library)
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP06
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

1430 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Message (Warning)
Custom Action [1] is scheduled in the InstallUISequence but not the InstallExecuteSequence. It will not
run during a silent or reduced UI installation.

[1] is the name of a custom action in your project.

Description
Actions that are scheduled for the Execute sequence during the Installation sequence do not run during silent, basic UI, or
reduced UI installations.

Corrective Action
If Windows Installer should launch the custom action during silent, basic UI, and reduced UI installations, consider
scheduling the custom action for the installation execute sequence—in addition to or instead of the installation UI
sequence.

To reschedule the action, open the Custom Actions and Sequences view, and find the action mentioned in the warning
message. Then drag it from the Installation sequence’s User Interface sequence to the Installation sequence’s Execute
sequence.

To schedule the action in both sequences, copy the action in the Installation sequence’s User Interface sequence to the
Installation sequence’s Execute sequence. You can do this in the Custom Actions and Sequences view by pressing and
holding CTRL while dragging the action from the former sequence to the latter sequence.

If Windows Installer should not launch the custom action during silent, basic UI, and reduced UI installations, you can
ignore this warning.

See Also
Inserting Actions into Sequences
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP07
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Messages

Message 1 (Warning)
Feature [1] has no components.

[1] is the name of a feature in your project.

InstallShield 2020 User Guide ISP-2600-UG00 1431

Chapter 4
Building, Testing, and Deploying Installations

Message 2 (Warning)
Component [1] is not associated with any features.

[1] is the name of a component in your project.

Description
ISBP07 verifies that every component in your project belongs to at least one feature. If you do not associate a component
with at least one feature, Windows Installer cannot install the component.

ISBP07 also verifies that every feature in your project contains at least one component. Components contain the
installation elements, such as files, shortcuts, and registry entries; if a feature does not contain a component, it does not
contain anything to install.

Corrective Action
To resolve either of these warnings, use the Setup Design view to associate components with features. To learn more, see
Associating Existing Components with Features.

See Also
Installation Fundamentals
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP08
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Warning)
There does not appear to be a Type 51 action setting ARPINSTALLLOCATION after CostFinalize in the
InstallExecuteSequence.

Description
The ARPINSTALLLOCATION property specifies the fully qualified path to the primary destination folder of a product.
Windows Installer writes this value to the Uninstall registry key.

The ARPINSTALLLOCATION property is typically set by a set-a-property type of custom action (type 51).

The SetARPINSTALLLOCATION custom action is a built-in InstallShield custom action that is added automatically to Basic
MSI and InstallScript MSI projects. If you delete this custom action from your project, you may encounter the ISBP08
warning.

1432 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Corrective Action
To resolve this warning, add to your project a custom action with the following settings:

• Property Name: ARPINSTALLLOCATION

• Property Value: [INSTALLDIR]

• Execution Scheduling: Always execute

• Install Exec Sequence: After CostFinalize

Note • As a best practice, any actions after CostFinalize should be sequenced after MigrateFeatureStates when feature
migration is selected on a major upgrade item.

• Install Exec Condition: Not Installed

Leave the default values for all of the other settings.

For more information, see Creating Custom Actions in the Custom Actions and Sequences View (or the Custom Actions
View).

See Also
ARPINSTALLLOCATION Property (Windows Installer Help Library)
ARPINSTALLLOCATION Property (Windows Installer Help Library)
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP09
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
The property LIMITUI has been set, but ARPNOMODIFY has not. This can lead to undesirable behavior with
Add or Remove Programs.

Description
If you set the LIMITUI property in an installation, you should also set the ARPNOMODIFY property.

The LIMITUI property sets the user interface level to basic. An installation run with a basic UI typically displays only
progress messages to end users. It does not allow end users to select features or provide other feedback.

The ARPNOMODIFY property prevents end users from modifying the product through Add or Remove Programs.

InstallShield 2020 User Guide ISP-2600-UG00 1433

Chapter 4
Building, Testing, and Deploying Installations

Corrective Action
To resolve this error, add the ARPNOMODIFY property to your project through the Property Manager view, and set its value
to 1. For more information, see Creating Properties in Windows Installer–Based Projects.

See Also
User Interface Levels (Windows Installer Help Library)
User Interface Levels (Windows Installer Help Library)
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP10
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Warning)
AppSearch [1] uses insecure custom property [2]. Its value may be unavailable to the execute sequence.

[1] is the name of a system search in your project, and [2] is the name of a property that is used by that system search.

Description
If you set a public property in the user interface sequence of an installation that requests elevated privileges for the execute
sequence, and you want to pass the property’s value to the execute sequence, the property must be listed as values for the
SecureCustomProperties property, or it must be a restricted public property. Therefore, ISBP10 verifies that if the
AppSearch table in your project contains custom public properties, the custom public properties are listed as values for the
SecureCustomProperties property. If the custom public properties are not listed in the SecureCustomProperties
property, the warning occurs to alert you that you may need to take steps to allow a property’s value to be passed to the
execute sequence.

Corrective Action
If you do not need to use the property in the execute sequence, you can disregard the warning message. However, if you do
need to use the property in this sequence, you need to resolve the warning.

To resolve this warning, open the Property Manager view. For the Value column of the SecureCustomProperties property,
add the name of the property that is mentioned in the warning message. If this property contains more than one property,
separate each one with a semicolon (;).

1434 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

See Also
Property Manager View
Adding a System Search
SecureCustomProperties Property (Windows Installer Help Library)
SecureCustomProperties Property (Windows Installer Help Library)
AppSearch Table (Windows Installer Help Library)
AppSearch Table (Windows Installer Help Library)
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP11
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Warning)
File [1] appears to be a precompiled native image of a .NET assembly. This may decrease the efficiency
compared to precompiling on the target machine.

[1] is the name of a precompiled native image (.ni) of a .NET assembly.

Description
ISBP11 verifies that your project does not include a precompiled native image of a .NET assembly.

Corrective Action
To resolve this warning, replace the native image file mentioned in the message with the appropriate .NET assembly file.

If you want the assembly to be compiled to machine code during the installation, select Yes for the .NET Precompile
Assembly setting of the file’s component.

Precompilation, or just-in-time compilation, takes into account the fact that some code might never be called during
execution. It converts the assembly as it is needed during execution and stores the resulting native code so it is accessible
for subsequent calls. Precompiling on the target machine allows the process to take advantage of the exact architecture of
the machine on which it will be running.

See Also
Component Settings
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

InstallShield 2020 User Guide ISP-2600-UG00 1435

Chapter 4
Building, Testing, and Deploying Installations

ISBP12
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Messages

Message 1 (Error)
Custom Action [1] appears to invoke self-registration via RegSvr32. Best practices encourage authoring
COM and Registry table data into the installer package.

[1] is the name of a custom action in your project that may be registering a file through RegSvr32.exe at installation time.

Message 2 (Error)
File [1] is self-registered. Best practices encourage authoring COM and Registry table data into the
installer package.

[1] is the name of a file that is marked as self-registering.

Description
Although InstallShield lets you designate that a COM server is self-registering, the preferred method of registering a COM
server is to extract the COM information from the file at build time or design time; with this method, InstallShield writes the
COM class information to the Class, ProgID, and Registry tables of the .msi database. Self-registration has several
limitations; for details, see Self-Registering COM Servers.

Corrective Action
To resolve error 1, remove the custom action that is referenced in the error message, and configure COM extraction for the
file as appropriate.

To resolve error 2, configure COM extraction for the file as appropriate.

To learn more, see Extracting COM Information from a COM Server.

See Also
Traditional COM Registration
Registry-Free COM Registration
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

1436 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

ISBP13
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• MSI Database

Message (Error)
Property [1] has no default, is set by a dialog control, and is used in table [2]. This may not be
populated in a silent or reduced UI installation.

[1] is the name of a property in your project, and [2] is the name of the table that uses that property.

Description
In most cases, each property in the Property table should have a default value. The default value is used if end users run
the installation in silent, reduced UI, or basic UI mode.

Corrective Action
If you do not need to add a default value for the property, you can disregard the error message.

To resolve this error, open the Property Manager view. Enter a value in the Value column for the property that is specified in
the error message.

See Also
Property Manager View
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP14
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Messages

Message 1 (Error)
File [1] has neither a file version nor an MsiFileHash record. This may require the source package when
installing a patch.

[1] is the name of file in your project.

InstallShield 2020 User Guide ISP-2600-UG00 1437

Chapter 4
Building, Testing, and Deploying Installations

Message 2 (Error)
File [1] is recorded as version [2] but is actually version [3]. This may require the source package when
installing a patch.

[1] is the name of file in your project. [2] is the version number that is configured for the file, but [3] is the actual version
number.

Description
ISBP14 verifies that each file in the project has the correct version information or an MsiFileHash entry. Using the correct
version information in versioned files and MsiFileHash entries for unversioned files helps Windows Installer to detect and
eliminate unnecessary file copying. It also helps ensure that the source package is not required to apply a patch to an
earlier version of a product.

Corrective Action
To resolve error 1, consider adding the file version number to the file. If the file is an unversioned file, configure the file so
that a file hash is used.

InstallShield enables you to override a file’s version information. Error 2 may occur if the file’s properties were overridden.
To resolve this error, consider removing the version override.

To configure the settings for a file, open the Files and Folders view. In the Destination computer’s files pane, locate the
file, right-click it, and click Properties. The Properties dialog box opens, enabling you to configure version information and
specifying whether file hashing should be used.

See Also
File Properties Dialog Box
File Table (Windows Installer Help Library)
File Table (Windows Installer Help Library)
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP15
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• MSI Database

Message (Error)
Control [2] on the Dialog [1] is a borderless RadioButtonGroup with overlapping controls and data in the
Text column. This may cause repaint issues on some systems.

Description
ISBP15 verifies that if you have a borderless radio button group control on a dialog and one or more other controls overlap
the radio button group, the radio button group does not have anything specified for its Text attribute. If it does, it may
cause repaint issues for some versions of Windows Installer.

1438 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Corrective Action
To resolve this error, click the ISBP15 error message in the Output window. InstallShield displays the Control table in
Direct Editor view, and highlights the row that contains the radio button control that is mentioned in the error message.
Delete the string in the Text column for that radio button control.

As an alternative, you can change the radio button group control so that it uses a border. To do this, open the Dialogs view
and find the dialog mentioned in the error message. Click the radio button control, and change its Has Border property to
True.

See Also
RadioButtonGroup Control (Windows Installer Help Library)
RadioButtonGroup Control (Windows Installer Help Library)
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP16
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
Component [1] installed to 64-bit location [2] is not marked with the 64-bit component attribute. This
may allow files to be installed to an incorrect location.

[1] is the name of a component, and [2] is the destination folder for the component’s files.

Description
If a component is not configured to be 64 bit, Windows Installer may not install the component’s files to the appropriate 64-
bit location.

Corrective Action
To specify that a component is 64 bit, select Yes for the component’s 64-Bit Component setting.

For more information about the 64-Bit Component setting, as well as additional component settings, see Component
Settings.

See Also
Targeting 64-Bit Operating Systems
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

InstallShield 2020 User Guide ISP-2600-UG00 1439

Chapter 4
Building, Testing, and Deploying Installations

ISBP17
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Messages

Message 1 (Error)
File [1] in Component [2] is a WinHelp file and may not be distributed to Windows Vista or later.

[1] is the name of an .hlp file in your project, and [2] is the name of the component that contains the .hlp file.

Message 2 (Error)
File [1] in Component [2] is a WinHelp run-time file and may not be distributed to Windows Vista or
later.

[1] is the name of a Windows Help application file in your project, and [2] is the name of the component that contains that
file.

Description
ISBP17 verifies that .hlp files are not included in your project because Windows Vista and later do not support this type of
file.

In addition, ISBP17 verifies that WinHlp32.exe and WinHelp.exe are not included in the project because these applications
should not be redistributed.

Corrective Action
To resolve this validation error, remove the help file from your project. Consider converting your help system to a different
file format such as .chm, .htm, or .xml. Note that you would need to change your calls from the WinHelp API to the new help
system.

See Also
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP18
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI

1440 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

• InstallScript MSI
• MSI Database

Message (Error)
File [1] in Component [2] imports obsolete API [3].

[1] is the name of a file in your project, and [2] is the name of the component that contains the file. [3] is the name of the
obsolete API that the file uses.

Description
ISBP18 verifies that none of the .dll or .exe files in your project use obsolete kernel APIs.

Corrective Action
To resolve this validation error, replace the file with an updated version that does not use the obsolete API. Note that to
create the updated version, you may need to rewrite and rebuild the .exe or .dll file. If the .exe or .dll file is from a third-
party vendor, contact the vendor to request an updated version.

See Also
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP19
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Message (Error)
File [1] in Component [2] imports deprecated API [3].

[1] is the name of a file in your project, and [2] is the name of the component that contains the file. [3] is the name of the
deprecated API that the file uses.

Description
ISBP19 verifies that none of the .dll or .exe files in your project use deprecated kernel APIs.

Corrective Action
To resolve this validation error, replace the file with an updated version that does not use the deprecated API. Note that to
create the updated version, you may need to rewrite and rebuild the .exe or .dll file. If the .exe or .dll file is from a third-
party vendor, contact the vendor to request an updated version.

InstallShield 2020 User Guide ISP-2600-UG00 1441

Chapter 4
Building, Testing, and Deploying Installations

See Also
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

ISBP20
InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI
• MSI Database

Messages

Message 1 (Error)
Registry entry [1] contains an asterisk in the Name column. This will cause Windows Installer to attempt
to remove a root registry key [2].

[1] is the name in the Registry table’s Registry column for the registry entry row that has the asterisk (*). [2] is the name of
the registry key that would be removed during uninstallation.

Message 2 (Warning)
Registry entry [1] installs to a key that is not recommended for installation with software
applications. Installing this entry could have an adverse effect on target machines ([2]).

[1] is the name in the Registry table’s Registry column for the registry entry row that may cause issues on the target
system. [2] is the name of the registry key.

Description
ISBP20 verifies that your project does not include any registry entries that would remove root-level registry keys such as
HKEY_LOCAL_MACHINE\SOFTWARE if your product is removed from a target machine. The following table shows an
example of some registry data that would cause issues during uninstallation; in this example, the entire
HKEY_LOCAL_MACHINE\SOFTWARE, and all of its subkeys and values, would be removed.

Table 4-22 • Example of Registry Data that Triggers an ISBP20 Error

Valu
Registry Root Key Name e Component

Registry2 2 SOFTWARE * MyComponent

ISBP20 also verifies that your project does not include other registry entries that would cause adverse issues on target
machines.

1442 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Corrective Action
To resolve the validation error or warning, click the ISBP20 message in the Output window. InstallShield displays the
Registry table in Direct Editor view, and highlights the row that contains the potentially problematic registry entry. To
delete the registry entry, right-click the row and then click Drop Row(s).

See Also
Registry Table (Windows Installer Help Library)
Registry Table (Windows Installer Help Library)
Requirements for the Windows Logo Program
InstallShield Best Practice Suite

Understanding When an Installation or Uninstallation

Restarts the Target System
InstallShield 2020

Project • This information applies to the following project types:

• InstallScript
• InstallScript MSI—if the InstallScript user interface (UI) style is the traditional style (which uses the InstallScript engine as
an external UI handler)

This information does not apply to InstallScript MSI projects in which the InstallScript UI style is the new style (which uses the
InstallScript engine as an embedded UI handler). To learn more, see Using the InstallScript Engine as an External vs.
Embedded UI Handler for InstallScript MSI Installations.

The BATCH_INSTALL system variable is set to a non-zero value to indicate that one or more operations need to be
performed after the target system restarts. For example, BATCH_INSTALL can be set to a non-zero value if the installation
determines that a file cannot be installed because the file already exists on the target system and it is locked.

When a file in an installation cannot be installed because it is locked, the installation automatically notifies the operating
system that the file needs to be updated the next time that the system restarts. Because the file may need to be updated
before additional Windows files are loaded, it is updated when Windows is loaded; it is not updated by the InstallScript
installation.

BATCH_INSTALL can be set during an uninstallation in order to remove locked files after the system restarts. However,
after the reboot, the cached installation files are no longer present. Therefore, the only reboot-related operations that can
occur are those that the operating system can perform.

If BATCH_INSTALL is set to a non-zero value when the file transfer finishes, the following occurs:

• The installation does not attempt to self-register any files. This is because it may be necessary for all of the
installation’s files to be completely installed and updated before the files can be self-registered successfully. Note that
this is true regardless of whether the files that could not be installed are self-registering, since the installation assumes
that these files could be dependencies of other self-registering files. In this case, the installation records the files that
need to be self-registered so that after the restart, the installation can self-register those files.

• The framework automatically calls SdFinishReboot (in the OnFirstUIAfter or OnMaintUIAfter events) to give the end
user the option of automatically restarting the system after the installation completes.

InstallShield 2020 User Guide ISP-2600-UG00 1443

Chapter 4
Building, Testing, and Deploying Installations

• When the installation finishes, it creates an appropriate RunOnce registry value so that the installation runs after the
restart; after the restart, the installation is run with the /reboot parameter.

If the ALLUSERS script variable is set to 1, the RunOnce entry is created under HKEY_LOCAL_MACHINE; otherwise, the
entry is created under HKEY_CURRENT_USER. Windows supports RunOnce entries under both of these locations.

The RunOnce registry value’s name is InstallShield Setup %n, where %n is the lowest integer available to make a
unique key name. The registry value’s data is the complete command line for the installation to run after restart; the
command line includes the path and file name of Setup.exe.

After restart, the installation is run from the installed Disk1 location—DISK1TARGET. Thus, for the installation to run
after restart, the Disk1 files for the installation must be currently installed.

Note that this does not apply to an uninstallation, since after the restart, the cached installation files are no longer
present.

When the installation runs after the restart (that is, when it runs with the /reboot parameter), the following occurs:

• Any self-registering files that were noted by the installation as needing to be registered are registered.

• The OnRebooted event handler is called.

Note that for an uninstallation, the installation does not run after the restart; therefore none of these operations can occur.

See Also
BATCH_INSTALL

Debugging Windows Installer–Based Installations

InstallShield 2020

You can debug a Windows Installer–based release using the MSI Debugger. The MSI Debugger enables you to view and set
Windows Installer properties as you step through the package’s User Interface and Execute sequences.

The MSI Debugger runs through each action and dialog until it reaches your breakpoint, at which point it halts execution.
Now, you can view and set properties in the Watch window and the Variable window. Finally, you can step through each of
the remaining actions, or you can stop the debugger.

Note • Do not confuse the MSI Debugger with the InstallScript Debugger, since they have completely separate purposes. You
cannot debug an installation package with the InstallScript Debugger, and you cannot debug an InstallScript custom action
with the MSI Debugger.

See Also
MSI Debugger
Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties
User Interface Sequence
Execute Sequence

1444 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Starting the MSI Debugger

InstallShield 2020

Before starting the MSI Debugger, you must have built a release and opened the MSI Debugger view in InstallShield. In
addition, you should always set a breakpoint so that you can view the state of the installation at a particular action or
dialog.

When you open the MSI Debugger and begin debugging, it acts on the release that currently has focus in the Releases view.
If you have not yet built the release or if the release is compressed into Setup.exe, the debugger is blank and its toolbar
and menu items are disabled. Switch to a built release or rebuild with the required options to debug the package.

Task To start debugging, do one of the following:

• Click the MSI Debugging button on the MSI Debugger toolbar.

• Click the Step Over button on the MSI Debugger toolbar.

• On the Build menu, point to MSI Debugger and click Start MSI Debugging.

• On the Build menu, point to MSI Debugger and click Step Over.

• Press F5.

• Press F11.

The debugger runs the installation, returns focus to itself, and stops the execution of the installation when it reaches the
breakpoint. Back in the debugger, you can do any of the following:

• View and set Windows Installer properties.

• Step through the rest of the installation.

• Exit the debugger and/or the installation.

See Also
MSI Debugger
MSI Debugger Toolbar

Setting Breakpoints in the MSI Debugger

InstallShield 2020

Task To set a breakpoint in the MSI Debugger:

1. In the Releases view, select the release you want to debug.

2. Open the MSI Debugger view. The debugger displays two lists: first every standard and custom action in the User
Interface sequence, and then every dialog in the installation.

3. Place the cursor on the line that contains the action or dialog on which you want the debugger to break.

4. Do one of the following to set the breakpoint on that line:

• Click the Toggle Breakpoint button on the MSI Debugger toolbar.

InstallShield 2020 User Guide ISP-2600-UG00 1445

Chapter 4
Building, Testing, and Deploying Installations

• On the Build menu, point to MSI Debugger and click Toggle Breakpoint.

• Press F9.

You can set the breakpoint before you start debugging or while a debugging session is open.

When the debugger reaches the breakpoint, you can view and set properties or continue debugging.

Tip • Notice that the debugger lists the condition, if any, after each action. Set breakpoints carefully on conditional actions,
because if the condition does not evaluate to true, the action is not executed and the debugger will not step in at that point.

Removing Breakpoints
InstallShield 2020

Task To remove a breakpoint:

1. In the View List under Additional Tools, click MSI Debugger.

2. Place the cursor in a line with a breakpoint and click the Toggle Breakpoint button or press F9 to remove it.

Task To clear all breakpoints set in the debugger, do one of the following:

• Click the Remove All Breakpoints button.

• Press SHIFT+F9.

Viewing and Setting Properties in the MSI Debugger

InstallShield 2020

When the debugger stops at a breakpoint or at an action or dialog because you are stepping through the installation, you
can view Windows Installer properties and change their values at run time in the Watch window or the Variable window.

The Variable Window

The Variable window displays every property in the database’s Property table—exposed in InstallShield through Property
Manager View—and its current value.

To change a property’s value as the installation is running, edit the Property Value column.

If you do not see the Variable window, click Variable on the View menu.

The Watch Window

You can enter the name of any property in the Watch window to check its value at any point in the installation. For example,
enter TARGETDIR in the name column to see what TARGETDIR resolves to at run time.

To change the property’s value as the installation is running, edit the Property Value column.

If you do not see the Watch window, click Watch on the View menu.

1446 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

See Also
MSI Debugger

Step Into Actions in the MSI Debugger

InstallShield 2020

You can debug your code when you step into the custom action in the MSI Debugger. You can launch your registered
debugger when you step into one of the following types of custom actions:

• Windows Installer .dll file custom action

• Standard .dll file custom action

• Visual Basic Script or JavaScript custom action

• InstallScript custom action

Task To step into the current action in the MSI Debugger, do any of the following:

• Click the Step Into button on the MSI Debugger toolbar.

• On the Build menu, point to MSI Debugger and click Step Into.

• Press F11.

A dialog box opens and asks if you want to launch your registered debugger. Select Yes to launch the deubugger. Select No
to step over to the next custom action.

Note • Because InstallShield does not provide the source code for the entry point, you will see some machine code once the
registered debugger is launched. You need to click the Step Into button twice to see your code.

See Also
MSI Debugger
MSI Debugger Toolbar

Step Through Actions in the MSI Debugger

InstallShield 2020

Task To step over the current action or dialog and continue the execution in the MSI Debugger, do any of the following:

• Click the Step Over button on the MSI Debugger toolbar.

• On the Build menu, point to MSI Debugger and click Step Over.

• Press F10.

Once the debugger reaches a breakpoint on a standard or custom action, it halts the execution of the installation and
receives focus. You can then watch and set installer properties.

InstallShield 2020 User Guide ISP-2600-UG00 1447

Chapter 4
Building, Testing, and Deploying Installations

To continue stepping through each successive action, keep pressing F10. You may need to click Next on each dialog in the
Setup wizard to progress through the sequence. To view the return value of an action, place the cursor over the action after
it has executed. The return value is displayed as a tooltip. If the action executed successfully, the tool tip reads
ERROR_SUCCESS.

Although setting a breakpoint on an action causes the debugger to break at each subsequent action, setting a breakpoint
on a dialog takes you just to that dialog and then the debugger does not step in again until the next breakpoint.

See Also
MSI Debugger
MSI Debugger Toolbar

Stopping the MSI Debugger

InstallShield 2020

Task To discontinue debugging a release, do one of the following:

• Click the Stop Debugger button on the MSI Debugger toolbar.

• On the Build menu, point to MSI Debugger and click Stop MSI Debugging.

• Press SHIFT+F5.

If the debugger is stopped at a break point on a dialog when you try to end the debugging session, InstallShield displays a
message box with this message: “Please close all the dialogs to stop the debugging session.” To close any open dialogs,
first press F11 to step over the current breakpoint. Then, close any open dialogs.

Canceling out of the installation also stops the debugger.

See Also
MSI Debugger
MSI Debugger Toolbar

Spanning Installations over Multiple Disks or CDs

InstallShield 2020

As programs become larger, the need for disk spanning increases. Years ago, this meant shipping your product on multiple
floppy disks. The standard is now to use CD-ROMs or DVDs. Although the storage space on a CD or on a DVD is significantly
more than what is available on a floppy disk, many products require even more space. Multimedia tutorials, vast help
libraries, and graphic-rich programs can result in a product that is larger than 650 MB—the size of a standard CD.

If your installation requires more than one CD, DVD, or custom-sized media disk, you need to span it across multiple disks.

Using the Release Wizard

The only way to define how your installation spans across multiple disks is to use the Release Wizard. The wizard’s panels
walk you through the process of creating your release for any size media that you choose, and it lets you specify how your
files will span across multiple disks. You can also specify the compression to apply to these files.

1448 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

The wizard offers you the choice of having InstallShield automatically span your installation across disks, if necessary, or
you can customize how you want your installation files to be split. If you plan on customizing the way your installation
spans across multiple disks, refer to Disk Spanning Rules to reduce problems with your installation.

Limitations
Due to limitations of the Windows Installer service, you cannot run multi-disk installations on a non-removable drive. For
example, if your installation spans two CDs, you need to physically burn the CDs in order to test your installation. If you try
to run it from a fixed drive, the installation will fail.

Compressing Multi-Disk Installations

InstallShield 2020

Because neither Setup.exe nor your .msi file can be spanned across multiple disks, your source files need to be kept
separate from these files. If you create a network installation, which has unlimited size, and specify that all the files should
be compressed, these files are placed inside the .msi file or inside Setup.exe if you elected to create one. All other media
types put Setup.exe, your .msi file, and the .cab files that contain all of your source files separately on the media.

For example, you might have an installation that contains three features—each containing a 1.5 MB file, Setup.exe, and the
installation files for Windows NT—and you want to create a custom media type that is 2 MB in size. The build will span
multiple disks. Disk one will contain Setup.exe, InstMsiW.exe (which contains the logic to install the Windows Installer
service on Windows NT machines), Setup.ini (which is required for installations that include Setup.exe), and your .msi
file. The remaining disks will contain .cab files that store compressed copies of all your source files.

Disk Spanning Rules

InstallShield 2020

You can elect to have the Release Wizard automatically span your installation across as many disks as required. The wizard
adheres to the following rules, which all multi-disk installations must follow. If you plan to customize how your installation
spans across multiple disks, follow these rules:

• Setup.exe must be on disk one. This rule is applicable if you want to ship your installation on floppy disks and you
need to ship Setup.exe. The size of Setup.exe—depending on whether you choose one for Windows 9x, Windows NT,
or both—can be 1.31 MB to 2.58 MB in size. The installation file for the Windows Installer service is included in the build
as well. This file—called InstMsiW.exe or InstMsiA.exe, depending on the platform you choose—must also reside on
disk one.

• The second file that must be included on disk one is the .msi file that you are building. The total combined size of
the .msi file, Setup.exe, and the Windows Installer installation files exceeds the maximum capacity of a standard 1.4
MB floppy disk. You have two options if you plan to distribute your setup on floppy disks:

• You can distribute your installation without Setup.exe. This option is not available if you are creating an
InstallScript MSI project.

• The second and most feasible option is to use a distribution medium other than floppy disks.

• Any transforms included in your installation must reside on the first disk. For example, if you create an
installation with multiple run-time languages, an .mst file is created for each of those languages. This file is applied to
the installation database, and it provides the language selected in the Language Selection dialog.

InstallShield 2020 User Guide ISP-2600-UG00 1449

Chapter 4
Building, Testing, and Deploying Installations

• Redistributables (including merge modules) included in your installation must be stored on the first disk.
Redistributables are streamed into the installation database while the script is built. This process cannot be
completed if the redistributables are located on another disk.

Custom Disk Spanning

InstallShield 2020

In the Release Wizard, you will come across a panel that asks you how you would like to handle disk spanning. You can
choose to let the wizard automatically span your installation across disks if necessary, or you can manually define the disk
spanning. Although you cannot indicate where every file is placed, you can define the disk on which each feature resides.
Components and files are automatically placed on the same disk as their feature. There are other guidelines that
InstallShield automatically follows, whether you choose to define the layout or let the wizard do it for you.

In addition to defining the features that reside on each disk, you can customize the volume label for each disk, create your
own disk prompts, and choose to have the wizard enforce the size of your disks. The step-by-step instructions for
customizing your disk layout are outlined in the Release Wizard documentation.

Disk Prompts
Disk prompts are displayed to end users when they need to place another disk in the drive to continue with the installation.
Although a standard disk prompt is provided, you can provide a prompt that is specific to your product.

The string that is displayed actually comes from a number of sources throughout your project, as described below:

1. The complete prompt originates in the Error table (exposed in the Direct Editor) as error 1302.

2. This value comes from the project’s list of string entries, and the default value for English is “Please insert the disk:
[2].”

3. Windows Installer resolves [2] with the value of the property DiskPrompt, which is set to [1] in the Property Manager.

4. Finally, Windows Installer evaluates [1] to the string you enter into the Disk Prompt field.

In most cases, you will want to enter the same name as the disk volume. For example, assuming the defaults are
unchanged, a Disk Prompt entry of Disk8 would cause the user to be prompted with “Please enter the disk: Disk8.”

You can use a question mark where the disk number will be displayed. This question mark automatically evaluates to the
correct disk number. If you want to prompt your users with, “Please insert the disk: DISK4,” you would enter DISK? for the
fourth disk’s name. You need to specify the disk prompt for each disk in your installation.

Volume Labels
The volume label is the name of the disk on which your installation resides. When the installation calls for a new disk, the
Windows Installer engine verifies that the volume label of the disk matches the volume label that is stored in the
installation database. If the labels do not match, the service assumes that the wrong disk has been inserted in the drive.
You can change the volume label when you customize your disk spanning options. The default volume label is DISK1,
DISK2, DISK3, and so on. When you build your installation, you will see these directories created in your output location.
The disks on which you put your setup need to have the volume labels set to the same names as given by the wizard.

Caution • You cannot change a volume label after the installation has been built. If you do not specify the correct volume
label, the Windows Installer service will not recognize the disk and the installation will fail.

1450 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

You can use a question mark to define the number of the disk. For example, if you want to set the volume label for your
disks to InstallShield Disk 1, InstallShield Disk 2, and so on, you would rename every disk so that they read
InstallShield Disk ?. At build time, this question mark evaluates to the disk number.

Enforce Disk Size

The Enforce Disk Size option helps you to ensure that your current layout fits on the disks that you have specified. If this
option is not selected, and any disk that you want to create goes over the size of the media that you selected, the wizard
automatically creates another disk and splits your features accordingly. If you select this option and the disk size exceeds
the media size, the build will fail and you will receive build error 1531. You can then go back and trim down your feature size
or try a different layout strategy.

Additional Information
If you add features to your installation after you have defined how you want your installation to span across multiple disks,
those features are automatically added to the last disk of your installation. You can add new disks to your installation at
any time by using the Release Wizard.

Creating a Setup Launcher

InstallShield 2020

Project • This information applies to the following project types:

• Basic MSI
• InstallScript MSI

Note that InstallScript installations always include a setup launcher.

Advanced UI and Suite/Advanced UI installations also always creates a setup launcher; they run .msi, .msp, InstallScript, and
.exe packages. To learn more, see Creating Advanced UI and Suite/Advanced UI Installations.

InstallShield lets you specify whether you want your installation to include a Setup.exe setup launcher. A Setup.exe setup
launcher is required in the following cases:

• You want to automatically update or install the Windows Installer engine on a target system, when necessary.

• You are building a multilanguage installation project and you want the language selection dialog to be displayed.

• Your project includes InstallShield prerequisites.

• Your project includes the .NET Framework.

• You are building a release for an InstallScript MSI project and it uses the traditional style for the user interface.

• You are building a release whose product configuration includes support for installing multiple instances of a product
and you want the instance selection dialog to be displayed when appropriate.

• You are building a release for a Basic MSI project that includes billboards.

The Setup.exe setup launcher is a bootstrap application that manages the aforementioned scenarios.

The Setup.exe tab for a release in the Releases view is where you specify information such as whether you want to use a
Setup.exe launcher. To learn more, see Setup.exe Tab for a Release.

InstallShield 2020 User Guide ISP-2600-UG00 1451

Chapter 4
Building, Testing, and Deploying Installations

Tip • You can also specify setup launcher requirements in the Setup Launcher panel of the Release Wizard.

Windows Installer and Setup.exe

If it is possible that Windows Installer is not present on a target system, or if your installation depends on certain
functionality that is available in only a certain version of Windows Installer, InstallShield gives you the option of including
with your installation a redistributable that installs Windows Installer. If you select this option, InstallShield creates a
Setup.exe launcher that checks for the presence of Windows Installer on the target system. If Windows Installer is not
installed, or a more recent version needs to be installed, Setup.exe launches the Windows Installer installation and then
launches your installation package.

For more information, see Adding Windows Installer Redistributables to Projects.

Multilanguage Support and Setup.exe

Depending on your selections in the language-related settings on the Build tab for a release in the Releases view,
Setup.exe also gives end users a choice of the language in which to run the installation.

If you plan to distribute your installation in more than one language, Setup.exe is required whenever you want to provide
end users the option of selecting which language version of the installation they would like to run. To learn more about
multilanguage support, see Creating Multilingual Installations.

InstallShield Prerequisites and Setup.exe

Projects that include InstallShield prerequisites require Setup.exe because Setup.exe checks to see if the target system
meets the InstallShield prerequisite conditions. If the conditions are met, Setup.exe installs the InstallShield prerequisites.
For more details, see Working with InstallShield Prerequisites that Are Included in Installation Projects.

.NET Framework and Setup.exe

Projects that include the .NET Framework require Setup.exe because Setup.exe checks the target system for the presence
of the .NET Framework; if the appropriate version of the .NET Framework is not present, Setup.exe installs it.

To learn more about including the .NET Framework, see Adding .NET Framework Redistributables to Projects.

InstallScript MSI Projects and Setup.exe

The traditional-style InstallScript MSI installations require Setup.exe because Setup.exe initiates the InstallScript engine
to display the user interface. For this traditional style, the InstallScript engine serves as an external UI handler.

Note that if you use the new style of UI for an InstallScript MSI installation, InstallShield embeds the InstallScript engine
within the .msi package, and a setup launcher is not required.

For detailed information about these two styles, see Using the InstallScript Engine as an External vs. Embedded UI Handler
for InstallScript MSI Installations.

Multiple-Instance Support and Setup.exe

If you are configuring your product to allow end users to install your product multiple times in each context on a target
system, the Setup.exe setup launcher must be used if you want the instance selection dialog to be displayed when
appropriate. The Setup.exe file displays the instance selection dialog.

1452 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

To learn more about multiple-instance support, see Installing Multiple Instances of Products.

Billboards and Setup.exe

Basic MSI projects that include billboards require Setup.exe because Setup.exe displays the billboards at run time.

For more information about billboards, see Displaying Billboards in Basic MSI Installations.

Customizing File Properties for the Setup Launcher

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI
• InstallScript
• InstallScript MSI
• Suite/Advanced UI

Note that project-specific differences are noted where applicable.

InstallShield lets you use custom information for the version resources of the Setup.exe setup launcher. The information is
displayed on the Properties dialog box for the setup launcher; this Properties dialog box opens when end users right-click
the Setup.exe file and then click Properties.

Settings in InstallShield that Let You Configure Setup.exe Properties

The following table lists various properties that Windows includes on the Properties dialog box, along with the
corresponding settings in InstallShield that you can use to configure them.

Note • The Properties dialog box is different on different versions of Windows. For example, on Windows 7 systems, the
version resource information is displayed on the Details tab of the Properties dialog box. However, on Windows XP systems, the
version resource information is displayed on the Version tab of that dialog box.

InstallShield 2020 User Guide ISP-2600-UG00 1453

Chapter 4
Building, Testing, and Deploying Installations

Also note that some versions of Windows do not show some settings on the Properties dialog box.

Table 4-23 • Source of Information for Setup.exe Properties

Setup.exe Property InstallShield Setting that Configures the Setup.exe Property

Company Name The setting that contains the value for this field varies, depending on the
project type that you are using.

• In Basic MSI and InstallScript MSI projects: Publisher setting in the General
Information view.

• In InstallScript projects: Company Name setting in the General

Information view.

• In Advanced UI and Suite/Advanced UI projects: InstallShield uses either a

custom value that you provide, or a default InstallShield-specific name.

If you want InstallShield to use your own custom value for the company field in
an Advanced UI or Suite/Advanced UI project:

1. In the Releases view, select the release that you want to configure.

2. On the Setup.exe tab, in the Use Custom Version Properties setting,

select Yes.

3. In the Company setting, enter the text that you want to use for the
company field in the properties of your Setup.exe file.

If you select No for the Use Custom Version Properties setting or you leave the
Company setting blank, InstallShield uses the Publisher setting in the General
Information view. If that setting is blank, InstallShield uses the default
InstallShield-specific name.

Product Name The setting that contains the value for this field varies, depending on the
project type that you are using.

• In Basic MSI and InstallScript MSI projects: Product Name setting for the
product configuration in the Releases view. If that setting is blank,
InstallShield uses the Product Name setting in the General Information
view.

• In Advanced UI, InstallScript, and Suite/Advanced UI projects: Product

Name setting in the General Information view.

1454 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-23 • Source of Information for Setup.exe Properties (cont.)

Setup.exe Property InstallShield Setting that Configures the Setup.exe Property

Product Version The setting that contains the value for this field varies, depending on the
project type that you are using.

• In Basic MSI and InstallScript MSI projects: Product Version setting for the
product configuration in the Releases view. If that setting is blank,
InstallShield uses the Product Version setting in the General Information
view.

• In InstallScript projects: Product Version setting in the General

Information view.

• In Advanced UI and Suite/Advanced UI projects: Product Version setting in

the General Information view. You can use the Releases view to override
this value.

If you want to override the value in the General Information view in an

Advanced UI or Suite/Advanced UI project:

1. In the Releases view, select the release that you want to configure.

2. On the Setup.exe tab, in the Use Custom Version Properties setting,

select Yes.

3. In the Version setting, enter the value that you want to use for the version
fields in the properties of your Setup.exe file.

If you select No for the Use Custom Version Properties setting or you leave the
Version setting blank, InstallShield uses the Version setting in the General
Information view. If that setting is blank, InstallShield uses the default
InstallShield-specific values.

InstallShield 2020 User Guide ISP-2600-UG00 1455

Chapter 4
Building, Testing, and Deploying Installations

Table 4-23 • Source of Information for Setup.exe Properties (cont.)

Setup.exe Property InstallShield Setting that Configures the Setup.exe Property

File Version The setting that contains the value for this field varies, depending on the
project type that you are using.

• In Basic MSI, InstallScript MSI, InstallScript: Use the File Version setting
for Setup.exe under Use Custom Version Properties in Releases view.

If this setting is blank, InstallShield uses the Product Version value by default.

Note • The File Version always contains four fields. If you specify fewer than four
fields for your File Version, the remaining fields are filled with zeros. For example,
if you specify a File Version of 1.1, the File Version that is used in the version
resources of Setup.exe is 1.1.0.0.

If you want to override the File Version, set Use Custom Version Properties to
Yes and enter a version in the File Version field.

1. In the Releases view, select the release that you want to configure.

2. On the Setup.exe tab, set the Use Custom Version Properties setting to
Yes.

3. In the File Version field, enter the value that you want to use for the File
Version field in the Properties of your Setup.exe file.

If you select No for the Use Custom Version Properties setting or you leave
the File Version setting blank, InstallShield uses the File Version setting in the
Product Version from the Product Configuration view for both (Basic MSI and
InstallScript MSI) and in the General Information view for InstallScript. If that
setting is blank, InstallShield uses the default InstallShield-specific values.

Copyright InstallShield uses either a custom value that you provide, or the default
InstallShield copyright notice.

If you want InstallShield to use your own custom value for the copyright field:

1. In the Releases view, select the release that you want to configure.

2. On the Setup.exe tab, in the Use Custom Version Properties setting,

select Yes.

3. In the Launcher Copyright setting, enter the text that you want to use for
the copyright field in the properties of your Setup.exe file.

If you select No for the Use Custom Version Properties setting or you leave the
Launcher Copyright setting blank, InstallShield uses the default InstallShield
copyright notice.

1456 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Table 4-23 • Source of Information for Setup.exe Properties (cont.)

Setup.exe Property InstallShield Setting that Configures the Setup.exe Property

File Description InstallShield uses either a custom value that you provide, or the default
InstallShield Setup.exe description.

If you want InstallShield to use your own custom value for the description field:

1. In the Releases view, select the release that you want to configure.

2. On the Setup.exe tab, in the Use Custom Version Properties setting,

select Yes.

3. In the File Description setting, enter the text that you want to use for the
description field in the properties of your Setup.exe file.

Project • In an Advanced UI, InstallScript, or Suite/Advanced UI project—If you

select No for the Use Custom Version Properties setting or you leave the File
Description setting blank, InstallShield uses the default InstallShield Setup.exe
description.

In a Basic MSI or InstallScript MSI project—If you select No for the Use Custom
Version Properties setting, InstallShield uses the default InstallShield Setup.exe
description. If you select Yes but leave the File Description setting blank,
InstallShield uses the value for the Comments setting of the product
configuration in the Releases view. If that setting is blank, InstallShield uses the
Summary Information Stream Comments setting in the General Information
view. If that setting is blank, InstallShield uses the default InstallShield
Setup.exe description.

Language For this field, InstallShield uses the language that is specified in the Default
Language setting for the release in the Releases view that you are building.

Original File Name InstallShield uses either a custom value that you provide, or the default
InstallShield file name - Setup.exe.

If you want InstallShield to use your own custom value for the Original File
Name field:

1. In the View List under Media, click Releases.

2. Right-click the Releases explorer and then click New Product

Configuration.

InstallShield adds a new product configuration to the Releases explorer.

InstallShield lists the product configuration settings on the General tab.

3. On the General tab, in the Setup File Name setting, enter the text that
you want to use for the Original File Name field.

Specify the file name - without the .exe file extension - that InstallShield should
use for the Original File Name that it generates at build time.

InstallShield 2020 User Guide ISP-2600-UG00 1457

Chapter 4
Building, Testing, and Deploying Installations

Sample Setup.exe Properties Dialog Boxes

Figure 4-1: Sample Properties for Setup.exe on a Windows 7 Machine

1458 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Figure 4-2: Sample Properties for Setup.exe on a Windows XP Machine

See Also
Creating a Setup Launcher
Creating Advanced UI and Suite/Advanced UI Installations
General Information View Settings
Release Settings
Product Configuration Settings

Specifying the Icon for the Setup Launcher

InstallShield 2020

Project • This information applies to the following project types:

• Advanced UI
• Basic MSI

InstallShield 2020 User Guide ISP-2600-UG00 1459

Chapter 4
Building, Testing, and Deploying Installations

• InstallScript
• InstallScript MSI
• Suite/Advanced UI

InstallShield lets you specify the icon that should be used for your Setup.exe setup launcher. The icon can be in an .exe,
.dll, or .ico file.

End users can see this icon when they view your Setup.exe file in Windows Explorer. The icon is also displayed on the
Properties dialog box for Setup.exe; this Properties dialog box opens when end users right-click the Setup.exe file and
then click Properties.

If you do not specify an icon, InstallShield uses a default icon for your Setup.exe file.

Task To specify the icon for your Setup.exe file:

1. In the View List under Media, click Releases.

2. In the Releases explorer, select the release that you want to configure.

3. Click the Setup.exe tab.

4. In the Setup.exe Icon File setting, specify the fully qualified name of the file that contains the icon that InstallShield
should use when it creates the Setup.exe file at build time.

To specify a file, type an explicit path or path variable, or click the ellipsis button (...) to open the Change Icon dialog
box, in which you can click the Browse button to select a file.

By default, the icon with index 0 is used; to specify a different icon, either select an icon in the Change Icon dialog box
or append the icon’s index or resource ID (preceded by a minus sign) to the file name. For example,
C:\Temp\MyLibrary.dll,2 indicates the icon with an index of 2, and C:\Temp\MyLibrary.dll,-100 indicates the icon
with a resource ID of 100.

The next time that you build the release, InstallShield uses the icon that you specified for your Setup.exe file.

See Also
Creating a Setup Launcher
General Information View Settings
Release Settings
Product Configuration Settings

Distributing Installations
InstallShield 2020

Once you have created your installation, you may need to distribute it to a specified location. This location can be a
network drive, a CD, a different location on a local drive, or an FTP site. When you distribute your installation, the disk
image created when you built your installation is copied to the location that you specify.

1460 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Distributing Releases to a Folder or FTP Site Automatically

InstallShield 2020

When your release is built and tested, the only remaining task is to distribute it to the appropriate location. You can
manually copy your release to the appropriate location, or you can use the Events tab in the Releases view to configure the
release so that InstallShield automatically copies the release to the appropriate location—a local or network location, or an
FTP site.

Task To configure InstallShield to automatically distribute your release to a particular location:

1. In the View List under Media, click Releases.

2. In the Releases explorer, select the release that you want to configure.

3. Click the Events tab.

4. Configure the settings as appropriate. To learn more about the settings on the Events tab, see Events Tab for a
Release.

Note • If your installation consists of only one disk, the contents of the Disk1 folder are copied to the release location, but not
the folder itself. If your installation spans across multiple disks, the folders and their contents are copied to the release
location.

Project • For InstallScript and InstallScript Object projects, InstallShield automatically copies the release to the location that
you specify on the Events tab every time that you build the release.

For any of the following project types, InstallShield copies all of the relevant files for your release to the specified location
whenever you right-click the release in the Releases view and then click Distribute:

• Basic MSI
• InstallScript MSI
• Merge Module

If you specify a folder and an FTP site on the Events tab, InstallShield copies the files to only the FTP location.

If you want the build engine to copy your release to the specified location after every build in a Basic MSI, InstallScript MSI,
or Merge Module project, select Yes for the Distribute After Build setting.

See Also
Releases View

Distributing Releases to a Virtual Machine that InstallShield Provisions at

Build Time or on Demand
InstallShield 2020

Edition • The ability to distribute releases to virtual machines is available in the Premier edition of InstallShield.

InstallShield 2020 User Guide ISP-2600-UG00 1461

Chapter 4
Building, Testing, and Deploying Installations

Project • This information applies to the following project types:

• Basic MSI
• InstallScript
• InstallScript MSI
• Suite/Advanced UI

You can configure releases in your projects so that after each successful build of your installation, InstallShield
automatically reverts a virtual machine (VM) to a designated snapshot (if one is specified), powers on the VM, and copies
your installation to the VM to make it available for testing. You can also alternately perform these testing preparation steps
on demand at any time. The testing preparation capability makes it possible to reduce testing time and eliminate manual
steps.

The VM can be on a Microsoft Hyper-V Server, a VMware ESX or ESXi Server, or a VMware Workstation.

Requirements for Distributing to VMs

In order to deploy to one of the supported VMs, InstallShield needs to communicate with the virtualization technology that
you are using. If you are using VMware virtualization technology (VMware ESX or ESXi Server or VMware Workstation), the
VMware VIX API needs to be installed on the same machine as InstallShield. You can do this by either installing VMware
Workstation on that machine or by downloading and installing the VMware VIX API from http://www.vmware.com/
support/developer/vix-api.

If you are using VMware Workstation, it is recommended that you install VMware Workstation on the same machine as
InstallShield so that InstallShield uses the version of the VIX API that was designed for that specific version of VMware
Workstation. Although it is likely that newer versions of the VIX API will also work, it seems that the best approach is for
InstallShield to use the version of the VIX API that was bundled with your version of VMware Workstation.

Configuring VM-Related Settings

Task To configure the VM-related settings for a release to enable distribution to the VM at build time or on demand:

1. In the View List under Media, click Releases.

2. In the Releases explorer, select the release that you want to configure.

3. Click the Events tab.

4. Expand the Virtual Machine area.

5. Use the Configuration setting to select the name of the group of VM configuration settings that you want to use when
distributing the selected release to a VM:

• To create a new VM configuration, click the ellipsis button (...) in this setting.

• To edit an existing VM configuration, select it in this setting and then click the ellipsis button (...).

In both cases, the Edit Virtual Machine Configurations dialog box opens, enabling you to configure machine-wide VM
details. For information on using this dialog box, see Edit Virtual Machine Configurations Dialog Box.

1462 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Note that when you specify VM configuration settings in the Edit Virtual Machine Configurations dialog box,
InstallShield writes the data that you specify to a file called VMConfigurations.xml. This VMConfigurations.xml file is
a machine-wide file that you can configure once and then use it in other InstallShield projects, as well as share it with
other team members. You can also use this file on your build machine. To learn more, see Sharing Virtual Machine
Settings for Distribution of Releases.

6. Configure the remaining settings in the Virtual Machine area as needed.

If you configure VM details in these remaining settings, you are overriding some of the machine-wide values that were
entered on the Edit Virtual Machine Configurations dialog box.

For details about all of the settings in the Virtual Machine area, see Events Tab for a Release.

Tip • If you want InstallShield to distribute the release to the specified VM after each successful build, select Yes for the
Distribute After Build setting.

To perform the staging steps for a built release on demand, right-click the release and then click Distribute to VM.

See Also
Sharing Virtual Machine Settings for Distribution of Releases
Releases View

Preparing Installations for Internet Distribution

InstallShield 2020

The way in which consumers receive software is rapidly changing. Before the advances in Internet technology and the
introduction of high-speed connections, all software was shipped on some type of removable medium, such as floppy disks
or CD-ROMs. Today, many people download their software directly from the Internet. In order to take advantage of this
time- and money-saving software distribution process, you must package your installation in an easily downloadable and
installable manner.

There are several criteria that your Web-ready installation may need to meet:

Compressed Size
Although many people now connect to the Internet through high-speed cable modems or DSL lines, others still use lower-
speed modems. Package size is very important to people with slower connections due to the increased amount of online
time required to download an application.

Self-Extracting
Many file compression utilities require a special client-side application to decompress the application files. This need for
another utility complicates the download and installation process for end users. To simplify the installation process, the
compression utility that you use should be self-extracting so that no other application is required.

Digitally Signed
To make your customers feel more secure about downloading and installing your software, you can digitally sign your
application package. The digital signature identifies you or your company to end users and assures them that the
application code has not been altered or tampered with since publication. To learn how to digitally sign your application,
see Digital Signing and Security.

InstallShield 2020 User Guide ISP-2600-UG00 1463

Chapter 4
Building, Testing, and Deploying Installations

Easy to Use
Perhaps the most important aspect of packaging your installation for Internet distribution is making it easy to use. Your
end users may not want to specify a location where the installation files should be saved and then search their computer to
locate those files. Instead, the installation should be seamlessly integrated into the compression package, requiring only
one step to begin the installation.

Proxy Server Support

You may want to configure your installation to download certain files only if they are needed on the target system. For
example, the Windows Installer engine, the .NET Framework, and some InstallShield prerequisites may already be present
on some or most target systems. Instead of embedding these files in your installation (which would increase your overall
installation size), you can configure your project so that only the ones that are needed are downloaded at run time.

If your end users access the Internet through a proxy server and your installation is configured to download files, the
installation uses the system proxy settings that are manually configured in Internet Explorer during the download. This
occurs even if another browser on the target system is the default browser.

Note that InstallShield does not include support for the Automatically Detect Settings functionality in Internet Explorer. (If
end users have the Automatically Detect Settings check box selected in Internet Explorer for their LAN connection and the
installation needs to download files, the installation fails because the files cannot be downloaded. If it is possible that your
end users may have the Automatically Detect Settings check box selected in Internet Explorer for their LAN connections,
you may want to embed all of the files in your installation rather than configure them to be downloaded; if the files are
embedded, the failures can be avoided.) However, InstallShield does support the Automatic Configuration Script
functionality that is set up for LAN connections in Internet Explorer.

Redistributable Files that Are Distributed with an InstallScript Installation

InstallShield 2020

Project • This information applies to InstallScript projects.

The following files are automatically created by InstallShield and can be redistributed with your software distribution, as
discussed in your End-User License Agreement.The media build automatically includes them as needed in your disk image
folders.

Main Media Files

• data<2, 3, 4, …>.cab

• data1.cab

• data1.hdr

• ISSetup.dll

• layout.bin

• setup.exe

• setup.ini

• setup.inx

1464 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Optional Files
• setup.isn—Skin File

• setup.htm—One Click Install .htm page

See Also
Overview of ISSetup.dll

Building 64-Bit Setup Launcher

InstallShield 2020

Project • This information applies to the Basic MSI project type.

InstallShield lets you specify whether you want your installation to include a 64-bit Setup.exe setup launcher. A 64-Bit
Setup.exe setup launcher is required only if the installation is targeting 64-bit system. By default, InstallShield builds the
32-bit setup launcher, which can execute in a 32-bit system as well in WoW64 on 64-bit system. Some 64-bit target systems-
such as Windows Server Core systems may not have 32-bit Windows-on-Windows (WOW64) support. These 64-bit target
systems cannot run 32-bit setup launcher.

The General tab for a product configuration in the Releases view is where you specify information such as whether you
want to build 64-Bit Setup launcher.

Building 64-bit Setup launcher does not build the corresponding 64-bit MSI package by default. In order to build the 64-bit
MSI package, you need to configure the Template Summary with the appropriate 64-bit value (x64 or Intel64). Pure 64-bit
MSI package cannot copy 32-bit product files or execute 32-bit custom action during installation, because 32-bit binaries
cannot be loaded on 64-bit target systems without WOW64 support. The InstallShield Architecture Validation setting for a
product configuration in the Releases view, helps you to build the pure 32-bit or 64-bit MSI package. InstallShield has the
capability to build two installations (one for 32 bit and one for 64 bit) from a single project, based on the release flags
configuration.

For more information on Building 64-bit MSI package, see Targeting 64-Bit Operating Systems with Basic MSI and
InstallScript MSI Installations.

Building 32-bit MSI Package with 64-bit Setup Launcher

InstallShield throws the following warning message if the MSI package is configured to build 32-bit package with the 64-bit
setup launcher option:

ISDEV: warning -7372: Setup Launcher is configured to build 64-Bit, but Template Summary is not
configured to build 64-Bit MSI package.

This is just to make the attention, because 64-bit setup launcher fails to execute in a pure 32-bit system, and the 32-bit MSI
package fail to install in pure 64-bit system. So, this warning can be fixed by not opting the 64-bit setup launcher if the
installer needs to target pure 32-bit system and WoW64 on 64-bit system. Other way, the MSI template summary can be
changed to generate 64-bit MSI package to target pure 64-bit system.

Building InstallScript Custom actions with 64-bit Setup Launcher

InstallScript custom actions are not supported with 64-bit setup launcher. InstallShield build throws below error if the
Basic MSI project contain InstallScript custom actions.

InstallShield 2020 User Guide ISP-2600-UG00 1465

Chapter 4
Building, Testing, and Deploying Installations

ISDEV: fatal error -7371: InstallScript custom actions are not supported with 64-Bit Setup Launcher.

If the InstallScript custom actions are required then the Basic MSI project can be configured to build without the 64-bit
setup launcher, because InstallScript runtimes are still in 32-bit which requires 32-bit setup launcher. Other way if the
InstallScript custom actions are not required, it can be deleted from the project and continue building with 64-bit setup
launcher.

InstallShield Prerequisites and 64-bit Setup Launcher

In general, projects that include InstallShield prerequisites require Setup.exe because Setup.exe checks to see if the
target system meets the InstallShield prerequisite conditions. If the conditions are met, Setup.exe installs the InstallShield
prerequisites.

If you configure to build the projects that include InstallShield prerequisites with 64-bit setup launcher, ensure the
prerequisite installer is a 64-bit, which can install in pure x64 system and configure the prerequisite conditions to check the
64-bit location either in the registry or folder location.

In some cases, if you want to build the 32-bit prerequisite installer with 64-bit setup launcher, configure the conditions to
check the 32-bit location. Most of the registry conditions in the prerequisites are configured to check the default location,
which is 32-bit location for the 32-bit set up launcher and 64-bit location for the 64-bit setup launcher. But, the 32bit
prerequisite installer creates the registry key under the 32-bit registry hives. To rectify this, you need to modify the registry
location to check the 32-bit location explicitly in the InstallShield prerequisite editor. The prerequisite condition is as
shown below:

1466 ISP-2600-UG00 InstallShield 2020 User Guide

 Chapter 4
Building, Testing, and Deploying Installations

Deploying Windows App Packages

InstallShield 2020

Edition • Windows App package creation is available in Basic MSI projects.

Important • The Windows 10 Anniversary Update is required for installing and testing a Windows App package (.appx) with
desktop extensions (Desktop Bridge) included. To digitally sign the Windows App package, InstallShield must be installed on a
Windows 10 machine or a machine with the Windows 10 SDK installed.

Tip • Sideloading must be enabled for a Windows App package to be successfully sideloaded. For more information about
sideloading, refer to the Enable your device for deployment MSDN article.

The following table provides an overview of the ways you can distribute Windows App packages:

Table 4-24 • Windows App Distribution Methods

Distribution Distribution Signing

Method Description Method Setting Considerations

Windows Store Upload the Windows App package to the Windows Store This type of app
Windows Store. Refer to the Packaging Windows doesn't need to be
Apps (MSDN article) for more information. signed before it is
uploaded to Microsoft
Any package distributed through the Windows
because Microsoft
Store is subject to additional policies that limit its
signs the package.
contents.

InstallShield 2020 User Guide ISP-2600-UG00 1467

Chapter 4
Building, Testing, and Deploying Installations

Table 4-24 • Windows App Distribution Methods

Distribution Distribution Signing

Method Description Method Setting Considerations

Sideloaded and Add a sideloading Windows App package to a Direct Distribution If a package will be
added to a Suite/ Suite/Advanced UI project as described in Adding (Sideload) sideloaded and added
Advanced UI a Sideloading Windows App Package (.appx | to a Suite, the
Project .msix) to a Suite/Advanced UI Project. Windows App package
must be signed before
A common example of a sideloading app is one
it is built into the
that is distributed to an enterprise environment
Suite/Advanced UI
and is internal to a company only.
project.
You can use condition checks such as the
Windows App Package Eligible eligibility
condition of a Windows App package (.appx) or
the UWP Type Present condition in either an exit
condition or a package's eligibility condition as
well as other condition checks to employ this type
of distribution method. This type of scenario