From a46ef0eebafea0e5b38c0c6e960be778c2dbb852 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Thu, 19 Jan 2023 00:18:26 -0600 Subject: Finish the XML documentation in WixToolset.Mba.Core. 4623 --- .../BaseBootstrapperApplicationFactory.cs | 4 +- .../WixToolset.Mba.Core/BootstrapperApplication.cs | 36 +- .../BootstrapperApplicationData.cs | 4 +- .../WixToolset.Mba.Core/BootstrapperCommand.cs | 13 +- src/api/burn/WixToolset.Mba.Core/Engine.cs | 83 ---- src/api/burn/WixToolset.Mba.Core/EventArgs.cs | 483 +++++++++++++++------ .../IBootstrapperApplication.cs | 283 +++--------- .../IBootstrapperApplicationFactory.cs | 2 +- .../WixToolset.Mba.Core/IBootstrapperEngine.cs | 124 ++---- src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs | 12 +- src/api/burn/WixToolset.Mba.Core/IPackageInfo.cs | 34 +- src/api/burn/WixToolset.Mba.Core/PackageInfo.cs | 69 +-- src/api/burn/WixToolset.Mba.Core/VerUtil.cs | 18 +- .../test/WixToolsetTest.Mba.Core/VerUtilFixture.cs | 14 +- 14 files changed, 555 insertions(+), 624 deletions(-) diff --git a/src/api/burn/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs b/src/api/burn/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs index b215681e..339bfd8f 100644 --- a/src/api/burn/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs +++ b/src/api/burn/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs @@ -13,8 +13,8 @@ namespace WixToolset.Mba.Core /// /// Default implementation of /// - /// - /// + /// The args struct given by the engine when initially creating the BA. + /// The results struct given by the engine when initially creating the BA public void Create(IntPtr pArgs, IntPtr pResults) { InitializeFromCreateArgs(pArgs, out var engine, out var bootstrapperCommand); diff --git a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs index b23cb3b2..a0ec6ab9 100644 --- a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs +++ b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs @@ -798,7 +798,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheBegin(CacheBeginEventArgs args) { EventHandler handler = this.CacheBegin; @@ -811,7 +811,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCachePackageBegin(CachePackageBeginEventArgs args) { EventHandler handler = this.CachePackageBegin; @@ -824,7 +824,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheAcquireBegin(CacheAcquireBeginEventArgs args) { EventHandler handler = this.CacheAcquireBegin; @@ -837,7 +837,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheAcquireProgress(CacheAcquireProgressEventArgs args) { EventHandler handler = this.CacheAcquireProgress; @@ -863,7 +863,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheAcquireComplete(CacheAcquireCompleteEventArgs args) { EventHandler handler = this.CacheAcquireComplete; @@ -876,7 +876,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheVerifyBegin(CacheVerifyBeginEventArgs args) { EventHandler handler = this.CacheVerifyBegin; @@ -889,7 +889,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheVerifyProgress(CacheVerifyProgressEventArgs args) { EventHandler handler = this.CacheVerifyProgress; @@ -902,7 +902,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheVerifyComplete(CacheVerifyCompleteEventArgs args) { EventHandler handler = this.CacheVerifyComplete; @@ -915,7 +915,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCachePackageComplete(CachePackageCompleteEventArgs args) { EventHandler handler = this.CachePackageComplete; @@ -1227,6 +1227,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// + /// Additional arguments for this event. protected virtual void OnPlanForwardCompatibleBundle(PlanForwardCompatibleBundleEventArgs args) { EventHandler handler = this.PlanForwardCompatibleBundle; @@ -1239,7 +1240,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheContainerOrPayloadVerifyBegin(CacheContainerOrPayloadVerifyBeginEventArgs args) { EventHandler handler = this.CacheContainerOrPayloadVerifyBegin; @@ -1252,7 +1253,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheContainerOrPayloadVerifyProgress(CacheContainerOrPayloadVerifyProgressEventArgs args) { EventHandler handler = this.CacheContainerOrPayloadVerifyProgress; @@ -1265,7 +1266,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCacheContainerOrPayloadVerifyComplete(CacheContainerOrPayloadVerifyCompleteEventArgs args) { EventHandler handler = this.CacheContainerOrPayloadVerifyComplete; @@ -1278,7 +1279,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCachePayloadExtractBegin(CachePayloadExtractBeginEventArgs args) { EventHandler handler = this.CachePayloadExtractBegin; @@ -1291,7 +1292,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCachePayloadExtractProgress(CachePayloadExtractProgressEventArgs args) { EventHandler handler = this.CachePayloadExtractProgress; @@ -1304,7 +1305,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnCachePayloadExtractComplete(CachePayloadExtractCompleteEventArgs args) { EventHandler handler = this.CachePayloadExtractComplete; @@ -1317,7 +1318,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnSetUpdateBegin(SetUpdateBeginEventArgs args) { EventHandler handler = this.SetUpdateBegin; @@ -1330,7 +1331,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// - /// + /// Additional arguments for this event. protected virtual void OnSetUpdateComplete(SetUpdateCompleteEventArgs args) { EventHandler handler = this.SetUpdateComplete; @@ -1382,6 +1383,7 @@ namespace WixToolset.Mba.Core /// /// Called by the engine, raises the event. /// + /// Additional arguments for this event. protected virtual void OnCachePackageNonVitalValidationFailure(CachePackageNonVitalValidationFailureEventArgs args) { EventHandler handler = this.CachePackageNonVitalValidationFailure; diff --git a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplicationData.cs b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplicationData.cs index 739a08bb..13428493 100644 --- a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplicationData.cs +++ b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplicationData.cs @@ -12,12 +12,12 @@ namespace WixToolset.Mba.Core public class BootstrapperApplicationData : IBootstrapperApplicationData { /// - /// + /// The default file name for BootstrapperApplicationData. /// public const string DefaultFileName = "BootstrapperApplicationData.xml"; /// - /// + /// The XML namespace for BootstrapperApplicationData. /// public const string XMLNamespace = "http://wixtoolset.org/schemas/v4/BootstrapperApplicationData"; diff --git a/src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs b/src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs index 88a9b9bb..ed1dc191 100644 --- a/src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs +++ b/src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs @@ -13,19 +13,8 @@ namespace WixToolset.Mba.Core public sealed class BootstrapperCommand : IBootstrapperCommand { /// - /// + /// See . /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// public BootstrapperCommand( LaunchAction action, Display display, diff --git a/src/api/burn/WixToolset.Mba.Core/Engine.cs b/src/api/burn/WixToolset.Mba.Core/Engine.cs index 3ff693c0..1120fb1c 100644 --- a/src/api/burn/WixToolset.Mba.Core/Engine.cs +++ b/src/api/burn/WixToolset.Mba.Core/Engine.cs @@ -6,21 +6,14 @@ namespace WixToolset.Mba.Core using System.ComponentModel; using System.Runtime.InteropServices; using System.Security; - using System.Text; /// /// Default implementation of . /// public sealed class Engine : IEngine { - private static readonly string normalizeVersionFormatString = "{0} must be less than or equal to " + UInt16.MaxValue; - private IBootstrapperEngine engine; - /// - /// Creates a new instance of the container class. - /// - /// The to contain. internal Engine(IBootstrapperEngine engine) { this.engine = engine; @@ -352,81 +345,5 @@ namespace WixToolset.Mba.Core { this.engine.Quit(exitCode); } - - /// - /// Utility method for converting a into a . - /// - /// - /// - public static long VersionToLong(Version version) - { - // In Windows, each version component has a max value of 65535, - // so we truncate the version before shifting it, which will overflow if invalid. - long major = (long)(ushort)version.Major << 48; - long minor = (long)(ushort)version.Minor << 32; - long build = (long)(ushort)version.Build << 16; - long revision = (long)(ushort)version.Revision; - - return major | minor | build | revision; - } - - /// - /// Utility method for converting a into a . - /// - /// - /// - public static Version LongToVersion(long version) - { - int major = (int)((version & ((long)0xffff << 48)) >> 48); - int minor = (int)((version & ((long)0xffff << 32)) >> 32); - int build = (int)((version & ((long)0xffff << 16)) >> 16); - int revision = (int)(version & 0xffff); - - return new Version(major, minor, build, revision); - } - - /// - /// Verifies that Version can be represented in a . - /// If the Build or Revision fields are undefined, they are set to zero. - /// - public static Version NormalizeVersion(Version version) - { - if (version == null) - { - throw new ArgumentNullException("version"); - } - - int major = version.Major; - int minor = version.Minor; - int build = version.Build; - int revision = version.Revision; - - if (major > UInt16.MaxValue) - { - throw new ArgumentOutOfRangeException("version", String.Format(normalizeVersionFormatString, "Major")); - } - if (minor > UInt16.MaxValue) - { - throw new ArgumentOutOfRangeException("version", String.Format(normalizeVersionFormatString, "Minor")); - } - if (build > UInt16.MaxValue) - { - throw new ArgumentOutOfRangeException("version", String.Format(normalizeVersionFormatString, "Build")); - } - if (build == -1) - { - build = 0; - } - if (revision > UInt16.MaxValue) - { - throw new ArgumentOutOfRangeException("version", String.Format(normalizeVersionFormatString, "Revision")); - } - if (revision == -1) - { - revision = 0; - } - - return new Version(major, minor, build, revision); - } } } diff --git a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs index 9d18c4eb..4b7f2245 100644 --- a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs +++ b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs @@ -14,7 +14,8 @@ namespace WixToolset.Mba.Core public abstract class HResultEventArgs : EventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// public HResultEventArgs() { @@ -33,7 +34,8 @@ namespace WixToolset.Mba.Core public abstract class CancellableHResultEventArgs : HResultEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// public CancellableHResultEventArgs(bool cancelRecommendation) { @@ -52,7 +54,10 @@ namespace WixToolset.Mba.Core [Serializable] public abstract class ResultEventArgs : HResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ResultEventArgs(Result recommendation, Result result) { this.Recommendation = recommendation; @@ -77,9 +82,9 @@ namespace WixToolset.Mba.Core public abstract class StatusEventArgs : HResultEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// The return code of the operation. public StatusEventArgs(int hrStatus) { this.Status = hrStatus; @@ -96,7 +101,10 @@ namespace WixToolset.Mba.Core /// public abstract class ActionEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ActionEventArgs(int hrStatus, T recommendation, T action) : base(hrStatus) { @@ -121,7 +129,10 @@ namespace WixToolset.Mba.Core [Serializable] public abstract class CancellableActionEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CancellableActionEventArgs(bool cancelRecommendation, T recommendation, T action) : base(cancelRecommendation) { @@ -146,7 +157,10 @@ namespace WixToolset.Mba.Core [Serializable] public abstract class CacheProgressBaseEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheProgressBaseEventArgs(string packageOrContainerId, string payloadId, long progress, long total, int overallPercentage, bool cancelRecommendation) : base(cancelRecommendation) { @@ -184,13 +198,14 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments used when startup has begun. + /// Event arguments for . /// [Serializable] public class StartupEventArgs : HResultEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// public StartupEventArgs() { @@ -198,13 +213,14 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments used when shutdown has begun. + /// Event arguments for . /// [Serializable] public class ShutdownEventArgs : HResultEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// public ShutdownEventArgs(BOOTSTRAPPER_SHUTDOWN_ACTION action) { @@ -223,7 +239,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectBeginEventArgs(bool cached, RegistrationType registrationType, int packageCount, bool cancelRecommendation) : base(cancelRecommendation) { @@ -254,7 +273,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectForwardCompatibleBundleEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool missingFromCache, bool cancelRecommendation) : base(cancelRecommendation) { @@ -303,7 +325,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectUpdateBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectUpdateBeginEventArgs(string updateLocation, bool cancelRecommendation, bool skipRecommendation) : base(cancelRecommendation) { @@ -328,7 +353,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectUpdateEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectUpdateEventArgs(string updateLocation, long size, string hash, UpdateHashType hashAlgorithm, string version, string title, string summary, string contentType, string content, bool cancelRecommendation, bool stopRecommendation) : base(cancelRecommendation) { @@ -401,7 +429,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectUpdateCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectUpdateCompleteEventArgs(int hrStatus, bool ignoreRecommendation) : base(hrStatus) { @@ -420,7 +451,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectRelatedBundleEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectRelatedBundleEventArgs(string productCode, RelationType relationType, string bundleTag, bool perMachine, string version, bool missingFromCache, bool cancelRecommendation) : base(cancelRecommendation) { @@ -469,7 +503,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectPackageBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectPackageBeginEventArgs(string packageId, bool cancelRecommendation) : base(cancelRecommendation) { @@ -488,7 +525,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectCompatibleMsiPackageEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectCompatibleMsiPackageEventArgs(string packageId, string compatiblePackageId, string compatiblePackageVersion, bool cancelRecommendation) : base(cancelRecommendation) { @@ -519,7 +559,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectRelatedMsiPackageEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectRelatedMsiPackageEventArgs(string packageId, string upgradeCode, string productCode, bool perMachine, string version, RelatedOperation operation, bool cancelRecommendation) : base(cancelRecommendation) { @@ -568,12 +611,9 @@ namespace WixToolset.Mba.Core public class DetectPatchTargetEventArgs : CancellableHResultEventArgs { /// - /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// - /// - /// - /// public DetectPatchTargetEventArgs(string packageId, string productCode, PackageState state, bool cancelRecommendation) : base(cancelRecommendation) { @@ -603,7 +643,10 @@ namespace WixToolset.Mba.Core /// public class DetectMsiFeatureEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectMsiFeatureEventArgs(string packageId, string featureId, FeatureState state, bool cancelRecommendation) : base(cancelRecommendation) { @@ -629,12 +672,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments for . + /// Event arguments for . /// [Serializable] public class DetectPackageCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectPackageCompleteEventArgs(string packageId, int hrStatus, PackageState state, bool cached) : base(hrStatus) { @@ -660,16 +706,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments used when the detection phase has completed. + /// Event arguments used when the detection phase has completed. /// [Serializable] public class DetectCompleteEventArgs : StatusEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// The return code of the operation. - /// public DetectCompleteEventArgs(int hrStatus, bool eligibleForCleanup) : base(hrStatus) { @@ -688,7 +733,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanBeginEventArgs(int packageCount, bool cancelRecommendation) : base(cancelRecommendation) { @@ -707,7 +755,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanRelatedBundleEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanRelatedBundleEventArgs(string bundleId, RequestState recommendedState, RequestState state, bool cancelRecommendation) : base(cancelRecommendation) { @@ -738,7 +789,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanRelatedBundleTypeEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanRelatedBundleTypeEventArgs(string bundleId, RelatedBundlePlanType recommendedType, RelatedBundlePlanType type, bool cancelRecommendation) : base(cancelRecommendation) { @@ -769,7 +823,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanPackageBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanPackageBeginEventArgs(string packageId, PackageState currentState, bool cached, BOOTSTRAPPER_PACKAGE_CONDITION_RESULT installCondition, BOOTSTRAPPER_PACKAGE_CONDITION_RESULT repairCondition, RequestState recommendedState, BOOTSTRAPPER_CACHE_TYPE recommendedCacheType, RequestState state, BOOTSTRAPPER_CACHE_TYPE cacheType, bool cancelRecommendation) : base(cancelRecommendation) { @@ -836,7 +893,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanCompatibleMsiPackageBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanCompatibleMsiPackageBeginEventArgs(string packageId, string compatiblePackageId, string compatiblePackageVersion, bool recommendedRemove, bool requestRemove, bool cancelRecommendation) : base(cancelRecommendation) { @@ -879,7 +939,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanCompatibleMsiPackageCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanCompatibleMsiPackageCompleteEventArgs(string packageId, string compatiblePackageId, int hrStatus, bool requestedRemove) : base(hrStatus) { @@ -910,7 +973,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanRollbackBoundaryEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanRollbackBoundaryEventArgs(string rollbackBoundaryId, bool recommendedTransaction, bool transaction, bool cancelRecommendation) : base(cancelRecommendation) { @@ -944,13 +1010,9 @@ namespace WixToolset.Mba.Core public class PlanPatchTargetEventArgs : CancellableHResultEventArgs { /// - /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// - /// - /// - /// - /// public PlanPatchTargetEventArgs(string packageId, string productCode, RequestState recommendedState, RequestState state, bool cancelRecommendation) : base(cancelRecommendation) { @@ -987,7 +1049,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanMsiFeatureEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanMsiFeatureEventArgs(string packageId, string featureId, FeatureState recommendedState, FeatureState state, bool cancelRecommendation) : base(cancelRecommendation) { @@ -1024,7 +1089,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanMsiPackageEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanMsiPackageEventArgs(string packageId, bool shouldExecute, ActionState action, BOOTSTRAPPER_MSI_FILE_VERSIONING recommendedFileVersioning, bool cancelRecommendation, BURN_MSI_PROPERTY actionMsiProperty, INSTALLUILEVEL uiLevel, bool disableExternalUiHandler, BOOTSTRAPPER_MSI_FILE_VERSIONING fileVersioning) : base(cancelRecommendation) { @@ -1086,11 +1154,9 @@ namespace WixToolset.Mba.Core public class PlanPackageCompleteEventArgs : StatusEventArgs { /// - /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// - /// - /// public PlanPackageCompleteEventArgs(string packageId, int hrStatus, RequestState requested) : base(hrStatus) { @@ -1115,7 +1181,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlannedCompatiblePackageEventArgs : HResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlannedCompatiblePackageEventArgs(string packageId, string compatiblePackageId, bool remove) { this.PackageId = packageId; @@ -1145,7 +1214,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlannedPackageEventArgs : HResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlannedPackageEventArgs(string packageId, ActionState execute, ActionState rollback, bool cache, bool uncache) { this.PackageId = packageId; @@ -1182,15 +1254,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments used when the engine has completed planning the installation. + /// Event arguments for . /// [Serializable] public class PlanCompleteEventArgs : StatusEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// The return code of the operation. public PlanCompleteEventArgs(int hrStatus) : base(hrStatus) { @@ -1203,7 +1275,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanForwardCompatibleBundleEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool recommendedIgnoreBundle, bool cancelRecommendation, bool ignoreBundle) : base(cancelRecommendation) { @@ -1258,7 +1333,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ApplyBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ApplyBeginEventArgs(int phaseCount, bool cancelRecommendation) : base(cancelRecommendation) { @@ -1278,7 +1356,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ElevateBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ElevateBeginEventArgs(bool cancelRecommendation) : base(cancelRecommendation) { @@ -1286,15 +1367,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments used when the engine has completed starting the elevated process. + /// Event arguments for . /// [Serializable] public class ElevateCompleteEventArgs : StatusEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// The return code of the operation. public ElevateCompleteEventArgs(int hrStatus) : base(hrStatus) { @@ -1307,7 +1388,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ProgressEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ProgressEventArgs(int progressPercentage, int overallPercentage, bool cancelRecommendation) : base(cancelRecommendation) { @@ -1332,7 +1416,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ErrorEventArgs : ResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ErrorEventArgs(ErrorType errorType, string packageId, int errorCode, string errorMessage, int dwUIHint, string[] data, Result recommendation, Result result) : base(recommendation, result) { @@ -1381,7 +1468,10 @@ namespace WixToolset.Mba.Core [Serializable] public class RegisterBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public RegisterBeginEventArgs(RegistrationType recommendedRegistrationType, bool cancelRecommendation, RegistrationType registrationType) : base(cancelRecommendation) { @@ -1406,7 +1496,10 @@ namespace WixToolset.Mba.Core [Serializable] public class RegisterCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public RegisterCompleteEventArgs(int hrStatus) : base(hrStatus) { @@ -1419,7 +1512,10 @@ namespace WixToolset.Mba.Core [Serializable] public class UnregisterBeginEventArgs : HResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public UnregisterBeginEventArgs(RegistrationType recommendedRegistrationType, RegistrationType registrationType) { this.RecommendedRegistrationType = recommendedRegistrationType; @@ -1443,7 +1539,10 @@ namespace WixToolset.Mba.Core [Serializable] public class UnregisterCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public UnregisterCompleteEventArgs(int hrStatus) : base(hrStatus) { @@ -1456,7 +1555,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheBeginEventArgs(bool cancelRecommendation) : base(cancelRecommendation) { @@ -1469,7 +1571,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheAcquireBeginEventArgs : CancellableActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheAcquireBeginEventArgs(string packageOrContainerId, string payloadId, string source, string downloadUrl, string payloadContainerId, CacheOperation recommendation, CacheOperation action, bool cancelRecommendation) : base(cancelRecommendation, recommendation, action) { @@ -1512,7 +1617,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheAcquireProgressEventArgs : CacheProgressBaseEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheAcquireProgressEventArgs(string packageOrContainerId, string payloadId, long progress, long total, int overallPercentage, bool cancelRecommendation) : base(packageOrContainerId, payloadId, progress, total, overallPercentage, cancelRecommendation) { @@ -1525,7 +1633,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheAcquireCompleteEventArgs : ActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheAcquireCompleteEventArgs(string packageOrContainerId, string payloadId, int hrStatus, BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION recommendation, BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION action) : base(hrStatus, recommendation, action) { @@ -1550,7 +1661,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheVerifyBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheVerifyBeginEventArgs(string packageOrContainerId, string payloadId, bool cancelRecommendation) : base(cancelRecommendation) { @@ -1575,7 +1689,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheVerifyProgressEventArgs : CacheProgressBaseEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheVerifyProgressEventArgs(string packageOrContainerId, string payloadId, long progress, long total, int overallPercentage, CacheVerifyStep verifyStep, bool cancelRecommendation) : base(packageOrContainerId, payloadId, progress, total, overallPercentage, cancelRecommendation) { @@ -1594,7 +1711,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheVerifyCompleteEventArgs : ActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheVerifyCompleteEventArgs(string packageOrContainerId, string payloadId, int hrStatus, BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION recommendation, BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION action) : base(hrStatus, recommendation, action) { @@ -1614,15 +1734,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments used after the engine has cached the installation sources. + /// Event arguments for . /// [Serializable] public class CacheCompleteEventArgs : StatusEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// The return code of the operation. public CacheCompleteEventArgs(int hrStatus) : base(hrStatus) { @@ -1635,7 +1755,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ExecuteBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ExecuteBeginEventArgs(int packageCount, bool cancelRecommendation) : base(cancelRecommendation) { @@ -1654,7 +1777,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ExecutePackageBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ExecutePackageBeginEventArgs(string packageId, bool shouldExecute, ActionState action, INSTALLUILEVEL uiLevel, bool disableExternalUiHandler, bool cancelRecommendation) : base(cancelRecommendation) { @@ -1697,7 +1823,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ExecutePatchTargetEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ExecutePatchTargetEventArgs(string packageId, string targetProductCode, bool cancelRecommendation) : base(cancelRecommendation) { @@ -1722,7 +1851,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ExecuteMsiMessageEventArgs : ResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ExecuteMsiMessageEventArgs(string packageId, InstallMessage messageType, int dwUIHint, string message, string[] data, Result recommendation, Result result) : base(recommendation, result) { @@ -1765,7 +1897,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ExecuteFilesInUseEventArgs : ResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ExecuteFilesInUseEventArgs(string packageId, string[] files, Result recommendation, FilesInUseType source, Result result) : base(recommendation, result) { @@ -1792,12 +1927,14 @@ namespace WixToolset.Mba.Core /// /// Event arguments for - /// Additional arguments used when the engine has completed installing a specific package. /// [Serializable] public class ExecutePackageCompleteEventArgs : ActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ExecutePackageCompleteEventArgs(string packageId, int hrStatus, ApplyRestart restart, BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION recommendation, BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION action) : base(hrStatus, recommendation, action) { @@ -1817,15 +1954,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments used when the engine has completed installing packages. + /// Event arguments for . /// [Serializable] public class ExecuteCompleteEventArgs : StatusEventArgs { /// - /// Creates a new instance of the class. + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// The return code of the operation. public ExecuteCompleteEventArgs(int hrStatus) : base(hrStatus) { @@ -1838,7 +1975,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ApplyCompleteEventArgs : ActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ApplyCompleteEventArgs(int hrStatus, ApplyRestart restart, BOOTSTRAPPER_APPLYCOMPLETE_ACTION recommendation, BOOTSTRAPPER_APPLYCOMPLETE_ACTION action) : base(hrStatus, recommendation, action) { @@ -1857,7 +1997,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ApplyDowngradeEventArgs : HResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ApplyDowngradeEventArgs(int hrRecommendation, int hrStatus) { this.Recommendation = hrRecommendation; @@ -1881,7 +2024,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheAcquireResolvingEventArgs : CancellableActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheAcquireResolvingEventArgs(string packageOrContainerId, string payloadId, string[] searchPaths, bool foundLocal, int recommendedSearchPath, string downloadUrl, string payloadContainerId, CacheResolveOperation recommendation, int chosenSearchPath, CacheResolveOperation action, bool cancel) : base(cancel, recommendation, action) { @@ -1942,7 +2088,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CachePackageBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CachePackageBeginEventArgs(string packageId, int cachePayloads, long packageCacheSize, bool vital, bool cancelRecommendation) : base(cancelRecommendation) { @@ -1979,7 +2128,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CachePackageCompleteEventArgs : ActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CachePackageCompleteEventArgs(string packageId, int hrStatus, BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION recommendation, BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION action) : base(hrStatus, recommendation, action) { @@ -1998,7 +2150,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ExecuteProgressEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ExecuteProgressEventArgs(string packageId, int progressPercentage, int overallPercentage, bool cancelRecommendation) : base(cancelRecommendation) { @@ -2024,12 +2179,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine before it tries to launch the preapproved executable. + /// Event arguments for . /// [Serializable] public class LaunchApprovedExeBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public LaunchApprovedExeBeginEventArgs(bool cancelRecommendation) : base(cancelRecommendation) { @@ -2037,12 +2195,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine after it finished trying to launch the preapproved executable. + /// Event arguments for . /// [Serializable] public class LaunchApprovedExeCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public LaunchApprovedExeCompleteEventArgs(int hrStatus, int processId) : base(hrStatus) { @@ -2057,12 +2218,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine before beginning an MSI transaction. + /// Event arguments for . /// [Serializable] public class BeginMsiTransactionBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public BeginMsiTransactionBeginEventArgs(string transactionId, bool cancelRecommendation) : base(cancelRecommendation) { @@ -2076,12 +2240,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine after beginning an MSI transaction. + /// Event arguments for . /// [Serializable] public class BeginMsiTransactionCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public BeginMsiTransactionCompleteEventArgs(string transactionId, int hrStatus) : base(hrStatus) { @@ -2095,12 +2262,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine before committing an MSI transaction. + /// Event arguments for . /// [Serializable] public class CommitMsiTransactionBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CommitMsiTransactionBeginEventArgs(string transactionId, bool cancelRecommendation) : base(cancelRecommendation) { @@ -2114,12 +2284,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine after committing an MSI transaction. + /// Event arguments for . /// [Serializable] public class CommitMsiTransactionCompleteEventArgs : ActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CommitMsiTransactionCompleteEventArgs(string transactionId, int hrStatus, ApplyRestart restart, BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION recommendation, BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION action) : base(hrStatus, recommendation, action) { @@ -2139,12 +2312,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine before rolling back an MSI transaction. + /// Event arguments for . /// [Serializable] public class RollbackMsiTransactionBeginEventArgs : HResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public RollbackMsiTransactionBeginEventArgs(string transactionId) { this.TransactionId = transactionId; @@ -2157,12 +2333,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine after rolling back an MSI transaction. + /// Event arguments for . /// [Serializable] public class RollbackMsiTransactionCompleteEventArgs : ActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public RollbackMsiTransactionCompleteEventArgs(string transactionId, int hrStatus, ApplyRestart restart, BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION recommendation, BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION action) : base(hrStatus, recommendation, action) { @@ -2182,13 +2361,14 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine before pausing Windows automatic updates. + /// Event arguments for . /// [Serializable] public class PauseAutomaticUpdatesBeginEventArgs : HResultEventArgs { /// - /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// public PauseAutomaticUpdatesBeginEventArgs() { @@ -2196,15 +2376,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine after pausing Windows automatic updates. + /// Event arguments for . /// [Serializable] public class PauseAutomaticUpdatesCompleteEventArgs : StatusEventArgs { /// - /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// public PauseAutomaticUpdatesCompleteEventArgs(int hrStatus) : base(hrStatus) { @@ -2212,13 +2392,14 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine before taking a system restore point. + /// Event arguments for . /// [Serializable] public class SystemRestorePointBeginEventArgs : HResultEventArgs { /// - /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// public SystemRestorePointBeginEventArgs() { @@ -2226,15 +2407,15 @@ namespace WixToolset.Mba.Core } /// - /// Additional arguments passed by the engine after taking a system restore point. + /// Event arguments for . /// [Serializable] public class SystemRestorePointCompleteEventArgs : StatusEventArgs { /// - /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. /// - /// public SystemRestorePointCompleteEventArgs(int hrStatus) : base(hrStatus) { @@ -2247,7 +2428,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheContainerOrPayloadVerifyBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheContainerOrPayloadVerifyBeginEventArgs(string packageOrContainerId, string payloadId, bool cancelRecommendation) : base(cancelRecommendation) { @@ -2272,7 +2456,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheContainerOrPayloadVerifyProgressEventArgs : CacheProgressBaseEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheContainerOrPayloadVerifyProgressEventArgs(string packageOrContainerId, string payloadId, long progress, long total, int overallPercentage, bool cancelRecommendation) : base(packageOrContainerId, payloadId, progress, total, overallPercentage, cancelRecommendation) { @@ -2285,7 +2472,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CacheContainerOrPayloadVerifyCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CacheContainerOrPayloadVerifyCompleteEventArgs(string packageOrContainerId, string payloadId, int hrStatus) : base(hrStatus) { @@ -2310,7 +2500,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CachePayloadExtractBeginEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CachePayloadExtractBeginEventArgs(string containerId, string payloadId, bool cancelRecommendation) : base(cancelRecommendation) { @@ -2335,7 +2528,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CachePayloadExtractProgressEventArgs : CacheProgressBaseEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CachePayloadExtractProgressEventArgs(string containerId, string payloadId, long progress, long total, int overallPercentage, bool cancelRecommendation) : base(containerId, payloadId, progress, total, overallPercentage, cancelRecommendation) { @@ -2348,7 +2544,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CachePayloadExtractCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CachePayloadExtractCompleteEventArgs(string containerId, string payloadId, int hrStatus) : base(hrStatus) { @@ -2373,7 +2572,10 @@ namespace WixToolset.Mba.Core [Serializable] public class SetUpdateBeginEventArgs : HResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public SetUpdateBeginEventArgs() { } @@ -2385,7 +2587,10 @@ namespace WixToolset.Mba.Core [Serializable] public class SetUpdateCompleteEventArgs : StatusEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public SetUpdateCompleteEventArgs(int hrStatus, string previousPackageId, string newPackageId) : base(hrStatus) { @@ -2410,7 +2615,10 @@ namespace WixToolset.Mba.Core [Serializable] public class PlanRestoreRelatedBundleEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public PlanRestoreRelatedBundleEventArgs(string bundleId, RequestState recommendedState, RequestState state, bool cancelRecommendation) : base(cancelRecommendation) { @@ -2441,7 +2649,10 @@ namespace WixToolset.Mba.Core [Serializable] public class ExecuteProcessCancelEventArgs : HResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public ExecuteProcessCancelEventArgs(string packageId, int processId, BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION recommendation, BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION action) { this.PackageId = packageId; @@ -2477,7 +2688,10 @@ namespace WixToolset.Mba.Core [Serializable] public class DetectRelatedBundlePackageEventArgs : CancellableHResultEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public DetectRelatedBundlePackageEventArgs(string packageId, string productCode, RelationType relationType, bool perMachine, string version, bool cancelRecommendation) : base(cancelRecommendation) { @@ -2520,7 +2734,10 @@ namespace WixToolset.Mba.Core [Serializable] public class CachePackageNonVitalValidationFailureEventArgs : ActionEventArgs { - /// + /// + /// This class is for events raised by the engine. + /// It is not intended to be instantiated by user code. + /// public CachePackageNonVitalValidationFailureEventArgs(string packageId, int hrStatus, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION recommendation, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION action) : base(hrStatus, recommendation, action) { diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs index 7bfabeb3..36c7fd33 100644 --- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs +++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs @@ -65,14 +65,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnDetectForwardCompatibleBundle( @@ -88,10 +80,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnDetectUpdateBegin( @@ -103,18 +91,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnDetectUpdate( @@ -134,9 +110,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnDetectUpdateComplete( @@ -162,9 +135,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnDetectPackageBegin( @@ -202,11 +172,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnDetectPatchTarget( @@ -219,11 +184,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnDetectMsiFeature( @@ -248,9 +208,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnDetectComplete( @@ -261,9 +218,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnPlanBegin( @@ -342,12 +296,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnPlanPatchTarget( @@ -361,12 +309,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnPlanMsiFeature( @@ -397,10 +339,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnPlanPackageComplete( @@ -436,8 +374,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnPlanComplete( @@ -447,9 +383,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnApplyBegin( @@ -460,8 +393,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnElevateBegin( @@ -471,8 +402,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnElevateComplete( @@ -482,10 +411,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnProgress( @@ -497,16 +422,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnError( @@ -535,8 +450,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnRegisterComplete( @@ -546,8 +459,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnCacheBegin( @@ -695,9 +606,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnExecuteBegin( @@ -708,13 +616,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnExecutePackageBegin( @@ -729,10 +630,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnExecutePatchTarget( @@ -744,11 +641,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnExecuteProgress( @@ -761,15 +653,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnExecuteMsiMessage( @@ -800,12 +683,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnExecutePackageComplete( @@ -819,8 +696,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnExecuteComplete( @@ -840,8 +715,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnUnregisterComplete( @@ -851,11 +724,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnApplyComplete( @@ -868,8 +736,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnLaunchApprovedExeBegin( @@ -879,9 +745,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnLaunchApprovedExeComplete( @@ -892,9 +755,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnBeginMsiTransactionBegin( @@ -905,9 +765,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnBeginMsiTransactionComplete( @@ -918,9 +775,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnCommitMsiTransactionBegin( @@ -931,12 +785,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnCommitMsiTransactionComplete( @@ -950,8 +798,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnRollbackMsiTransactionBegin( @@ -961,12 +807,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnRollbackMsiTransactionComplete( @@ -980,7 +820,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnPauseAutomaticUpdatesBegin( @@ -989,8 +828,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnPauseAutomaticUpdatesComplete( @@ -1000,7 +837,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnSystemRestorePointBegin( @@ -1009,8 +845,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnSystemRestorePointComplete( @@ -1020,15 +854,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// - /// - /// - /// - /// [PreserveSig] [return: MarshalAs(UnmanagedType.I4)] int OnPlanForwardCompatibleBundle( @@ -1211,27 +1036,27 @@ namespace WixToolset.Mba.Core public enum Display { /// - /// + /// Invalid value. /// Unknown, /// - /// + /// The bundle is being run through the Burn protocol by an external application. /// Embedded, /// - /// + /// No UI should be shown. /// None, /// - /// + /// The UI should not require any interaction from the user. /// Passive, /// - /// + /// The UI should be fully interactive. /// Full, } @@ -1343,27 +1168,27 @@ namespace WixToolset.Mba.Core public enum Restart { /// - /// + /// Invalid value. /// Unknown, /// - /// + /// The bundle should never initiate a restart. /// Never, /// - /// + /// The bundle should prompt the user whether to restart. /// Prompt, /// - /// + /// The bundle should restart if necessary. /// Automatic, /// - /// + /// The bundle should always restart when given the option. /// Always, } @@ -1396,67 +1221,67 @@ namespace WixToolset.Mba.Core public enum Result { /// - /// + /// An error occurred. /// Error = -1, /// - /// + /// Invalid value. /// None, /// - /// + /// IDOK /// Ok, /// - /// + /// IDCANCEL /// Cancel, /// - /// + /// IDABORT /// Abort, /// - /// + /// IDRETRY /// Retry, /// - /// + /// IDIGNORE /// Ignore, /// - /// + /// IDYES /// Yes, /// - /// + /// IDNO /// No, /// - /// / + /// IDCLOSE /// Close, /// - /// + /// IDHELP /// Help, /// - /// + /// IDTRYAGAIN /// TryAgain, /// - /// + /// IDCONTINUE /// Continue, } @@ -1467,7 +1292,7 @@ namespace WixToolset.Mba.Core public enum ResumeType { /// - /// + /// No resume information. /// None, @@ -1553,12 +1378,12 @@ namespace WixToolset.Mba.Core } /// - /// The calculated operation for the related bundle. + /// The calculated operation for the related MSI package. /// public enum RelatedOperation { /// - /// + /// No relation. /// None, @@ -1697,47 +1522,55 @@ namespace WixToolset.Mba.Core public enum RelationType { /// - /// + /// No relation. /// None, /// - /// + /// The related bundle is detected by the running bundle. + /// This relationship is reversed for /// Detect, /// - /// + /// The related bundle shares an upgrade code with the running bundle. + /// This relationship is reversed for /// Upgrade, /// - /// + /// The related bundle is an add-on for the running bundle. + /// This relationship is reversed for /// Addon, /// - /// + /// The related bundle is a patch for the running bundle. + /// This relationship is reversed for /// Patch, /// - /// + /// The running bundle is an add-on for the related bundle. + /// This relationship is reversed for /// DependentAddon, /// - /// + /// The running bundle is a patch for the related bundle. + /// This relationship is reversed for /// DependentPatch, /// - /// + /// The related bundle is a newer version of the running bundle. + /// This relationship is reversed for /// Update, /// - /// + /// The related bundle is in the running bundle's chain. + /// This relationship is reversed for /// ChainPackage, } @@ -1748,37 +1581,37 @@ namespace WixToolset.Mba.Core public enum RelatedBundlePlanType { /// - /// + /// Don't execute the related bundle. /// None, /// - /// + /// The running bundle is a downgrade for the related bundle. /// Downgrade, /// - /// + /// The running bundle is an upgrade for the related bundle. /// Upgrade, /// - /// + /// The related bundle is an add-on of the running bundle. /// Addon, /// - /// + /// The related bundle is a patch for the running bundle. /// Patch, /// - /// + /// The running bundle is an add-on for the related bundle. /// DependentAddon, /// - /// + /// The running bundle is a patch for the related bundle. /// DependentPatch, } @@ -1816,7 +1649,7 @@ namespace WixToolset.Mba.Core public enum BOOTSTRAPPER_APPLYCOMPLETE_ACTION { /// - /// + /// Instructs the engine to not take any special action. /// None, @@ -1855,7 +1688,7 @@ namespace WixToolset.Mba.Core public enum BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION { /// - /// + /// Instructs the engine to not take any special action. /// None, @@ -1872,7 +1705,7 @@ namespace WixToolset.Mba.Core public enum BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION { /// - /// + /// Instructs the engine to not take any special action. /// None, @@ -1895,7 +1728,7 @@ namespace WixToolset.Mba.Core public enum BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION { /// - /// + /// Instructs the engine to not take any special action. /// None, @@ -1912,7 +1745,7 @@ namespace WixToolset.Mba.Core public enum BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION { /// - /// + /// Instructs the engine to not take any special action. /// None, @@ -1933,7 +1766,7 @@ namespace WixToolset.Mba.Core public enum BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION { /// - /// + /// Instructs the engine to not take any special action. /// None, @@ -1967,7 +1800,7 @@ namespace WixToolset.Mba.Core public enum BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION { /// - /// + /// Instructs the engine to not take any special action. /// None, @@ -2046,7 +1879,7 @@ namespace WixToolset.Mba.Core public enum BOOTSTRAPPER_SHUTDOWN_ACTION { /// - /// + /// Instructs the engine to not take any special action. /// None, diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplicationFactory.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplicationFactory.cs index 64e25ff4..2e84de67 100644 --- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplicationFactory.cs +++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplicationFactory.cs @@ -7,7 +7,7 @@ namespace WixToolset.Mba.Core using System.Runtime.InteropServices; /// - /// Interface used by WixToolset.Mba.Host to dynamically load the BA. + /// Interface used by the native host to dynamically load the BA. /// [ComVisible(true)] [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperEngine.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperEngine.cs index eca8dda1..25ce52df 100644 --- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperEngine.cs +++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperEngine.cs @@ -19,7 +19,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// void GetPackageCount( [MarshalAs(UnmanagedType.U4)] out int pcPackages ); @@ -27,9 +26,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// [PreserveSig] int GetVariableNumeric( [MarshalAs(UnmanagedType.LPWStr)] string wzVariable, @@ -79,8 +75,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// void EvaluateCondition( [MarshalAs(UnmanagedType.LPWStr)] string wzCondition, [MarshalAs(UnmanagedType.Bool)] out bool pf @@ -89,8 +83,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// void Log( [MarshalAs(UnmanagedType.U4)] LogLevel level, [MarshalAs(UnmanagedType.LPWStr)] string wzMessage @@ -99,10 +91,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// void SendEmbeddedError( [MarshalAs(UnmanagedType.U4)] int dwErrorCode, [MarshalAs(UnmanagedType.LPWStr)] string wzMessage, @@ -113,9 +101,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// void SendEmbeddedProgress( [MarshalAs(UnmanagedType.U4)] int dwProgressPercentage, [MarshalAs(UnmanagedType.U4)] int dwOverallProgressPercentage, @@ -125,11 +110,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// void SetUpdate( [MarshalAs(UnmanagedType.LPWStr)] string wzLocalSource, [MarshalAs(UnmanagedType.LPWStr)] string wzDownloadSource, @@ -141,9 +121,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// void SetLocalSource( [MarshalAs(UnmanagedType.LPWStr)] string wzPackageOrContainerId, [MarshalAs(UnmanagedType.LPWStr)] string wzPayloadId, @@ -153,11 +130,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// - /// void SetDownloadSource( [MarshalAs(UnmanagedType.LPWStr)] string wzPackageOrContainerId, [MarshalAs(UnmanagedType.LPWStr)] string wzPayloadId, @@ -169,8 +141,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// void SetVariableNumeric( [MarshalAs(UnmanagedType.LPWStr)] string wzVariable, long llValue @@ -179,9 +149,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// void SetVariableString( [MarshalAs(UnmanagedType.LPWStr)] string wzVariable, IntPtr wzValue, @@ -191,8 +158,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// void SetVariableVersion( [MarshalAs(UnmanagedType.LPWStr)] string wzVariable, IntPtr wzValue @@ -206,7 +171,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// void Detect( IntPtr hwndParent ); @@ -214,7 +178,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// void Plan( [MarshalAs(UnmanagedType.U4)] LaunchAction action ); @@ -222,8 +185,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// [PreserveSig] int Elevate( IntPtr hwndParent @@ -232,7 +193,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// void Apply( IntPtr hwndParent ); @@ -240,7 +200,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// void Quit( [MarshalAs(UnmanagedType.U4)] int dwExitCode ); @@ -248,10 +207,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// - /// void LaunchApprovedExe( IntPtr hwndParent, [MarshalAs(UnmanagedType.LPWStr)] string wzApprovedExeForElevationId, @@ -262,7 +217,6 @@ namespace WixToolset.Mba.Core /// /// Sets the URL to the update feed. /// - /// URL of the update feed. void SetUpdateSource( [MarshalAs(UnmanagedType.LPWStr)] string url ); @@ -270,9 +224,6 @@ namespace WixToolset.Mba.Core /// /// See . /// - /// - /// - /// void CompareVersions( [MarshalAs(UnmanagedType.LPWStr)] string wzVersion1, [MarshalAs(UnmanagedType.LPWStr)] string wzVersion2, @@ -297,93 +248,94 @@ namespace WixToolset.Mba.Core public enum ActionState { /// - /// + /// No action. /// None, /// - /// + /// Uninstall action. /// Uninstall, /// - /// + /// Install action. /// Install, /// - /// + /// Modify action. /// Modify, /// - /// + /// Repair action. /// Repair, /// - /// + /// Minor upgrade action. /// MinorUpgrade, } /// - /// The action for the BA to perform. + /// The action for the bundle to perform. /// public enum LaunchAction { /// - /// + /// Invalid action. /// Unknown, /// - /// + /// Provide help information. /// Help, /// - /// + /// Layout the bundle on disk, normally to prepare for offline installation. /// Layout, /// - /// + /// Same as Uninstall, except it will always remove itself from the package cache and Add/Remove Programs. + /// This should only be used to remove corrupt bundles since it might not properly clean up its packages. /// UnsafeUninstall, /// - /// + /// Uninstall the bundle. /// Uninstall, /// - /// + /// Cache the bundle and its packages. /// Cache, /// - /// + /// Install the bundle. /// Install, /// - /// + /// Modify the bundle. /// Modify, /// - /// + /// Repair the bundle /// Repair, /// - /// + /// Launch the update registered with and then exit without waiting for it to complete. /// UpdateReplace, /// - /// + /// Launch the update registered with as an embedded bundle. /// UpdateReplaceEmbedded, } @@ -441,32 +393,32 @@ namespace WixToolset.Mba.Core public enum PackageState { /// - /// + /// Invalid state. /// Unknown, /// - /// + /// The package is not on the machine (except possibly MspPackage) and should not be installed. /// Obsolete, /// - /// + /// The package is not installed. /// Absent, /// - /// + /// The package is not installed but is in the package cache. /// Cached, /// - /// + /// The package is installed. /// Present, /// - /// + /// The package is on the machine but not active, so only uninstall operations are allowed. /// Superseded, } @@ -477,68 +429,70 @@ namespace WixToolset.Mba.Core public enum RequestState { /// - /// + /// No change requested. /// None, /// - /// / + /// As long as there are no dependents, the package will be uninstalled. + /// There are some packages that can't be uninstalled, such as an ExePackage without an UninstallCommand. /// ForceAbsent, /// - /// + /// Request the package to not be installed on the machine. /// Absent, /// - /// + /// Request the package to be cached and not be installed on the machine. /// Cache, /// - /// + /// Request the package to be installed on the machine. /// Present, /// - /// + /// Force the bundle to install the package. /// ForcePresent, /// - /// + /// Request the package to be repaired. /// Repair, } /// /// Indicates the state of a feature. + /// See https://learn.microsoft.com/en-us/windows/win32/api/msi/nf-msi-msiqueryfeaturestatew. /// public enum FeatureState { /// - /// + /// Invalid state. /// Unknown, /// - /// + /// INSTALLSTATE_ABSENT /// Absent, /// - /// + /// INSTALLSTATE_ADVERTISED /// Advertised, /// - /// + /// INSTALLSTATE_LOCAL /// Local, /// - /// + /// INSTALLSTATE_SOURCE /// Source, } diff --git a/src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs b/src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs index 3227b72d..951f511a 100644 --- a/src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs +++ b/src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs @@ -10,27 +10,27 @@ namespace WixToolset.Mba.Core public interface IBundleInfo { /// - /// + /// The name of the variable that contains the path to the bundle's log. /// string LogVariable { get; } /// - /// + /// Bundle/@Name /// string Name { get; } /// - /// + /// Variables that were marked with bal:Overridable="yes". /// IOverridableVariables OverridableVariables { get; } /// - /// + /// The packages in the bundle's chain. /// IDictionary Packages { get; } /// - /// + /// Whether the bundle is per-machine or per-user. /// bool PerMachine { get; } @@ -48,4 +48,4 @@ namespace WixToolset.Mba.Core /// The created . IPackageInfo AddUpdateBundleAsPackage(SetUpdateCompleteEventArgs e); } -} \ No newline at end of file +} diff --git a/src/api/burn/WixToolset.Mba.Core/IPackageInfo.cs b/src/api/burn/WixToolset.Mba.Core/IPackageInfo.cs index c6285f03..b1036143 100644 --- a/src/api/burn/WixToolset.Mba.Core/IPackageInfo.cs +++ b/src/api/burn/WixToolset.Mba.Core/IPackageInfo.cs @@ -8,7 +8,7 @@ namespace WixToolset.Mba.Core public interface IPackageInfo { /// - /// + /// The authored cache strategy for this package. /// BOOTSTRAPPER_CACHE_TYPE CacheType { get; } @@ -18,82 +18,82 @@ namespace WixToolset.Mba.Core object CustomData { get; set; } /// - /// + /// The package's description. /// string Description { get; } /// - /// + /// The authored bal:DisplayInternalUICondition. /// string DisplayInternalUICondition { get; } /// - /// + /// The package's display name. /// string DisplayName { get; } /// - /// + /// The package's Id. /// string Id { get; } /// - /// + /// The authored InstallCondition. /// string InstallCondition { get; } /// - /// + /// The authored RepairCondition. /// string RepairCondition { get; } /// - /// + /// Whether the bundle should ever recommend the package to be uninstalled. /// bool Permanent { get; } /// - /// + /// Whether the package should be installed by the prereq BA for managed bootstrapper applications. /// bool PrereqPackage { get; } /// - /// + /// The file name of the license file to be shown by the prereq BA. /// string PrereqLicenseFile { get; } /// - /// + /// The URL of the license to be shown by the prereq BA. /// string PrereqLicenseUrl { get; } /// - /// See + /// See /// PrimaryPackageType PrimaryPackageType { get; } /// - /// + /// The package's ProductCode. /// string ProductCode { get; } /// - /// + /// The type of the package. /// PackageType Type { get; } /// - /// + /// The package's UpgradeCode. /// string UpgradeCode { get; } /// - /// + /// The package's version. /// string Version { get; } /// - /// + /// Whether the package's failure can be ignored while executing the chain. /// bool Vital { get; } } diff --git a/src/api/burn/WixToolset.Mba.Core/PackageInfo.cs b/src/api/burn/WixToolset.Mba.Core/PackageInfo.cs index 3fa1b49e..c6373647 100644 --- a/src/api/burn/WixToolset.Mba.Core/PackageInfo.cs +++ b/src/api/burn/WixToolset.Mba.Core/PackageInfo.cs @@ -8,57 +8,57 @@ namespace WixToolset.Mba.Core using System.Xml.XPath; /// - /// + /// The type of package. /// public enum PackageType { /// - /// + /// Invalid type. /// Unknown, /// - /// + /// ExePackage /// Exe, /// - /// + /// MsiPackage /// Msi, /// - /// + /// MspPackage /// Msp, /// - /// + /// MsuPackage /// Msu, /// - /// + /// Related bundle of type Upgrade /// UpgradeBundle, /// - /// + /// Related bundle of type Addon /// AddonBundle, /// - /// + /// Related bundle of type Patch /// PatchBundle, /// - /// + /// Related bundle of type Update /// UpdateBundle, /// - /// + /// BundlePackage /// ChainBundle, } @@ -156,10 +156,10 @@ namespace WixToolset.Mba.Core internal PackageInfo() { } /// - /// + /// Parse packages from BootstrapperApplicationData.xml. /// - /// - /// + /// The root node. + /// A dictionary of the packages by Id. public static IDictionary ParsePackagesFromXml(XPathNavigator root) { var packagesById = new Dictionary(); @@ -213,6 +213,13 @@ namespace WixToolset.Mba.Core package.RepairCondition = BootstrapperApplicationData.GetAttribute(node, "RepairCondition"); + BOOTSTRAPPER_CACHE_TYPE? cacheType = GetCacheTypeAttribute(node, "Cache"); + if (!cacheType.HasValue) + { + throw new Exception("Failed to get cache type for package."); + } + package.CacheType = cacheType.Value; + packagesById.Add(package.Id, package); } @@ -221,11 +228,11 @@ namespace WixToolset.Mba.Core } /// - /// + /// Parse the cache type attribute. /// - /// - /// - /// + /// Package node + /// Attribute name + /// The cache type public static BOOTSTRAPPER_CACHE_TYPE? GetCacheTypeAttribute(XPathNavigator node, string attributeName) { string attributeValue = BootstrapperApplicationData.GetAttribute(node, attributeName); @@ -250,11 +257,11 @@ namespace WixToolset.Mba.Core } /// - /// + /// Parse the package type attribute /// - /// - /// - /// + /// Package node + /// Attribute name + /// The package type public static PackageType? GetPackageTypeAttribute(XPathNavigator node, string attributeName) { string attributeValue = BootstrapperApplicationData.GetAttribute(node, attributeName); @@ -291,13 +298,13 @@ namespace WixToolset.Mba.Core } /// - /// + /// Create from a related bundle. /// - /// - /// - /// - /// - /// + /// Package id + /// Relation type + /// Whether the related bundle is per-machine + /// The related bundle's version + /// The package info public static IPackageInfo GetRelatedBundleAsPackage(string id, RelationType relationType, bool perMachine, string version) { PackageInfo package = new PackageInfo(); @@ -323,10 +330,10 @@ namespace WixToolset.Mba.Core } /// - /// + /// Create from an update bundle. /// - /// - /// + /// Package id + /// The package info public static IPackageInfo GetUpdateBundleAsPackage(string id) { PackageInfo package = new PackageInfo(); diff --git a/src/api/burn/WixToolset.Mba.Core/VerUtil.cs b/src/api/burn/WixToolset.Mba.Core/VerUtil.cs index 14552310..3573f9d3 100644 --- a/src/api/burn/WixToolset.Mba.Core/VerUtil.cs +++ b/src/api/burn/WixToolset.Mba.Core/VerUtil.cs @@ -110,10 +110,10 @@ namespace WixToolset.Mba.Core } /// - /// + /// Clone the version. /// - /// - /// + /// Source version + /// Cloned version public static VerUtilVersion CopyVersion(VerUtilVersion version) { var handle = VerCopyVersion(version.GetHandle()); @@ -121,11 +121,11 @@ namespace WixToolset.Mba.Core } /// - /// + /// Parse a version. /// - /// + /// Source version /// Whether to throw exception on invalid version. - /// + /// Parsed version public static VerUtilVersion ParseVersion(string version, bool strict) { var handle = VerParseVersion(version, 0, strict); @@ -133,10 +133,10 @@ namespace WixToolset.Mba.Core } /// - /// + /// Parse version from qword. /// - /// - /// + /// Source version + /// Parsed version public static VerUtilVersion VersionFromQword(long version) { var handle = VerVersionFromQword(version); diff --git a/src/api/burn/test/WixToolsetTest.Mba.Core/VerUtilFixture.cs b/src/api/burn/test/WixToolsetTest.Mba.Core/VerUtilFixture.cs index 6fb8aced..9c213945 100644 --- a/src/api/burn/test/WixToolsetTest.Mba.Core/VerUtilFixture.cs +++ b/src/api/burn/test/WixToolsetTest.Mba.Core/VerUtilFixture.cs @@ -45,7 +45,7 @@ namespace WixToolsetTest.Mba.Core public void CanCreateFromQword() { var version = new Version(100, 200, 300, 400); - var qwVersion = Engine.VersionToLong(version); + var qwVersion = VersionToLong(version); using var parsedVersion = VerUtil.VersionFromQword(qwVersion); Assert.Equal("100.200.300.400", parsedVersion.Version); @@ -99,5 +99,17 @@ namespace WixToolsetTest.Mba.Core Assert.True(parsedVersion.ReleaseLabels[4].IsNumeric); Assert.Equal(5u, parsedVersion.ReleaseLabels[4].Value); } + + private static long VersionToLong(Version version) + { + // In Windows, each version component has a max value of 65535, + // so we truncate the version before shifting it, which will overflow if invalid. + long major = (long)(ushort)version.Major << 48; + long minor = (long)(ushort)version.Minor << 32; + long build = (long)(ushort)version.Build << 16; + long revision = (long)(ushort)version.Revision; + + return major | minor | build | revision; + } } } -- cgit v1.2.3-55-g6feb