documentation.HELP! Windows Installer XML (WiX) v3.0 Documentation

How To: Files, Shortcuts and Registry

Windows Installer XML (WiX) v3.0

previous page next page

How To: Files, Shortcuts and Registry

This section includes how to guides that demonstrate how to work with files, shortcuts, and the Windows registry.

  • How To: Add a file to your installer
  • How To: Check the version number of a file during installation
  • How To: Write a registry entry during installation
  • How To: Read a registry entry during installation
  • How To: Create a shortcut on the Start Menu
  • How To: Create a shortcut to a web page
  • How To: Create an uninstall shortcut
  • How To: NGen managed assemblies during installation
  • How To: Reference another DirectorySearch element
previous page start next page

Menu

  • Homepage

Table of contents

  • Windows Installer XML (WiX) Help
    • Introduction
    • About WiX
      • File Types
      • Tools and Concepts
        • List of Tools
        • Preprocessor
        • Compiler (Candle)
        • Linker (Light)
        • Library Tool (Lit)
        • Decompiler (Dark)
        • Harvester (Heat)
        • WixCop
        • Heat
    • Using WiX on the Command Line
      • Authoring Your First .wxs File
      • Creating Merge Modules
      • Mapping MSI Tables to WiX Schema
    • Using WiX in Visual Studio
      • WiX Project Types
      • WiX Item Templates
      • WiX Project Property Pages
      • Creating a Simple Setup
      • Adding Project References
      • Adding WiX References
    • Using WiX with MSBuild
      • Creating a .wixproj File
      • Integrating WiX Projects Into Daily Builds
      • Building WiX Projects In Team Foundation Build
      • WiX MSBuild Task Reference
        • Candle Task
        • Light Task
        • Lit Task
    • Using WiX with NAnt
      • WiX NAnt Task Reference
        • Candle Task
        • Light Task
        • Lit Task
    • How To Guides
      • Files, Shortcuts, and Registry
        • How To: Add a file to your installer
        • How To: Check the version number of a file during installation
        • How To: Write a registry entry during installation
        • How To: Read a registry entry during installation
        • How To: Create a shortcut on the Start Menu
        • How To: Create a shortcut to a web page
        • How To: Create an uninstall shortcut
        • How To: NGen managed assemblies during installation
        • How To: Reference another DirectorySearch element
        • How To: Get the parent directory of a file search
      • Redistributables and Install Checks
        • How To: Check for .NET Framework versions
        • How To: Install the .NET Framework using a bootstrapper
        • How To: Install DirectX 9.0 with your installer
        • How To: Install the Visual C++ Redistributable with your installer
        • How To: Block installation based on OS version
      • User Interface and Localization
        • How To: Build a localized version of your installer
        • How To: Make your installer localizable
        • How To: Run the installed application after setup
        • How To: Set your installer's icon in Add/Remove Programs
      • Updates
        • How To: Implement a major upgrade in your installer
      • General How Tos
        • How To: Get a log of your installation for debugging
        • How To: Look inside your MSI with Orca
        • How To: Generate a GUID
    • WiX Schema References
      • Wix Schema
        • AdminExecuteSequence Element
        • AdminUISequence Element
        • AdvertiseExecuteSequence Element
        • AllocateRegistrySpace Element
        • AppData Element
        • AppId Element
        • AppSearch Element
        • AssemblyName Element
        • Billboard Element
        • BillboardAction Element
        • Binary Element
        • BinaryRef Element
        • BindImage Element
        • Category Element
        • CCPSearch Element
        • Class Element
        • Column Element
        • ComboBox Element
        • ComplianceCheck Element
        • ComplianceDrive Element
        • Component Element
        • ComponentGroup Element
        • ComponentGroupRef Element
        • ComponentRef Element
        • ComponentSearch Element
        • Condition Element
        • Configuration Element
        • ConfigurationData Element
        • Control Element
        • CopyFile Element
        • CostFinalize Element
        • CostInitialize Element
        • CreateFolder Element
        • CreateFolders Element
        • CreateShortcuts Element
        • Custom Element
        • CustomAction Element
        • CustomActionRef Element
        • CustomProperty Element
        • CustomTable Element
        • Data Element
        • DeleteServices Element
        • Dependency Element
        • Dialog Element
        • DialogRef Element
        • DigitalCertificate Element
        • DigitalSignature Element
        • Directory Element
        • DirectoryRef Element
        • DirectorySearch Element
        • DirectorySearchRef Element
        • DisableRollback Element
        • DuplicateFiles Element
        • EmbeddedChainer Element
        • EmbeddedChainerRef Element
        • EmbeddedUI Element
        • EmbeddedUIResource Element
        • EnsureTable Element
        • Environment Element
        • Error Element
        • Exclusion Element
        • ExecuteAction Element
        • Extension Element
        • ExternalFile Element
        • Failure Element
        • Family Element
        • Feature Element
        • FeatureGroup Element
        • FeatureGroupRef Element
        • FeatureRef Element
        • File Element
        • FileCost Element
        • FileSearch Element
        • FileSearchRef Element
        • FileTypeMask Element
        • FindRelatedProducts Element
        • ForceReboot Element
        • Fragment Element
        • Icon Element
        • IconRef Element
        • IgnoreModularization Element
        • IgnoreRange Element
        • IgnoreTable Element
        • Include Element
        • IniFile Element
        • IniFileSearch Element
        • InstallAdminPackage Element
        • InstallExecute Element
        • InstallExecuteAgain Element
        • InstallExecuteSequence Element
        • InstallFiles Element
        • InstallFinalize Element
        • InstallInitialize Element
        • InstallODBC Element
        • InstallServices Element
        • InstallUISequence Element
        • InstallValidate Element
        • Instance Element
        • InstanceTransforms Element
        • Interface Element
        • IsolateComponent Element
        • IsolateComponents Element
        • LaunchConditions Element
        • ListBox Element
        • ListItem Element
        • ListView Element
        • Media Element
        • Merge Element
        • MergeRef Element
        • MigrateFeatureStates Element
        • MIME Element
        • Module Element
        • MoveFiles Element
        • MsiPublishAssemblies Element
        • MsiUnpublishAssemblies Element
        • MultiStringValue Element
        • ODBCDataSource Element
        • ODBCDriver Element
        • ODBCTranslator Element
        • OptimizeCustomActions Element
        • Package Element
        • PackageCertificates Element
        • Patch Element
        • PatchBaseline Element
        • PatchCertificates Element
        • PatchCreation Element
        • PatchFamily Element
        • PatchFamilyRef Element
        • PatchFiles Element
        • PatchInformation Element
        • PatchMetadata Element
        • PatchProperty Element
        • PatchSequence Element
        • Permission Element
        • PermissionEx Element
        • ProcessComponents Element
        • Product Element
        • ProgId Element
        • ProgressText Element
        • Property Element
        • PropertyRef Element
        • ProtectFile Element
        • ProtectRange Element
        • Publish Element
        • PublishComponents Element
        • PublishFeatures Element
        • PublishProduct Element
        • RadioButton Element
        • RadioButtonGroup Element
        • RegisterClassInfo Element
        • RegisterComPlus Element
        • RegisterExtensionInfo Element
        • RegisterFonts Element
        • RegisterMIMEInfo Element
        • RegisterProduct Element
        • RegisterProgIdInfo Element
        • RegisterTypeLibraries Element
        • RegisterUser Element
        • Registry Element
        • RegistryKey Element
        • RegistrySearch Element
        • RegistrySearchRef Element
        • RegistryValue Element
        • RemoveDuplicateFiles Element
        • RemoveEnvironmentStrings Element
        • RemoveExistingProducts Element
        • RemoveFile Element
        • RemoveFiles Element
        • RemoveFolder Element
        • RemoveFolders Element
        • RemoveIniValues Element
        • RemoveODBC Element
        • RemoveRegistryKey Element
        • RemoveRegistryValue Element
        • RemoveRegistryValues Element
        • RemoveShortcuts Element
        • ReplacePatch Element
        • RequiredPrivilege Element
        • ReserveCost Element
        • ResolveSource Element
        • RMCCPSearch Element
        • Row Element
        • ScheduleReboot Element
        • SelfRegModules Element
        • SelfUnregModules Element
        • ServiceArgument Element
        • ServiceConfig Element
        • ServiceConfigFailureActions Element
        • ServiceControl Element
        • ServiceDependency Element
        • ServiceInstall Element
        • SetDirectory Element
        • SetODBCFolders Element
        • SetProperty Element
        • SFPCatalog Element
        • SFPFile Element
        • Shortcut Element
        • ShortcutProperty Element
        • Show Element
        • StartServices Element
        • StopServices Element
        • Subscribe Element
        • Substitution Element
        • SymbolPath Element
        • TargetFile Element
        • TargetImage Element
        • TargetProductCode Element
        • TargetProductCodes Element
        • Text Element
        • TextStyle Element
        • TypeLib Element
        • UI Element
        • UIRef Element
        • UIText Element
        • UnpublishComponents Element
        • UnpublishFeatures Element
        • UnregisterClassInfo Element
        • UnregisterComPlus Element
        • UnregisterExtensionInfo Element
        • UnregisterFonts Element
        • UnregisterMIMEInfo Element
        • UnregisterProgIdInfo Element
        • UnregisterTypeLibraries Element
        • Upgrade Element
        • UpgradeFile Element
        • UpgradeImage Element
        • UpgradeVersion Element
        • Validate Element
        • ValidateProductID Element
        • Verb Element
        • Wix Element
        • WixVariable Element
        • WriteEnvironmentStrings Element
        • WriteIniValues Element
        • WriteRegistryValues Element
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Wixloc Schema
        • String Element
        • WixLocalization Element
        • LocalizationYesNoType Simple Type
      • Complus Schema
        • ComPlusApplication Element (Complus Extension)
        • ComPlusApplicationRole Element (Complus Extension)
        • ComPlusAssembly Element (Complus Extension)
        • ComPlusAssemblyDependency Element (Complus Extension)
        • ComPlusComponent Element (Complus Extension)
        • ComPlusGroupInApplicationRole Element (Complus Extension)
        • ComPlusGroupInPartitionRole Element (Complus Extension)
        • ComPlusInterface Element (Complus Extension)
        • ComPlusMethod Element (Complus Extension)
        • ComPlusPartition Element (Complus Extension)
        • ComPlusPartitionRole Element (Complus Extension)
        • ComPlusPartitionUser Element (Complus Extension)
        • ComPlusRoleForComponent Element (Complus Extension)
        • ComPlusRoleForInterface Element (Complus Extension)
        • ComPlusRoleForMethod Element (Complus Extension)
        • ComPlusSubscription Element (Complus Extension)
        • ComPlusUserInApplicationRole Element (Complus Extension)
        • ComPlusUserInPartitionRole Element (Complus Extension)
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • uuid Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Difxapp Schema
        • Driver Element (Difxapp Extension)
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Firewall Schema
        • FirewallException Element (Firewall Extension)
        • RemoteAddress Element (Firewall Extension)
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Gaming Schema
        • Game Element (Gaming Extension)
        • PlayTask Element (Gaming Extension)
        • SupportTask Element (Gaming Extension)
        • IsRichSavedGame Attribute
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Iis Schema
        • Certificate Element (Iis Extension)
        • CertificateRef Element (Iis Extension)
        • HttpHeader Element (Iis Extension)
        • MimeMap Element (Iis Extension)
        • RecycleTime Element (Iis Extension)
        • WebAddress Element (Iis Extension)
        • WebApplication Element (Iis Extension)
        • WebApplicationExtension Element (Iis Extension)
        • WebAppPool Element (Iis Extension)
        • WebDir Element (Iis Extension)
        • WebDirProperties Element (Iis Extension)
        • WebError Element (Iis Extension)
        • WebFilter Element (Iis Extension)
        • WebLog Element (Iis Extension)
        • WebProperty Element (Iis Extension)
        • WebServiceExtension Element (Iis Extension)
        • WebSite Element (Iis Extension)
        • WebVirtualDir Element (Iis Extension)
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • PercentType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • IsolatedApp Schema
        • Application Element (IsolatedApp Extension)
        • Description Element (IsolatedApp Extension)
        • Details Element (IsolatedApp Extension)
        • EntryPoint Element (IsolatedApp Extension)
        • Feed Element (IsolatedApp Extension)
        • Icon Element (IsolatedApp Extension)
        • Id Element (IsolatedApp Extension)
        • IsolatedApp Element (IsolatedApp Extension)
        • Manufacturer Element (IsolatedApp Extension)
        • Name Element (IsolatedApp Extension)
        • Package Element (IsolatedApp Extension)
        • PreviousFeed Element (IsolatedApp Extension)
        • Source Element (IsolatedApp Extension)
        • UpdateRate Element (IsolatedApp Extension)
        • Version Element (IsolatedApp Extension)
        • uuid Simple Type
        • VersionType Simple Type
      • Msmq Schema
        • MessageQueue Element (Msmq Extension)
        • MessageQueuePermission Element (Msmq Extension)
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Netfx Schema
        • NativeImage Element (Netfx Extension)
        • YesNoType Simple Type
      • OfficeAddin Schema
        • Application Element (OfficeAddin Extension)
        • Description Element (OfficeAddin Extension)
        • Details Element (OfficeAddin Extension)
        • EntryPoint Element (OfficeAddin Extension)
        • ExtendsApplication Element (OfficeAddin Extension)
        • Feed Element (OfficeAddin Extension)
        • Icon Element (OfficeAddin Extension)
        • Id Element (OfficeAddin Extension)
        • Manufacturer Element (OfficeAddin Extension)
        • Name Element (OfficeAddin Extension)
        • OfficeAddin Element (OfficeAddin Extension)
        • Package Element (OfficeAddin Extension)
        • PreviousFeed Element (OfficeAddin Extension)
        • Source Element (OfficeAddin Extension)
        • UpdateRate Element (OfficeAddin Extension)
        • Version Element (OfficeAddin Extension)
        • SupportedOfficeApplications Simple Type
        • uuid Simple Type
        • VersionType Simple Type
      • Ps Schema
        • FormatsFile Element (Ps Extension)
        • SnapIn Element (Ps Extension)
        • TypesFile Element (Ps Extension)
        • RequiredVersion Attribute
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • EmbeddedResource Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Sql Schema
        • SqlDatabase Element (Sql Extension)
        • SqlFileSpec Element (Sql Extension)
        • SqlLogFileSpec Element (Sql Extension)
        • SqlScript Element (Sql Extension)
        • SqlString Element (Sql Extension)
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Util Schema
        • CloseApplication Element (Util Extension)
        • EventManifest Element (Util Extension)
        • EventSource Element (Util Extension)
        • FileShare Element (Util Extension)
        • FileSharePermission Element (Util Extension)
        • Group Element (Util Extension)
        • GroupRef Element (Util Extension)
        • InternetShortcut Element (Util Extension)
        • PerfCounter Element (Util Extension)
        • PerfCounterManifest Element (Util Extension)
        • PerformanceCategory Element (Util Extension)
        • PerformanceCounter Element (Util Extension)
        • PermissionEx Element (Util Extension)
        • ServiceConfig Element (Util Extension)
        • User Element (Util Extension)
        • XmlConfig Element (Util Extension)
        • XmlFile Element (Util Extension)
        • AutogenGuid Simple Type
        • ComponentGuid Simple Type
        • Guid Simple Type
        • HexType Simple Type
        • LocalizableInteger Simple Type
        • LongFileNameType Simple Type
        • PatchClassificationType Simple Type
        • PerformanceCounterLanguageType Simple Type
        • PerformanceCounterTypesType Simple Type
        • RegistryRootType Simple Type
        • ShortFileNameType Simple Type
        • VersionType Simple Type
        • WildCardLongFileNameType Simple Type
        • WildCardShortFileNameType Simple Type
        • YesNoDefaultType Simple Type
        • YesNoType Simple Type
      • Vs Schema
        • HelpCollection Element (Vs Extension)
        • HelpCollectionRef Element (Vs Extension)
        • HelpFile Element (Vs Extension)
        • HelpFileRef Element (Vs Extension)
        • HelpFilter Element (Vs Extension)
        • HelpFilterRef Element (Vs Extension)
        • PlugCollectionInto Element (Vs Extension)
        • YesNoType Simple Type
    • Advanced WiX Topics
      • Specifying cultures to build
      • Specifying source files
      • Optimizing builds
      • Adding Custom Actions
      • Standard Custom Actions
        • Using Standard Custom Actions
        • OSInfo Custom Actions
        • Performance Counter Custom Action
        • Quiet Execution Custom Action
        • ShellExecute Custom Action
        • WixDirectXExtension
        • WixExitEarlyWithSuccess
        • WixFailWhenDeferred
        • WixGamingExtension
        • WixNetfxExtension
        • WixVSExtension
      • WixUI Dialog Library
        • Using Built-in WixUI Dialog Sets
        • Customizing Built-in WixUI Dialog Sets
        • Using Localized Versions of WixUI
        • WixUI Dialog Reference
          • WixUI_Advanced Dialog Set
          • WixUI_FeatureTree Dialog Set
          • WixUI_InstallDir Dialog Set
          • WixUI_Minimal Dialog Set
          • WixUI_Mondo Dialog Set
          • WixUI Dialogs
      • Extensions
        • Using WiX Extensions
        • Localized Extensions
      • Patch Building
        • Using Patch Creation Properties
        • Using Purely WiX
        • Restrictions for Patches
      • Code Pages
    • Developing for WiX
      • How to be a Windows Installer XML Developer
      • Building WiX
      • NAnt Conventions
      • Developing WiX Extensions
        • Introduction
        • Creating a Simple Extension
        • Creating a Preprocessor Extension
      • Developing for Votive
      • Adding to the WiX Documentation
      • Testing WiX
        • Running Tests
        • Writing Tests
    • Additional Resources
      • Getting Started Learning WiX
      • Useful Windows Installer Information
      • Getting Help

Get in touch

Submit feedback about this site to:

  • [email protected]

© documentation.help. Design: rehmann.co.