Add InProgressDisplayName for bundles.

#6296

3 files changed, 57 insertions, 35 deletions

diff --git a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
index 072d3ef0..d7dbf04c 100644
--- a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
@@ -1490,12 +1490,13 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
-        int IBootstrapperApplication.OnRegisterBegin(ref bool fCancel)
+        int IBootstrapperApplication.OnRegisterBegin(RegistrationType recommendedRegistrationType, ref bool fCancel, ref RegistrationType registrationType)
         {
-            RegisterBeginEventArgs args = new RegisterBeginEventArgs(fCancel);
+            RegisterBeginEventArgs args = new RegisterBeginEventArgs(recommendedRegistrationType, fCancel, registrationType);
             this.OnRegisterBegin(args);
 
             fCancel = args.Cancel;
+            registrationType = args.RegistrationType;
             return args.HResult;
         }
 
@@ -1679,12 +1680,12 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
-        int IBootstrapperApplication.OnUnregisterBegin(bool fKeepRegistration, ref bool fForceKeepRegistration)
+        int IBootstrapperApplication.OnUnregisterBegin(RegistrationType recommendedRegistrationType, ref RegistrationType registrationType)
         {
-            UnregisterBeginEventArgs args = new UnregisterBeginEventArgs(fKeepRegistration, fForceKeepRegistration);
+            UnregisterBeginEventArgs args = new UnregisterBeginEventArgs(recommendedRegistrationType, registrationType);
             this.OnUnregisterBegin(args);
 
-            fForceKeepRegistration = args.ForceKeepRegistration;
+            registrationType = args.RegistrationType;
             return args.HResult;
         }
 
diff --git a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
index 8ef8af14..00d90c83 100644
--- a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
+++ b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
@@ -1184,22 +1184,31 @@ namespace WixToolset.Mba.Core
     public class RegisterBeginEventArgs : CancellableHResultEventArgs
     {
         /// <summary />
-        public RegisterBeginEventArgs(bool cancelRecommendation)
+        public RegisterBeginEventArgs(RegistrationType recommendedRegistrationType, bool cancelRecommendation, RegistrationType registrationType)
             : base(cancelRecommendation)
         {
+            this.RecommendedRegistrationType = recommendedRegistrationType;
+            this.RegistrationType = registrationType;
         }
+
+        /// <summary>
+        /// Gets the recommended registration type.
+        /// </summary>
+        public RegistrationType RecommendedRegistrationType { get; private set; }
+
+        /// <summary>
+        /// Gets or sets the registration type.
+        /// </summary>
+        public RegistrationType RegistrationType { get; set; }
     }
 
     /// <summary>
-    /// Additional arguments used when the engine has completed registering the location and visilibity of the bundle.
+    /// Event arguments for <see cref="IDefaultBootstrapperApplication.RegisterComplete"/>.
     /// </summary>
     [Serializable]
     public class RegisterCompleteEventArgs : StatusEventArgs
     {
-        /// <summary>
-        /// Creates a new instance of the <see cref="RegisterCompleteEventArgs"/> class.
-        /// </summary>
-        /// <param name="hrStatus">The return code of the operation.</param>
+        /// <summary />
         public RegisterCompleteEventArgs(int hrStatus)
             : base(hrStatus)
         {
@@ -1212,26 +1221,22 @@ namespace WixToolset.Mba.Core
     [Serializable]
     public class UnregisterBeginEventArgs : HResultEventArgs
     {
-        /// <summary>
-        /// 
-        /// </summary>
-        /// <param name="keepRegistration"></param>
-        /// <param name="forceKeepRegistration"></param>
-        public UnregisterBeginEventArgs(bool keepRegistration, bool forceKeepRegistration)
+        /// <summary />
+        public UnregisterBeginEventArgs(RegistrationType recommendedRegistrationType, RegistrationType registrationType)
         {
-            this.KeepRegistration = keepRegistration;
-            this.ForceKeepRegistration = forceKeepRegistration;
+            this.RecommendedRegistrationType = recommendedRegistrationType;
+            this.RegistrationType = registrationType;
         }
 
         /// <summary>
-        /// Indicates whether the engine will uninstall the bundle.
+        /// Gets the recommended registration type.
         /// </summary>
-        public bool ForceKeepRegistration { get; set; }
+        public RegistrationType RecommendedRegistrationType { get; private set; }
 
         /// <summary>
-        /// If <see cref="KeepRegistration"/> is FALSE, then this can be set to TRUE to make the engine keep the bundle installed.
+        /// Gets or sets the registration type.
         /// </summary>
-        public bool KeepRegistration { get; private set; }
+        public RegistrationType RegistrationType { get; set; }
     }
 
     /// <summary>
@@ -1240,10 +1245,7 @@ namespace WixToolset.Mba.Core
     [Serializable]
     public class UnregisterCompleteEventArgs : StatusEventArgs
     {
-        /// <summary>
-        /// 
-        /// </summary>
-        /// <param name="hrStatus"></param>
+        /// <summary />
         public UnregisterCompleteEventArgs(int hrStatus)
             : base(hrStatus)
         {
diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
index 530fb1a9..e6e03906 100644
--- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
@@ -500,12 +500,12 @@ namespace WixToolset.Mba.Core
         /// <summary>
         /// See <see cref="IDefaultBootstrapperApplication.RegisterBegin"/>.
         /// </summary>
-        /// <param name="fCancel"></param>
-        /// <returns></returns>
         [PreserveSig]
         [return: MarshalAs(UnmanagedType.I4)]
         int OnRegisterBegin(
-            [MarshalAs(UnmanagedType.Bool)] ref bool fCancel
+            [MarshalAs(UnmanagedType.I4)] RegistrationType recommendedRegistrationType,
+            [MarshalAs(UnmanagedType.Bool)] ref bool fCancel,
+            [MarshalAs(UnmanagedType.I4)] ref RegistrationType pRegistrationType
             );
 
         /// <summary>
@@ -820,14 +820,11 @@ namespace WixToolset.Mba.Core
         /// <summary>
         /// See <see cref="IDefaultBootstrapperApplication.UnregisterBegin"/>.
         /// </summary>
-        /// <param name="fKeepRegistration"></param>
-        /// <param name="fForceKeepRegistration"></param>
-        /// <returns></returns>
         [PreserveSig]
         [return: MarshalAs(UnmanagedType.I4)]
         int OnUnregisterBegin(
-            [MarshalAs(UnmanagedType.Bool)] bool fKeepRegistration,
-            [MarshalAs(UnmanagedType.Bool)] ref bool fForceKeepRegistration
+            [MarshalAs(UnmanagedType.I4)] RegistrationType recommendedRegistrationType,
+            [MarshalAs(UnmanagedType.I4)] ref RegistrationType pRegistrationType
             );
 
         /// <summary>
@@ -1260,6 +1257,28 @@ namespace WixToolset.Mba.Core
     }
 
     /// <summary>
+    /// The display name to use when registering in Add/Remove Programs.
+    /// </summary>
+    public enum RegistrationType
+    {
+        /// <summary>
+        /// No registration.
+        /// The engine will ignore None if it recommended InProgress or Full.
+        /// </summary>
+        None,
+
+        /// <summary>
+        /// The in-progress display name.
+        /// </summary>
+        InProgress,
+
+        /// <summary>
+        /// The default display name.
+        /// </summary>
+        Full,
+    }
+
+    /// <summary>
     /// Result codes (based on Dialog Box Command IDs from WinUser.h).
     /// </summary>
     public enum Result