@joebigelow / wix-1 / commits / a46ef0ee

Finish the XML documentation in WixToolset.Mba.Core.

4623

Sean Hall committed Jan 19, 2023 at 00:18 UTC a46ef0eebafea0e5b38c0c6e960be778c2dbb852
14 files changed +555 -624
src/api/burn/WixToolset.Mba.Core/BaseBootstrapperApplicationFactory.cs
+2 -2
@@ -13,8 +13,8 @@ namespace WixToolset.Mba.Core
13 /// <summary>
14 /// Default implementation of <see cref="IBootstrapperApplicationFactory.Create(IntPtr, IntPtr)"/>
15 /// </summary>
16 - /// <param name="pArgs"></param>
17 - /// <param name="pResults"></param>
16 + /// <param name="pArgs">The args struct given by the engine when initially creating the BA.</param>
17 + /// <param name="pResults">The results struct given by the engine when initially creating the BA</param>
18 public void Create(IntPtr pArgs, IntPtr pResults)
19 {
20 InitializeFromCreateArgs(pArgs, out var engine, out var bootstrapperCommand);
src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
+19 -17
@@ -798,7 +798,7 @@ namespace WixToolset.Mba.Core
798 /// <summary>
799 /// Called by the engine, raises the <see cref="CacheBegin"/> event.
800 /// </summary>
801 - /// <param name="args"></param>
801 + /// <param name="args">Additional arguments for this event.</param>
802 protected virtual void OnCacheBegin(CacheBeginEventArgs args)
803 {
804 EventHandler<CacheBeginEventArgs> handler = this.CacheBegin;
@@ -811,7 +811,7 @@ namespace WixToolset.Mba.Core
811 /// <summary>
812 /// Called by the engine, raises the <see cref="CachePackageBegin"/> event.
813 /// </summary>
814 - /// <param name="args"></param>
814 + /// <param name="args">Additional arguments for this event.</param>
815 protected virtual void OnCachePackageBegin(CachePackageBeginEventArgs args)
816 {
817 EventHandler<CachePackageBeginEventArgs> handler = this.CachePackageBegin;
@@ -824,7 +824,7 @@ namespace WixToolset.Mba.Core
824 /// <summary>
825 /// Called by the engine, raises the <see cref="CacheAcquireBegin"/> event.
826 /// </summary>
827 - /// <param name="args"></param>
827 + /// <param name="args">Additional arguments for this event.</param>
828 protected virtual void OnCacheAcquireBegin(CacheAcquireBeginEventArgs args)
829 {
830 EventHandler<CacheAcquireBeginEventArgs> handler = this.CacheAcquireBegin;
@@ -837,7 +837,7 @@ namespace WixToolset.Mba.Core
837 /// <summary>
838 /// Called by the engine, raises the <see cref="CacheAcquireProgress"/> event.
839 /// </summary>
840 - /// <param name="args"></param>
840 + /// <param name="args">Additional arguments for this event.</param>
841 protected virtual void OnCacheAcquireProgress(CacheAcquireProgressEventArgs args)
842 {
843 EventHandler<CacheAcquireProgressEventArgs> handler = this.CacheAcquireProgress;
@@ -863,7 +863,7 @@ namespace WixToolset.Mba.Core
863 /// <summary>
864 /// Called by the engine, raises the <see cref="CacheAcquireComplete"/> event.
865 /// </summary>
866 - /// <param name="args"></param>
866 + /// <param name="args">Additional arguments for this event.</param>
867 protected virtual void OnCacheAcquireComplete(CacheAcquireCompleteEventArgs args)
868 {
869 EventHandler<CacheAcquireCompleteEventArgs> handler = this.CacheAcquireComplete;
@@ -876,7 +876,7 @@ namespace WixToolset.Mba.Core
876 /// <summary>
877 /// Called by the engine, raises the <see cref="CacheVerifyBegin"/> event.
878 /// </summary>
879 - /// <param name="args"></param>
879 + /// <param name="args">Additional arguments for this event.</param>
880 protected virtual void OnCacheVerifyBegin(CacheVerifyBeginEventArgs args)
881 {
882 EventHandler<CacheVerifyBeginEventArgs> handler = this.CacheVerifyBegin;
@@ -889,7 +889,7 @@ namespace WixToolset.Mba.Core
889 /// <summary>
890 /// Called by the engine, raises the <see cref="CacheVerifyProgress"/> event.
891 /// </summary>
892 - /// <param name="args"></param>
892 + /// <param name="args">Additional arguments for this event.</param>
893 protected virtual void OnCacheVerifyProgress(CacheVerifyProgressEventArgs args)
894 {
895 EventHandler<CacheVerifyProgressEventArgs> handler = this.CacheVerifyProgress;
@@ -902,7 +902,7 @@ namespace WixToolset.Mba.Core
902 /// <summary>
903 /// Called by the engine, raises the <see cref="CacheVerifyComplete"/> event.
904 /// </summary>
905 - /// <param name="args"></param>
905 + /// <param name="args">Additional arguments for this event.</param>
906 protected virtual void OnCacheVerifyComplete(CacheVerifyCompleteEventArgs args)
907 {
908 EventHandler<CacheVerifyCompleteEventArgs> handler = this.CacheVerifyComplete;
@@ -915,7 +915,7 @@ namespace WixToolset.Mba.Core
915 /// <summary>
916 /// Called by the engine, raises the <see cref="CachePackageComplete"/> event.
917 /// </summary>
918 - /// <param name="args"></param>
918 + /// <param name="args">Additional arguments for this event.</param>
919 protected virtual void OnCachePackageComplete(CachePackageCompleteEventArgs args)
920 {
921 EventHandler<CachePackageCompleteEventArgs> handler = this.CachePackageComplete;
@@ -1227,6 +1227,7 @@ namespace WixToolset.Mba.Core
1227 /// <summary>
1228 /// Called by the engine, raises the <see cref="PlanForwardCompatibleBundle"/> event.
1229 /// </summary>
1230 + /// <param name="args">Additional arguments for this event.</param>
1231 protected virtual void OnPlanForwardCompatibleBundle(PlanForwardCompatibleBundleEventArgs args)
1232 {
1233 EventHandler<PlanForwardCompatibleBundleEventArgs> handler = this.PlanForwardCompatibleBundle;
@@ -1239,7 +1240,7 @@ namespace WixToolset.Mba.Core
1240 /// <summary>
1241 /// Called by the engine, raises the <see cref="CacheContainerOrPayloadVerifyBegin"/> event.
1242 /// </summary>
1242 - /// <param name="args"></param>
1243 + /// <param name="args">Additional arguments for this event.</param>
1244 protected virtual void OnCacheContainerOrPayloadVerifyBegin(CacheContainerOrPayloadVerifyBeginEventArgs args)
1245 {
1246 EventHandler<CacheContainerOrPayloadVerifyBeginEventArgs> handler = this.CacheContainerOrPayloadVerifyBegin;
@@ -1252,7 +1253,7 @@ namespace WixToolset.Mba.Core
1253 /// <summary>
1254 /// Called by the engine, raises the <see cref="CacheContainerOrPayloadVerifyProgress"/> event.
1255 /// </summary>
1255 - /// <param name="args"></param>
1256 + /// <param name="args">Additional arguments for this event.</param>
1257 protected virtual void OnCacheContainerOrPayloadVerifyProgress(CacheContainerOrPayloadVerifyProgressEventArgs args)
1258 {
1259 EventHandler<CacheContainerOrPayloadVerifyProgressEventArgs> handler = this.CacheContainerOrPayloadVerifyProgress;
@@ -1265,7 +1266,7 @@ namespace WixToolset.Mba.Core
1266 /// <summary>
1267 /// Called by the engine, raises the <see cref="CacheContainerOrPayloadVerifyComplete"/> event.
1268 /// </summary>
1268 - /// <param name="args"></param>
1269 + /// <param name="args">Additional arguments for this event.</param>
1270 protected virtual void OnCacheContainerOrPayloadVerifyComplete(CacheContainerOrPayloadVerifyCompleteEventArgs args)
1271 {
1272 EventHandler<CacheContainerOrPayloadVerifyCompleteEventArgs> handler = this.CacheContainerOrPayloadVerifyComplete;
@@ -1278,7 +1279,7 @@ namespace WixToolset.Mba.Core
1279 /// <summary>
1280 /// Called by the engine, raises the <see cref="CachePayloadExtractBegin"/> event.
1281 /// </summary>
1281 - /// <param name="args"></param>
1282 + /// <param name="args">Additional arguments for this event.</param>
1283 protected virtual void OnCachePayloadExtractBegin(CachePayloadExtractBeginEventArgs args)
1284 {
1285 EventHandler<CachePayloadExtractBeginEventArgs> handler = this.CachePayloadExtractBegin;
@@ -1291,7 +1292,7 @@ namespace WixToolset.Mba.Core
1292 /// <summary>
1293 /// Called by the engine, raises the <see cref="CachePayloadExtractProgress"/> event.
1294 /// </summary>
1294 - /// <param name="args"></param>
1295 + /// <param name="args">Additional arguments for this event.</param>
1296 protected virtual void OnCachePayloadExtractProgress(CachePayloadExtractProgressEventArgs args)
1297 {
1298 EventHandler<CachePayloadExtractProgressEventArgs> handler = this.CachePayloadExtractProgress;
@@ -1304,7 +1305,7 @@ namespace WixToolset.Mba.Core
1305 /// <summary>
1306 /// Called by the engine, raises the <see cref="CachePayloadExtractComplete"/> event.
1307 /// </summary>
1307 - /// <param name="args"></param>
1308 + /// <param name="args">Additional arguments for this event.</param>
1309 protected virtual void OnCachePayloadExtractComplete(CachePayloadExtractCompleteEventArgs args)
1310 {
1311 EventHandler<CachePayloadExtractCompleteEventArgs> handler = this.CachePayloadExtractComplete;
@@ -1317,7 +1318,7 @@ namespace WixToolset.Mba.Core
1318 /// <summary>
1319 /// Called by the engine, raises the <see cref="SetUpdateBegin"/> event.
1320 /// </summary>
1320 - /// <param name="args"></param>
1321 + /// <param name="args">Additional arguments for this event.</param>
1322 protected virtual void OnSetUpdateBegin(SetUpdateBeginEventArgs args)
1323 {
1324 EventHandler<SetUpdateBeginEventArgs> handler = this.SetUpdateBegin;
@@ -1330,7 +1331,7 @@ namespace WixToolset.Mba.Core
1331 /// <summary>
1332 /// Called by the engine, raises the <see cref="SetUpdateComplete"/> event.
1333 /// </summary>
1333 - /// <param name="args"></param>
1334 + /// <param name="args">Additional arguments for this event.</param>
1335 protected virtual void OnSetUpdateComplete(SetUpdateCompleteEventArgs args)
1336 {
1337 EventHandler<SetUpdateCompleteEventArgs> handler = this.SetUpdateComplete;
@@ -1382,6 +1383,7 @@ namespace WixToolset.Mba.Core
1383 /// <summary>
1384 /// Called by the engine, raises the <see cref="CachePackageNonVitalValidationFailure"/> event.
1385 /// </summary>
1386 + /// <param name="args">Additional arguments for this event.</param>
1387 protected virtual void OnCachePackageNonVitalValidationFailure(CachePackageNonVitalValidationFailureEventArgs args)
1388 {
1389 EventHandler<CachePackageNonVitalValidationFailureEventArgs> handler = this.CachePackageNonVitalValidationFailure;
src/api/burn/WixToolset.Mba.Core/BootstrapperApplicationData.cs
+2 -2
@@ -12,12 +12,12 @@ namespace WixToolset.Mba.Core
12 public class BootstrapperApplicationData : IBootstrapperApplicationData
13 {
14 /// <summary>
15 - ///
15 + /// The default file name for BootstrapperApplicationData.
16 /// </summary>
17 public const string DefaultFileName = "BootstrapperApplicationData.xml";
18
19 /// <summary>
20 - ///
20 + /// The XML namespace for BootstrapperApplicationData.
21 /// </summary>
22 public const string XMLNamespace = "http://wixtoolset.org/schemas/v4/BootstrapperApplicationData";
23
src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs
+1 -12
@@ -13,19 +13,8 @@ namespace WixToolset.Mba.Core
13 public sealed class BootstrapperCommand : IBootstrapperCommand
14 {
15 /// <summary>
16 - ///
16 + /// See <see cref="IBootstrapperCommand"/>.
17 /// </summary>
18 - /// <param name="action"></param>
19 - /// <param name="display"></param>
20 - /// <param name="commandLine"></param>
21 - /// <param name="cmdShow"></param>
22 - /// <param name="resume"></param>
23 - /// <param name="splashScreen"></param>
24 - /// <param name="relation"></param>
25 - /// <param name="passthrough"></param>
26 - /// <param name="layoutDirectory"></param>
27 - /// <param name="bootstrapperWorkingFolder"></param>
28 - /// <param name="bootstrapperApplicationDataPath"></param>
18 public BootstrapperCommand(
19 LaunchAction action,
20 Display display,
src/api/burn/WixToolset.Mba.Core/Engine.cs
-83
@@ -6,21 +6,14 @@ namespace WixToolset.Mba.Core
6 using System.ComponentModel;
7 using System.Runtime.InteropServices;
8 using System.Security;
9 - using System.Text;
9
10 /// <summary>
11 /// Default implementation of <see cref="IEngine"/>.
12 /// </summary>
13 public sealed class Engine : IEngine
14 {
16 - private static readonly string normalizeVersionFormatString = "{0} must be less than or equal to " + UInt16.MaxValue;
17 -
15 private IBootstrapperEngine engine;
16
20 - /// <summary>
21 - /// Creates a new instance of the <see cref="Engine"/> container class.
22 - /// </summary>
23 - /// <param name="engine">The <see cref="IBootstrapperEngine"/> to contain.</param>
17 internal Engine(IBootstrapperEngine engine)
18 {
19 this.engine = engine;
@@ -352,81 +345,5 @@ namespace WixToolset.Mba.Core
345 {
346 this.engine.Quit(exitCode);
347 }
355 -
356 - /// <summary>
357 - /// Utility method for converting a <see cref="Version"/> into a <see cref="long"/>.
358 - /// </summary>
359 - /// <param name="version"></param>
360 - /// <returns></returns>
361 - public static long VersionToLong(Version version)
362 - {
363 - // In Windows, each version component has a max value of 65535,
364 - // so we truncate the version before shifting it, which will overflow if invalid.
365 - long major = (long)(ushort)version.Major << 48;
366 - long minor = (long)(ushort)version.Minor << 32;
367 - long build = (long)(ushort)version.Build << 16;
368 - long revision = (long)(ushort)version.Revision;
369 -
370 - return major | minor | build | revision;
371 - }
372 -
373 - /// <summary>
374 - /// Utility method for converting a <see cref="long"/> into a <see cref="Version"/>.
375 - /// </summary>
376 - /// <param name="version"></param>
377 - /// <returns></returns>
378 - public static Version LongToVersion(long version)
379 - {
380 - int major = (int)((version & ((long)0xffff << 48)) >> 48);
381 - int minor = (int)((version & ((long)0xffff << 32)) >> 32);
382 - int build = (int)((version & ((long)0xffff << 16)) >> 16);
383 - int revision = (int)(version & 0xffff);
384 -
385 - return new Version(major, minor, build, revision);
386 - }
387 -
388 - /// <summary>
389 - /// Verifies that Version can be represented in a <see cref="long"/>.
390 - /// If the Build or Revision fields are undefined, they are set to zero.
391 - /// </summary>
392 - public static Version NormalizeVersion(Version version)
393 - {
394 - if (version == null)
395 - {
396 - throw new ArgumentNullException("version");
397 - }
398 -
399 - int major = version.Major;
400 - int minor = version.Minor;
401 - int build = version.Build;
402 - int revision = version.Revision;
403 -
404 - if (major > UInt16.MaxValue)
405 - {
406 - throw new ArgumentOutOfRangeException("version", String.Format(normalizeVersionFormatString, "Major"));
407 - }
408 - if (minor > UInt16.MaxValue)
409 - {
410 - throw new ArgumentOutOfRangeException("version", String.Format(normalizeVersionFormatString, "Minor"));
411 - }
412 - if (build > UInt16.MaxValue)
413 - {
414 - throw new ArgumentOutOfRangeException("version", String.Format(normalizeVersionFormatString, "Build"));
415 - }
416 - if (build == -1)
417 - {
418 - build = 0;
419 - }
420 - if (revision > UInt16.MaxValue)
421 - {
422 - throw new ArgumentOutOfRangeException("version", String.Format(normalizeVersionFormatString, "Revision"));
423 - }
424 - if (revision == -1)
425 - {
426 - revision = 0;
427 - }
428 -
429 - return new Version(major, minor, build, revision);
430 - }
348 }
349 }
src/api/burn/WixToolset.Mba.Core/EventArgs.cs
+350 -133
@@ -14,7 +14,8 @@ namespace WixToolset.Mba.Core
14 public abstract class HResultEventArgs : EventArgs
15 {
16 /// <summary>
17 - /// Creates a new instance of the <see cref="HResultEventArgs"/> class.
17 + /// This class is for events raised by the engine.
18 + /// It is not intended to be instantiated by user code.
19 /// </summary>
20 public HResultEventArgs()
21 {
@@ -33,7 +34,8 @@ namespace WixToolset.Mba.Core
34 public abstract class CancellableHResultEventArgs : HResultEventArgs
35 {
36 /// <summary>
36 - /// Creates a new instance of the <see cref="CancellableHResultEventArgs"/> class.
37 + /// This class is for events raised by the engine.
38 + /// It is not intended to be instantiated by user code.
39 /// </summary>
40 public CancellableHResultEventArgs(bool cancelRecommendation)
41 {
@@ -52,7 +54,10 @@ namespace WixToolset.Mba.Core
54 [Serializable]
55 public abstract class ResultEventArgs : HResultEventArgs
56 {
55 - /// <summary />
57 + /// <summary>
58 + /// This class is for events raised by the engine.
59 + /// It is not intended to be instantiated by user code.
60 + /// </summary>
61 public ResultEventArgs(Result recommendation, Result result)
62 {
63 this.Recommendation = recommendation;
@@ -77,9 +82,9 @@ namespace WixToolset.Mba.Core
82 public abstract class StatusEventArgs : HResultEventArgs
83 {
84 /// <summary>
80 - /// Creates a new instance of the <see cref="StatusEventArgs"/> class.
85 + /// This class is for events raised by the engine.
86 + /// It is not intended to be instantiated by user code.
87 /// </summary>
82 - /// <param name="hrStatus">The return code of the operation.</param>
88 public StatusEventArgs(int hrStatus)
89 {
90 this.Status = hrStatus;
@@ -96,7 +101,10 @@ namespace WixToolset.Mba.Core
101 /// </summary>
102 public abstract class ActionEventArgs<T> : StatusEventArgs
103 {
99 - /// <summary />
104 + /// <summary>
105 + /// This class is for events raised by the engine.
106 + /// It is not intended to be instantiated by user code.
107 + /// </summary>
108 public ActionEventArgs(int hrStatus, T recommendation, T action)
109 : base(hrStatus)
110 {
@@ -121,7 +129,10 @@ namespace WixToolset.Mba.Core
129 [Serializable]
130 public abstract class CancellableActionEventArgs<T> : CancellableHResultEventArgs
131 {
124 - /// <summary />
132 + /// <summary>
133 + /// This class is for events raised by the engine.
134 + /// It is not intended to be instantiated by user code.
135 + /// </summary>
136 public CancellableActionEventArgs(bool cancelRecommendation, T recommendation, T action)
137 : base(cancelRecommendation)
138 {
@@ -146,7 +157,10 @@ namespace WixToolset.Mba.Core
157 [Serializable]
158 public abstract class CacheProgressBaseEventArgs : CancellableHResultEventArgs
159 {
149 - /// <summary />
160 + /// <summary>
161 + /// This class is for events raised by the engine.
162 + /// It is not intended to be instantiated by user code.
163 + /// </summary>
164 public CacheProgressBaseEventArgs(string packageOrContainerId, string payloadId, long progress, long total, int overallPercentage, bool cancelRecommendation)
165 : base(cancelRecommendation)
166 {
@@ -184,13 +198,14 @@ namespace WixToolset.Mba.Core
198 }
199
200 /// <summary>
187 - /// Additional arguments used when startup has begun.
201 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.Startup"/>.
202 /// </summary>
203 [Serializable]
204 public class StartupEventArgs : HResultEventArgs
205 {
206 /// <summary>
193 - /// Creates a new instance of the <see cref="StartupEventArgs"/> class.
207 + /// This class is for events raised by the engine.
208 + /// It is not intended to be instantiated by user code.
209 /// </summary>
210 public StartupEventArgs()
211 {
@@ -198,13 +213,14 @@ namespace WixToolset.Mba.Core
213 }
214
215 /// <summary>
201 - /// Additional arguments used when shutdown has begun.
216 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.Shutdown"/>.
217 /// </summary>
218 [Serializable]
219 public class ShutdownEventArgs : HResultEventArgs
220 {
221 /// <summary>
207 - /// Creates a new instance of the <see cref="ShutdownEventArgs"/> class.
222 + /// This class is for events raised by the engine.
223 + /// It is not intended to be instantiated by user code.
224 /// </summary>
225 public ShutdownEventArgs(BOOTSTRAPPER_SHUTDOWN_ACTION action)
226 {
@@ -223,7 +239,10 @@ namespace WixToolset.Mba.Core
239 [Serializable]
240 public class DetectBeginEventArgs : CancellableHResultEventArgs
241 {
226 - /// <summary />
242 + /// <summary>
243 + /// This class is for events raised by the engine.
244 + /// It is not intended to be instantiated by user code.
245 + /// </summary>
246 public DetectBeginEventArgs(bool cached, RegistrationType registrationType, int packageCount, bool cancelRecommendation)
247 : base(cancelRecommendation)
248 {
@@ -254,7 +273,10 @@ namespace WixToolset.Mba.Core
273 [Serializable]
274 public class DetectForwardCompatibleBundleEventArgs : CancellableHResultEventArgs
275 {
257 - /// <summary />
276 + /// <summary>
277 + /// This class is for events raised by the engine.
278 + /// It is not intended to be instantiated by user code.
279 + /// </summary>
280 public DetectForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool missingFromCache, bool cancelRecommendation)
281 : base(cancelRecommendation)
282 {
@@ -303,7 +325,10 @@ namespace WixToolset.Mba.Core
325 [Serializable]
326 public class DetectUpdateBeginEventArgs : CancellableHResultEventArgs
327 {
306 - /// <summary />
328 + /// <summary>
329 + /// This class is for events raised by the engine.
330 + /// It is not intended to be instantiated by user code.
331 + /// </summary>
332 public DetectUpdateBeginEventArgs(string updateLocation, bool cancelRecommendation, bool skipRecommendation)
333 : base(cancelRecommendation)
334 {
@@ -328,7 +353,10 @@ namespace WixToolset.Mba.Core
353 [Serializable]
354 public class DetectUpdateEventArgs : CancellableHResultEventArgs
355 {
331 - /// <summary />
356 + /// <summary>
357 + /// This class is for events raised by the engine.
358 + /// It is not intended to be instantiated by user code.
359 + /// </summary>
360 public DetectUpdateEventArgs(string updateLocation, long size, string hash, UpdateHashType hashAlgorithm, string version, string title, string summary, string contentType, string content, bool cancelRecommendation, bool stopRecommendation)
361 : base(cancelRecommendation)
362 {
@@ -401,7 +429,10 @@ namespace WixToolset.Mba.Core
429 [Serializable]
430 public class DetectUpdateCompleteEventArgs : StatusEventArgs
431 {
404 - /// <summary />
432 + /// <summary>
433 + /// This class is for events raised by the engine.
434 + /// It is not intended to be instantiated by user code.
435 + /// </summary>
436 public DetectUpdateCompleteEventArgs(int hrStatus, bool ignoreRecommendation)
437 : base(hrStatus)
438 {
@@ -420,7 +451,10 @@ namespace WixToolset.Mba.Core
451 [Serializable]
452 public class DetectRelatedBundleEventArgs : CancellableHResultEventArgs
453 {
423 - /// <summary />
454 + /// <summary>
455 + /// This class is for events raised by the engine.
456 + /// It is not intended to be instantiated by user code.
457 + /// </summary>
458 public DetectRelatedBundleEventArgs(string productCode, RelationType relationType, string bundleTag, bool perMachine, string version, bool missingFromCache, bool cancelRecommendation)
459 : base(cancelRecommendation)
460 {
@@ -469,7 +503,10 @@ namespace WixToolset.Mba.Core
503 [Serializable]
504 public class DetectPackageBeginEventArgs : CancellableHResultEventArgs
505 {
472 - /// <summary />
506 + /// <summary>
507 + /// This class is for events raised by the engine.
508 + /// It is not intended to be instantiated by user code.
509 + /// </summary>
510 public DetectPackageBeginEventArgs(string packageId, bool cancelRecommendation)
511 : base(cancelRecommendation)
512 {
@@ -488,7 +525,10 @@ namespace WixToolset.Mba.Core
525 [Serializable]
526 public class DetectCompatibleMsiPackageEventArgs : CancellableHResultEventArgs
527 {
491 - /// <summary />
528 + /// <summary>
529 + /// This class is for events raised by the engine.
530 + /// It is not intended to be instantiated by user code.
531 + /// </summary>
532 public DetectCompatibleMsiPackageEventArgs(string packageId, string compatiblePackageId, string compatiblePackageVersion, bool cancelRecommendation)
533 : base(cancelRecommendation)
534 {
@@ -519,7 +559,10 @@ namespace WixToolset.Mba.Core
559 [Serializable]
560 public class DetectRelatedMsiPackageEventArgs : CancellableHResultEventArgs
561 {
522 - /// <summary />
562 + /// <summary>
563 + /// This class is for events raised by the engine.
564 + /// It is not intended to be instantiated by user code.
565 + /// </summary>
566 public DetectRelatedMsiPackageEventArgs(string packageId, string upgradeCode, string productCode, bool perMachine, string version, RelatedOperation operation, bool cancelRecommendation)
567 : base(cancelRecommendation)
568 {
@@ -568,12 +611,9 @@ namespace WixToolset.Mba.Core
611 public class DetectPatchTargetEventArgs : CancellableHResultEventArgs
612 {
613 /// <summary>
571 - ///
614 + /// This class is for events raised by the engine.
615 + /// It is not intended to be instantiated by user code.
616 /// </summary>
573 - /// <param name="packageId"></param>
574 - /// <param name="productCode"></param>
575 - /// <param name="state"></param>
576 - /// <param name="cancelRecommendation"></param>
617 public DetectPatchTargetEventArgs(string packageId, string productCode, PackageState state, bool cancelRecommendation)
618 : base(cancelRecommendation)
619 {
@@ -603,7 +643,10 @@ namespace WixToolset.Mba.Core
643 /// </summary>
644 public class DetectMsiFeatureEventArgs : CancellableHResultEventArgs
645 {
606 - /// <summary />
646 + /// <summary>
647 + /// This class is for events raised by the engine.
648 + /// It is not intended to be instantiated by user code.
649 + /// </summary>
650 public DetectMsiFeatureEventArgs(string packageId, string featureId, FeatureState state, bool cancelRecommendation)
651 : base(cancelRecommendation)
652 {
@@ -629,12 +672,15 @@ namespace WixToolset.Mba.Core
672 }
673
674 /// <summary>
632 - /// Additional arguments for <see cref="IDefaultBootstrapperApplication.DetectPackageComplete"/>.
675 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.DetectPackageComplete"/>.
676 /// </summary>
677 [Serializable]
678 public class DetectPackageCompleteEventArgs : StatusEventArgs
679 {
637 - /// <summary />
680 + /// <summary>
681 + /// This class is for events raised by the engine.
682 + /// It is not intended to be instantiated by user code.
683 + /// </summary>
684 public DetectPackageCompleteEventArgs(string packageId, int hrStatus, PackageState state, bool cached)
685 : base(hrStatus)
686 {
@@ -660,16 +706,15 @@ namespace WixToolset.Mba.Core
706 }
707
708 /// <summary>
663 - /// Additional arguments used when the detection phase has completed.
709 + /// Event arguments used when the detection phase has completed.
710 /// </summary>
711 [Serializable]
712 public class DetectCompleteEventArgs : StatusEventArgs
713 {
714 /// <summary>
669 - /// Creates a new instance of the <see cref="DetectCompleteEventArgs"/> class.
715 + /// This class is for events raised by the engine.
716 + /// It is not intended to be instantiated by user code.
717 /// </summary>
671 - /// <param name="hrStatus">The return code of the operation.</param>
672 - /// <param name="eligibleForCleanup"></param>
718 public DetectCompleteEventArgs(int hrStatus, bool eligibleForCleanup)
719 : base(hrStatus)
720 {
@@ -688,7 +733,10 @@ namespace WixToolset.Mba.Core
733 [Serializable]
734 public class PlanBeginEventArgs : CancellableHResultEventArgs
735 {
691 - /// <summary />
736 + /// <summary>
737 + /// This class is for events raised by the engine.
738 + /// It is not intended to be instantiated by user code.
739 + /// </summary>
740 public PlanBeginEventArgs(int packageCount, bool cancelRecommendation)
741 : base(cancelRecommendation)
742 {
@@ -707,7 +755,10 @@ namespace WixToolset.Mba.Core
755 [Serializable]
756 public class PlanRelatedBundleEventArgs : CancellableHResultEventArgs
757 {
710 - /// <summary />
758 + /// <summary>
759 + /// This class is for events raised by the engine.
760 + /// It is not intended to be instantiated by user code.
761 + /// </summary>
762 public PlanRelatedBundleEventArgs(string bundleId, RequestState recommendedState, RequestState state, bool cancelRecommendation)
763 : base(cancelRecommendation)
764 {
@@ -738,7 +789,10 @@ namespace WixToolset.Mba.Core
789 [Serializable]
790 public class PlanRelatedBundleTypeEventArgs : CancellableHResultEventArgs
791 {
741 - /// <summary />
792 + /// <summary>
793 + /// This class is for events raised by the engine.
794 + /// It is not intended to be instantiated by user code.
795 + /// </summary>
796 public PlanRelatedBundleTypeEventArgs(string bundleId, RelatedBundlePlanType recommendedType, RelatedBundlePlanType type, bool cancelRecommendation)
797 : base(cancelRecommendation)
798 {
@@ -769,7 +823,10 @@ namespace WixToolset.Mba.Core
823 [Serializable]
824 public class PlanPackageBeginEventArgs : CancellableHResultEventArgs
825 {
772 - /// <summary />
826 + /// <summary>
827 + /// This class is for events raised by the engine.
828 + /// It is not intended to be instantiated by user code.
829 + /// </summary>
830 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)
831 : base(cancelRecommendation)
832 {
@@ -836,7 +893,10 @@ namespace WixToolset.Mba.Core
893 [Serializable]
894 public class PlanCompatibleMsiPackageBeginEventArgs : CancellableHResultEventArgs
895 {
839 - /// <summary />
896 + /// <summary>
897 + /// This class is for events raised by the engine.
898 + /// It is not intended to be instantiated by user code.
899 + /// </summary>
900 public PlanCompatibleMsiPackageBeginEventArgs(string packageId, string compatiblePackageId, string compatiblePackageVersion, bool recommendedRemove, bool requestRemove, bool cancelRecommendation)
901 : base(cancelRecommendation)
902 {
@@ -879,7 +939,10 @@ namespace WixToolset.Mba.Core
939 [Serializable]
940 public class PlanCompatibleMsiPackageCompleteEventArgs : StatusEventArgs
941 {
882 - /// <summary />
942 + /// <summary>
943 + /// This class is for events raised by the engine.
944 + /// It is not intended to be instantiated by user code.
945 + /// </summary>
946 public PlanCompatibleMsiPackageCompleteEventArgs(string packageId, string compatiblePackageId, int hrStatus, bool requestedRemove)
947 : base(hrStatus)
948 {
@@ -910,7 +973,10 @@ namespace WixToolset.Mba.Core
973 [Serializable]
974 public class PlanRollbackBoundaryEventArgs : CancellableHResultEventArgs
975 {
913 - /// <summary />
976 + /// <summary>
977 + /// This class is for events raised by the engine.
978 + /// It is not intended to be instantiated by user code.
979 + /// </summary>
980 public PlanRollbackBoundaryEventArgs(string rollbackBoundaryId, bool recommendedTransaction, bool transaction, bool cancelRecommendation)
981 : base(cancelRecommendation)
982 {
@@ -944,13 +1010,9 @@ namespace WixToolset.Mba.Core
1010 public class PlanPatchTargetEventArgs : CancellableHResultEventArgs
1011 {
1012 /// <summary>
947 - ///
1013 + /// This class is for events raised by the engine.
1014 + /// It is not intended to be instantiated by user code.
1015 /// </summary>
949 - /// <param name="packageId"></param>
950 - /// <param name="productCode"></param>
951 - /// <param name="recommendedState"></param>
952 - /// <param name="state"></param>
953 - /// <param name="cancelRecommendation"></param>
1016 public PlanPatchTargetEventArgs(string packageId, string productCode, RequestState recommendedState, RequestState state, bool cancelRecommendation)
1017 : base(cancelRecommendation)
1018 {
@@ -987,7 +1049,10 @@ namespace WixToolset.Mba.Core
1049 [Serializable]
1050 public class PlanMsiFeatureEventArgs : CancellableHResultEventArgs
1051 {
990 - /// <summary />
1052 + /// <summary>
1053 + /// This class is for events raised by the engine.
1054 + /// It is not intended to be instantiated by user code.
1055 + /// </summary>
1056 public PlanMsiFeatureEventArgs(string packageId, string featureId, FeatureState recommendedState, FeatureState state, bool cancelRecommendation)
1057 : base(cancelRecommendation)
1058 {
@@ -1024,7 +1089,10 @@ namespace WixToolset.Mba.Core
1089 [Serializable]
1090 public class PlanMsiPackageEventArgs : CancellableHResultEventArgs
1091 {
1027 - /// <summary />
1092 + /// <summary>
1093 + /// This class is for events raised by the engine.
1094 + /// It is not intended to be instantiated by user code.
1095 + /// </summary>
1096 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)
1097 : base(cancelRecommendation)
1098 {
@@ -1086,11 +1154,9 @@ namespace WixToolset.Mba.Core
1154 public class PlanPackageCompleteEventArgs : StatusEventArgs
1155 {
1156 /// <summary>
1089 - ///
1157 + /// This class is for events raised by the engine.
1158 + /// It is not intended to be instantiated by user code.
1159 /// </summary>
1091 - /// <param name="packageId"></param>
1092 - /// <param name="hrStatus"></param>
1093 - /// <param name="requested"></param>
1160 public PlanPackageCompleteEventArgs(string packageId, int hrStatus, RequestState requested)
1161 : base(hrStatus)
1162 {
@@ -1115,7 +1181,10 @@ namespace WixToolset.Mba.Core
1181 [Serializable]
1182 public class PlannedCompatiblePackageEventArgs : HResultEventArgs
1183 {
1118 - /// <summary />
1184 + /// <summary>
1185 + /// This class is for events raised by the engine.
1186 + /// It is not intended to be instantiated by user code.
1187 + /// </summary>
1188 public PlannedCompatiblePackageEventArgs(string packageId, string compatiblePackageId, bool remove)
1189 {
1190 this.PackageId = packageId;
@@ -1145,7 +1214,10 @@ namespace WixToolset.Mba.Core
1214 [Serializable]
1215 public class PlannedPackageEventArgs : HResultEventArgs
1216 {
1148 - /// <summary />
1217 + /// <summary>
1218 + /// This class is for events raised by the engine.
1219 + /// It is not intended to be instantiated by user code.
1220 + /// </summary>
1221 public PlannedPackageEventArgs(string packageId, ActionState execute, ActionState rollback, bool cache, bool uncache)
1222 {
1223 this.PackageId = packageId;
@@ -1182,15 +1254,15 @@ namespace WixToolset.Mba.Core
1254 }
1255
1256 /// <summary>
1185 - /// Additional arguments used when the engine has completed planning the installation.
1257 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.PlanComplete"/>.
1258 /// </summary>
1259 [Serializable]
1260 public class PlanCompleteEventArgs : StatusEventArgs
1261 {
1262 /// <summary>
1191 - /// Creates a new instance of the <see cref="PlanCompleteEventArgs"/> class.
1263 + /// This class is for events raised by the engine.
1264 + /// It is not intended to be instantiated by user code.
1265 /// </summary>
1193 - /// <param name="hrStatus">The return code of the operation.</param>
1266 public PlanCompleteEventArgs(int hrStatus)
1267 : base(hrStatus)
1268 {
@@ -1203,7 +1275,10 @@ namespace WixToolset.Mba.Core
1275 [Serializable]
1276 public class PlanForwardCompatibleBundleEventArgs : CancellableHResultEventArgs
1277 {
1206 - /// <summary />
1278 + /// <summary>
1279 + /// This class is for events raised by the engine.
1280 + /// It is not intended to be instantiated by user code.
1281 + /// </summary>
1282 public PlanForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool recommendedIgnoreBundle, bool cancelRecommendation, bool ignoreBundle)
1283 : base(cancelRecommendation)
1284 {
@@ -1258,7 +1333,10 @@ namespace WixToolset.Mba.Core
1333 [Serializable]
1334 public class ApplyBeginEventArgs : CancellableHResultEventArgs
1335 {
1261 - /// <summary />
1336 + /// <summary>
1337 + /// This class is for events raised by the engine.
1338 + /// It is not intended to be instantiated by user code.
1339 + /// </summary>
1340 public ApplyBeginEventArgs(int phaseCount, bool cancelRecommendation)
1341 : base(cancelRecommendation)
1342 {
@@ -1278,7 +1356,10 @@ namespace WixToolset.Mba.Core
1356 [Serializable]
1357 public class ElevateBeginEventArgs : CancellableHResultEventArgs
1358 {
1281 - /// <summary />
1359 + /// <summary>
1360 + /// This class is for events raised by the engine.
1361 + /// It is not intended to be instantiated by user code.
1362 + /// </summary>
1363 public ElevateBeginEventArgs(bool cancelRecommendation)
1364 : base(cancelRecommendation)
1365 {
@@ -1286,15 +1367,15 @@ namespace WixToolset.Mba.Core
1367 }
1368
1369 /// <summary>
1289 - /// Additional arguments used when the engine has completed starting the elevated process.
1370 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.ElevateComplete"/>.
1371 /// </summary>
1372 [Serializable]
1373 public class ElevateCompleteEventArgs : StatusEventArgs
1374 {
1375 /// <summary>
1295 - /// Creates a new instance of the <see cref="ElevateCompleteEventArgs"/> class.
1376 + /// This class is for events raised by the engine.
1377 + /// It is not intended to be instantiated by user code.
1378 /// </summary>
1297 - /// <param name="hrStatus">The return code of the operation.</param>
1379 public ElevateCompleteEventArgs(int hrStatus)
1380 : base(hrStatus)
1381 {
@@ -1307,7 +1388,10 @@ namespace WixToolset.Mba.Core
1388 [Serializable]
1389 public class ProgressEventArgs : CancellableHResultEventArgs
1390 {
1310 - /// <summary />
1391 + /// <summary>
1392 + /// This class is for events raised by the engine.
1393 + /// It is not intended to be instantiated by user code.
1394 + /// </summary>
1395 public ProgressEventArgs(int progressPercentage, int overallPercentage, bool cancelRecommendation)
1396 : base(cancelRecommendation)
1397 {
@@ -1332,7 +1416,10 @@ namespace WixToolset.Mba.Core
1416 [Serializable]
1417 public class ErrorEventArgs : ResultEventArgs
1418 {
1335 - /// <summary />
1419 + /// <summary>
1420 + /// This class is for events raised by the engine.
1421 + /// It is not intended to be instantiated by user code.
1422 + /// </summary>
1423 public ErrorEventArgs(ErrorType errorType, string packageId, int errorCode, string errorMessage, int dwUIHint, string[] data, Result recommendation, Result result)
1424 : base(recommendation, result)
1425 {
@@ -1381,7 +1468,10 @@ namespace WixToolset.Mba.Core
1468 [Serializable]
1469 public class RegisterBeginEventArgs : CancellableHResultEventArgs
1470 {
1384 - /// <summary />
1471 + /// <summary>
1472 + /// This class is for events raised by the engine.
1473 + /// It is not intended to be instantiated by user code.
1474 + /// </summary>
1475 public RegisterBeginEventArgs(RegistrationType recommendedRegistrationType, bool cancelRecommendation, RegistrationType registrationType)
1476 : base(cancelRecommendation)
1477 {
@@ -1406,7 +1496,10 @@ namespace WixToolset.Mba.Core
1496 [Serializable]
1497 public class RegisterCompleteEventArgs : StatusEventArgs
1498 {
1409 - /// <summary />
1499 + /// <summary>
1500 + /// This class is for events raised by the engine.
1501 + /// It is not intended to be instantiated by user code.
1502 + /// </summary>
1503 public RegisterCompleteEventArgs(int hrStatus)
1504 : base(hrStatus)
1505 {
@@ -1419,7 +1512,10 @@ namespace WixToolset.Mba.Core
1512 [Serializable]
1513 public class UnregisterBeginEventArgs : HResultEventArgs
1514 {
1422 - /// <summary />
1515 + /// <summary>
1516 + /// This class is for events raised by the engine.
1517 + /// It is not intended to be instantiated by user code.
1518 + /// </summary>
1519 public UnregisterBeginEventArgs(RegistrationType recommendedRegistrationType, RegistrationType registrationType)
1520 {
1521 this.RecommendedRegistrationType = recommendedRegistrationType;
@@ -1443,7 +1539,10 @@ namespace WixToolset.Mba.Core
1539 [Serializable]
1540 public class UnregisterCompleteEventArgs : StatusEventArgs
1541 {
1446 - /// <summary />
1542 + /// <summary>
1543 + /// This class is for events raised by the engine.
1544 + /// It is not intended to be instantiated by user code.
1545 + /// </summary>
1546 public UnregisterCompleteEventArgs(int hrStatus)
1547 : base(hrStatus)
1548 {
@@ -1456,7 +1555,10 @@ namespace WixToolset.Mba.Core
1555 [Serializable]
1556 public class CacheBeginEventArgs : CancellableHResultEventArgs
1557 {
1459 - /// <summary />
1558 + /// <summary>
1559 + /// This class is for events raised by the engine.
1560 + /// It is not intended to be instantiated by user code.
1561 + /// </summary>
1562 public CacheBeginEventArgs(bool cancelRecommendation)
1563 : base(cancelRecommendation)
1564 {
@@ -1469,7 +1571,10 @@ namespace WixToolset.Mba.Core
1571 [Serializable]
1572 public class CacheAcquireBeginEventArgs : CancellableActionEventArgs<CacheOperation>
1573 {
1472 - /// <summary />
1574 + /// <summary>
1575 + /// This class is for events raised by the engine.
1576 + /// It is not intended to be instantiated by user code.
1577 + /// </summary>
1578 public CacheAcquireBeginEventArgs(string packageOrContainerId, string payloadId, string source, string downloadUrl, string payloadContainerId, CacheOperation recommendation, CacheOperation action, bool cancelRecommendation)
1579 : base(cancelRecommendation, recommendation, action)
1580 {
@@ -1512,7 +1617,10 @@ namespace WixToolset.Mba.Core
1617 [Serializable]
1618 public class CacheAcquireProgressEventArgs : CacheProgressBaseEventArgs
1619 {
1515 - /// <summary />
1620 + /// <summary>
1621 + /// This class is for events raised by the engine.
1622 + /// It is not intended to be instantiated by user code.
1623 + /// </summary>
1624 public CacheAcquireProgressEventArgs(string packageOrContainerId, string payloadId, long progress, long total, int overallPercentage, bool cancelRecommendation)
1625 : base(packageOrContainerId, payloadId, progress, total, overallPercentage, cancelRecommendation)
1626 {
@@ -1525,7 +1633,10 @@ namespace WixToolset.Mba.Core
1633 [Serializable]
1634 public class CacheAcquireCompleteEventArgs : ActionEventArgs<BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION>
1635 {
1528 - /// <summary />
1636 + /// <summary>
1637 + /// This class is for events raised by the engine.
1638 + /// It is not intended to be instantiated by user code.
1639 + /// </summary>
1640 public CacheAcquireCompleteEventArgs(string packageOrContainerId, string payloadId, int hrStatus, BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION recommendation, BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION action)
1641 : base(hrStatus, recommendation, action)
1642 {
@@ -1550,7 +1661,10 @@ namespace WixToolset.Mba.Core
1661 [Serializable]
1662 public class CacheVerifyBeginEventArgs : CancellableHResultEventArgs
1663 {
1553 - /// <summary />
1664 + /// <summary>
1665 + /// This class is for events raised by the engine.
1666 + /// It is not intended to be instantiated by user code.
1667 + /// </summary>
1668 public CacheVerifyBeginEventArgs(string packageOrContainerId, string payloadId, bool cancelRecommendation)
1669 : base(cancelRecommendation)
1670 {
@@ -1575,7 +1689,10 @@ namespace WixToolset.Mba.Core
1689 [Serializable]
1690 public class CacheVerifyProgressEventArgs : CacheProgressBaseEventArgs
1691 {
1578 - /// <summary />
1692 + /// <summary>
1693 + /// This class is for events raised by the engine.
1694 + /// It is not intended to be instantiated by user code.
1695 + /// </summary>
1696 public CacheVerifyProgressEventArgs(string packageOrContainerId, string payloadId, long progress, long total, int overallPercentage, CacheVerifyStep verifyStep, bool cancelRecommendation)
1697 : base(packageOrContainerId, payloadId, progress, total, overallPercentage, cancelRecommendation)
1698 {
@@ -1594,7 +1711,10 @@ namespace WixToolset.Mba.Core
1711 [Serializable]
1712 public class CacheVerifyCompleteEventArgs : ActionEventArgs<BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION>
1713 {
1597 - /// <summary />
1714 + /// <summary>
1715 + /// This class is for events raised by the engine.
1716 + /// It is not intended to be instantiated by user code.
1717 + /// </summary>
1718 public CacheVerifyCompleteEventArgs(string packageOrContainerId, string payloadId, int hrStatus, BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION recommendation, BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION action)
1719 : base(hrStatus, recommendation, action)
1720 {
@@ -1614,15 +1734,15 @@ namespace WixToolset.Mba.Core
1734 }
1735
1736 /// <summary>
1617 - /// Additional arguments used after the engine has cached the installation sources.
1737 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.CacheComplete"/>.
1738 /// </summary>
1739 [Serializable]
1740 public class CacheCompleteEventArgs : StatusEventArgs
1741 {
1742 /// <summary>
1623 - /// Creates a new instance of the <see cref="CacheCompleteEventArgs"/> class.
1743 + /// This class is for events raised by the engine.
1744 + /// It is not intended to be instantiated by user code.
1745 /// </summary>
1625 - /// <param name="hrStatus">The return code of the operation.</param>
1746 public CacheCompleteEventArgs(int hrStatus)
1747 : base(hrStatus)
1748 {
@@ -1635,7 +1755,10 @@ namespace WixToolset.Mba.Core
1755 [Serializable]
1756 public class ExecuteBeginEventArgs : CancellableHResultEventArgs
1757 {
1638 - /// <summary />
1758 + /// <summary>
1759 + /// This class is for events raised by the engine.
1760 + /// It is not intended to be instantiated by user code.
1761 + /// </summary>
1762 public ExecuteBeginEventArgs(int packageCount, bool cancelRecommendation)
1763 : base(cancelRecommendation)
1764 {
@@ -1654,7 +1777,10 @@ namespace WixToolset.Mba.Core
1777 [Serializable]
1778 public class ExecutePackageBeginEventArgs : CancellableHResultEventArgs
1779 {
1657 - /// <summary />
1780 + /// <summary>
1781 + /// This class is for events raised by the engine.
1782 + /// It is not intended to be instantiated by user code.
1783 + /// </summary>
1784 public ExecutePackageBeginEventArgs(string packageId, bool shouldExecute, ActionState action, INSTALLUILEVEL uiLevel, bool disableExternalUiHandler, bool cancelRecommendation)
1785 : base(cancelRecommendation)
1786 {
@@ -1697,7 +1823,10 @@ namespace WixToolset.Mba.Core
1823 [Serializable]
1824 public class ExecutePatchTargetEventArgs : CancellableHResultEventArgs
1825 {
1700 - /// <summary />
1826 + /// <summary>
1827 + /// This class is for events raised by the engine.
1828 + /// It is not intended to be instantiated by user code.
1829 + /// </summary>
1830 public ExecutePatchTargetEventArgs(string packageId, string targetProductCode, bool cancelRecommendation)
1831 : base(cancelRecommendation)
1832 {
@@ -1722,7 +1851,10 @@ namespace WixToolset.Mba.Core
1851 [Serializable]
1852 public class ExecuteMsiMessageEventArgs : ResultEventArgs
1853 {
1725 - /// <summary />
1854 + /// <summary>
1855 + /// This class is for events raised by the engine.
1856 + /// It is not intended to be instantiated by user code.
1857 + /// </summary>
1858 public ExecuteMsiMessageEventArgs(string packageId, InstallMessage messageType, int dwUIHint, string message, string[] data, Result recommendation, Result result)
1859 : base(recommendation, result)
1860 {
@@ -1765,7 +1897,10 @@ namespace WixToolset.Mba.Core
1897 [Serializable]
1898 public class ExecuteFilesInUseEventArgs : ResultEventArgs
1899 {
1768 - /// <summary />
1900 + /// <summary>
1901 + /// This class is for events raised by the engine.
1902 + /// It is not intended to be instantiated by user code.
1903 + /// </summary>
1904 public ExecuteFilesInUseEventArgs(string packageId, string[] files, Result recommendation, FilesInUseType source, Result result)
1905 : base(recommendation, result)
1906 {
@@ -1792,12 +1927,14 @@ namespace WixToolset.Mba.Core
1927
1928 /// <summary>
1929 /// Event arguments for <see cref="IDefaultBootstrapperApplication.ExecutePackageComplete"/>
1795 - /// Additional arguments used when the engine has completed installing a specific package.
1930 /// </summary>
1931 [Serializable]
1932 public class ExecutePackageCompleteEventArgs : ActionEventArgs<BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION>
1933 {
1800 - /// <summary />
1934 + /// <summary>
1935 + /// This class is for events raised by the engine.
1936 + /// It is not intended to be instantiated by user code.
1937 + /// </summary>
1938 public ExecutePackageCompleteEventArgs(string packageId, int hrStatus, ApplyRestart restart, BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION recommendation, BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION action)
1939 : base(hrStatus, recommendation, action)
1940 {
@@ -1817,15 +1954,15 @@ namespace WixToolset.Mba.Core
1954 }
1955
1956 /// <summary>
1820 - /// Additional arguments used when the engine has completed installing packages.
1957 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.ExecuteComplete"/>.
1958 /// </summary>
1959 [Serializable]
1960 public class ExecuteCompleteEventArgs : StatusEventArgs
1961 {
1962 /// <summary>
1826 - /// Creates a new instance of the <see cref="ExecuteCompleteEventArgs"/> class.
1963 + /// This class is for events raised by the engine.
1964 + /// It is not intended to be instantiated by user code.
1965 /// </summary>
1828 - /// <param name="hrStatus">The return code of the operation.</param>
1966 public ExecuteCompleteEventArgs(int hrStatus)
1967 : base(hrStatus)
1968 {
@@ -1838,7 +1975,10 @@ namespace WixToolset.Mba.Core
1975 [Serializable]
1976 public class ApplyCompleteEventArgs : ActionEventArgs<BOOTSTRAPPER_APPLYCOMPLETE_ACTION>
1977 {
1841 - /// <summary />
1978 + /// <summary>
1979 + /// This class is for events raised by the engine.
1980 + /// It is not intended to be instantiated by user code.
1981 + /// </summary>
1982 public ApplyCompleteEventArgs(int hrStatus, ApplyRestart restart, BOOTSTRAPPER_APPLYCOMPLETE_ACTION recommendation, BOOTSTRAPPER_APPLYCOMPLETE_ACTION action)
1983 : base(hrStatus, recommendation, action)
1984 {
@@ -1857,7 +1997,10 @@ namespace WixToolset.Mba.Core
1997 [Serializable]
1998 public class ApplyDowngradeEventArgs : HResultEventArgs
1999 {
1860 - /// <summary />
2000 + /// <summary>
2001 + /// This class is for events raised by the engine.
2002 + /// It is not intended to be instantiated by user code.
2003 + /// </summary>
2004 public ApplyDowngradeEventArgs(int hrRecommendation, int hrStatus)
2005 {
2006 this.Recommendation = hrRecommendation;
@@ -1881,7 +2024,10 @@ namespace WixToolset.Mba.Core
2024 [Serializable]
2025 public class CacheAcquireResolvingEventArgs : CancellableActionEventArgs<CacheResolveOperation>
2026 {
1884 - /// <summary />
2027 + /// <summary>
2028 + /// This class is for events raised by the engine.
2029 + /// It is not intended to be instantiated by user code.
2030 + /// </summary>
2031 public CacheAcquireResolvingEventArgs(string packageOrContainerId, string payloadId, string[] searchPaths, bool foundLocal, int recommendedSearchPath, string downloadUrl, string payloadContainerId, CacheResolveOperation recommendation, int chosenSearchPath, CacheResolveOperation action, bool cancel)
2032 : base(cancel, recommendation, action)
2033 {
@@ -1942,7 +2088,10 @@ namespace WixToolset.Mba.Core
2088 [Serializable]
2089 public class CachePackageBeginEventArgs : CancellableHResultEventArgs
2090 {
1945 - /// <summary />
2091 + /// <summary>
2092 + /// This class is for events raised by the engine.
2093 + /// It is not intended to be instantiated by user code.
2094 + /// </summary>
2095 public CachePackageBeginEventArgs(string packageId, int cachePayloads, long packageCacheSize, bool vital, bool cancelRecommendation)
2096 : base(cancelRecommendation)
2097 {
@@ -1979,7 +2128,10 @@ namespace WixToolset.Mba.Core
2128 [Serializable]
2129 public class CachePackageCompleteEventArgs : ActionEventArgs<BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION>
2130 {
1982 - /// <summary />
2131 + /// <summary>
2132 + /// This class is for events raised by the engine.
2133 + /// It is not intended to be instantiated by user code.
2134 + /// </summary>
2135 public CachePackageCompleteEventArgs(string packageId, int hrStatus, BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION recommendation, BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION action)
2136 : base(hrStatus, recommendation, action)
2137 {
@@ -1998,7 +2150,10 @@ namespace WixToolset.Mba.Core
2150 [Serializable]
2151 public class ExecuteProgressEventArgs : CancellableHResultEventArgs
2152 {
2001 - /// <summary />
2153 + /// <summary>
2154 + /// This class is for events raised by the engine.
2155 + /// It is not intended to be instantiated by user code.
2156 + /// </summary>
2157 public ExecuteProgressEventArgs(string packageId, int progressPercentage, int overallPercentage, bool cancelRecommendation)
2158 : base(cancelRecommendation)
2159 {
@@ -2024,12 +2179,15 @@ namespace WixToolset.Mba.Core
2179 }
2180
2181 /// <summary>
2027 - /// Additional arguments passed by the engine before it tries to launch the preapproved executable.
2182 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.LaunchApprovedExeBegin"/>.
2183 /// </summary>
2184 [Serializable]
2185 public class LaunchApprovedExeBeginEventArgs : CancellableHResultEventArgs
2186 {
2032 - /// <summary />
2187 + /// <summary>
2188 + /// This class is for events raised by the engine.
2189 + /// It is not intended to be instantiated by user code.
2190 + /// </summary>
2191 public LaunchApprovedExeBeginEventArgs(bool cancelRecommendation)
2192 : base(cancelRecommendation)
2193 {
@@ -2037,12 +2195,15 @@ namespace WixToolset.Mba.Core
2195 }
2196
2197 /// <summary>
2040 - /// Additional arguments passed by the engine after it finished trying to launch the preapproved executable.
2198 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.LaunchApprovedExeComplete"/>.
2199 /// </summary>
2200 [Serializable]
2201 public class LaunchApprovedExeCompleteEventArgs : StatusEventArgs
2202 {
2045 - /// <summary />
2203 + /// <summary>
2204 + /// This class is for events raised by the engine.
2205 + /// It is not intended to be instantiated by user code.
2206 + /// </summary>
2207 public LaunchApprovedExeCompleteEventArgs(int hrStatus, int processId)
2208 : base(hrStatus)
2209 {
@@ -2057,12 +2218,15 @@ namespace WixToolset.Mba.Core
2218 }
2219
2220 /// <summary>
2060 - /// Additional arguments passed by the engine before beginning an MSI transaction.
2221 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.BeginMsiTransactionBegin"/>.
2222 /// </summary>
2223 [Serializable]
2224 public class BeginMsiTransactionBeginEventArgs : CancellableHResultEventArgs
2225 {
2065 - /// <summary />
2226 + /// <summary>
2227 + /// This class is for events raised by the engine.
2228 + /// It is not intended to be instantiated by user code.
2229 + /// </summary>
2230 public BeginMsiTransactionBeginEventArgs(string transactionId, bool cancelRecommendation)
2231 : base(cancelRecommendation)
2232 {
@@ -2076,12 +2240,15 @@ namespace WixToolset.Mba.Core
2240 }
2241
2242 /// <summary>
2079 - /// Additional arguments passed by the engine after beginning an MSI transaction.
2243 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.BeginMsiTransactionComplete"/>.
2244 /// </summary>
2245 [Serializable]
2246 public class BeginMsiTransactionCompleteEventArgs : StatusEventArgs
2247 {
2084 - /// <summary />
2248 + /// <summary>
2249 + /// This class is for events raised by the engine.
2250 + /// It is not intended to be instantiated by user code.
2251 + /// </summary>
2252 public BeginMsiTransactionCompleteEventArgs(string transactionId, int hrStatus)
2253 : base(hrStatus)
2254 {
@@ -2095,12 +2262,15 @@ namespace WixToolset.Mba.Core
2262 }
2263
2264 /// <summary>
2098 - /// Additional arguments passed by the engine before committing an MSI transaction.
2265 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.CommitMsiTransactionBegin"/>.
2266 /// </summary>
2267 [Serializable]
2268 public class CommitMsiTransactionBeginEventArgs : CancellableHResultEventArgs
2269 {
2103 - /// <summary />
2270 + /// <summary>
2271 + /// This class is for events raised by the engine.
2272 + /// It is not intended to be instantiated by user code.
2273 + /// </summary>
2274 public CommitMsiTransactionBeginEventArgs(string transactionId, bool cancelRecommendation)
2275 : base(cancelRecommendation)
2276 {
@@ -2114,12 +2284,15 @@ namespace WixToolset.Mba.Core
2284 }
2285
2286 /// <summary>
2117 - /// Additional arguments passed by the engine after committing an MSI transaction.
2287 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.CommitMsiTransactionComplete"/>.
2288 /// </summary>
2289 [Serializable]
2290 public class CommitMsiTransactionCompleteEventArgs : ActionEventArgs<BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION>
2291 {
2122 - /// <summary />
2292 + /// <summary>
2293 + /// This class is for events raised by the engine.
2294 + /// It is not intended to be instantiated by user code.
2295 + /// </summary>
2296 public CommitMsiTransactionCompleteEventArgs(string transactionId, int hrStatus, ApplyRestart restart, BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION recommendation, BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION action)
2297 : base(hrStatus, recommendation, action)
2298 {
@@ -2139,12 +2312,15 @@ namespace WixToolset.Mba.Core
2312 }
2313
2314 /// <summary>
2142 - /// Additional arguments passed by the engine before rolling back an MSI transaction.
2315 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.RollbackMsiTransactionBegin"/>.
2316 /// </summary>
2317 [Serializable]
2318 public class RollbackMsiTransactionBeginEventArgs : HResultEventArgs
2319 {
2147 - /// <summary />
2320 + /// <summary>
2321 + /// This class is for events raised by the engine.
2322 + /// It is not intended to be instantiated by user code.
2323 + /// </summary>
2324 public RollbackMsiTransactionBeginEventArgs(string transactionId)
2325 {
2326 this.TransactionId = transactionId;
@@ -2157,12 +2333,15 @@ namespace WixToolset.Mba.Core
2333 }
2334
2335 /// <summary>
2160 - /// Additional arguments passed by the engine after rolling back an MSI transaction.
2336 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.RollbackMsiTransactionComplete"/>.
2337 /// </summary>
2338 [Serializable]
2339 public class RollbackMsiTransactionCompleteEventArgs : ActionEventArgs<BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION>
2340 {
2165 - /// <summary />
2341 + /// <summary>
2342 + /// This class is for events raised by the engine.
2343 + /// It is not intended to be instantiated by user code.
2344 + /// </summary>
2345 public RollbackMsiTransactionCompleteEventArgs(string transactionId, int hrStatus, ApplyRestart restart, BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION recommendation, BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION action)
2346 : base(hrStatus, recommendation, action)
2347 {
@@ -2182,13 +2361,14 @@ namespace WixToolset.Mba.Core
2361 }
2362
2363 /// <summary>
2185 - /// Additional arguments passed by the engine before pausing Windows automatic updates.
2364 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.PauseAutomaticUpdatesBegin"/>.
2365 /// </summary>
2366 [Serializable]
2367 public class PauseAutomaticUpdatesBeginEventArgs : HResultEventArgs
2368 {
2369 /// <summary>
2191 - ///
2370 + /// This class is for events raised by the engine.
2371 + /// It is not intended to be instantiated by user code.
2372 /// </summary>
2373 public PauseAutomaticUpdatesBeginEventArgs()
2374 {
@@ -2196,15 +2376,15 @@ namespace WixToolset.Mba.Core
2376 }
2377
2378 /// <summary>
2199 - /// Additional arguments passed by the engine after pausing Windows automatic updates.
2379 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.PauseAutomaticUpdatesComplete"/>.
2380 /// </summary>
2381 [Serializable]
2382 public class PauseAutomaticUpdatesCompleteEventArgs : StatusEventArgs
2383 {
2384 /// <summary>
2205 - ///
2385 + /// This class is for events raised by the engine.
2386 + /// It is not intended to be instantiated by user code.
2387 /// </summary>
2207 - /// <param name="hrStatus"></param>
2388 public PauseAutomaticUpdatesCompleteEventArgs(int hrStatus)
2389 : base(hrStatus)
2390 {
@@ -2212,13 +2392,14 @@ namespace WixToolset.Mba.Core
2392 }
2393
2394 /// <summary>
2215 - /// Additional arguments passed by the engine before taking a system restore point.
2395 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.SystemRestorePointBegin"/>.
2396 /// </summary>
2397 [Serializable]
2398 public class SystemRestorePointBeginEventArgs : HResultEventArgs
2399 {
2400 /// <summary>
2221 - ///
2401 + /// This class is for events raised by the engine.
2402 + /// It is not intended to be instantiated by user code.
2403 /// </summary>
2404 public SystemRestorePointBeginEventArgs()
2405 {
@@ -2226,15 +2407,15 @@ namespace WixToolset.Mba.Core
2407 }
2408
2409 /// <summary>
2229 - /// Additional arguments passed by the engine after taking a system restore point.
2410 + /// Event arguments for <see cref="IDefaultBootstrapperApplication.SystemRestorePointComplete"/>.
2411 /// </summary>
2412 [Serializable]
2413 public class SystemRestorePointCompleteEventArgs : StatusEventArgs
2414 {
2415 /// <summary>
2235 - ///
2416 + /// This class is for events raised by the engine.
2417 + /// It is not intended to be instantiated by user code.
2418 /// </summary>
2237 - /// <param name="hrStatus"></param>
2419 public SystemRestorePointCompleteEventArgs(int hrStatus)
2420 : base(hrStatus)
2421 {
@@ -2247,7 +2428,10 @@ namespace WixToolset.Mba.Core
2428 [Serializable]
2429 public class CacheContainerOrPayloadVerifyBeginEventArgs : CancellableHResultEventArgs
2430 {
2250 - /// <summary />
2431 + /// <summary>
2432 + /// This class is for events raised by the engine.
2433 + /// It is not intended to be instantiated by user code.
2434 + /// </summary>
2435 public CacheContainerOrPayloadVerifyBeginEventArgs(string packageOrContainerId, string payloadId, bool cancelRecommendation)
2436 : base(cancelRecommendation)
2437 {
@@ -2272,7 +2456,10 @@ namespace WixToolset.Mba.Core
2456 [Serializable]
2457 public class CacheContainerOrPayloadVerifyProgressEventArgs : CacheProgressBaseEventArgs
2458 {
2275 - /// <summary />
2459 + /// <summary>
2460 + /// This class is for events raised by the engine.
2461 + /// It is not intended to be instantiated by user code.
2462 + /// </summary>
2463 public CacheContainerOrPayloadVerifyProgressEventArgs(string packageOrContainerId, string payloadId, long progress, long total, int overallPercentage, bool cancelRecommendation)
2464 : base(packageOrContainerId, payloadId, progress, total, overallPercentage, cancelRecommendation)
2465 {
@@ -2285,7 +2472,10 @@ namespace WixToolset.Mba.Core
2472 [Serializable]
2473 public class CacheContainerOrPayloadVerifyCompleteEventArgs : StatusEventArgs
2474 {
2288 - /// <summary />
2475 + /// <summary>
2476 + /// This class is for events raised by the engine.
2477 + /// It is not intended to be instantiated by user code.
2478 + /// </summary>
2479 public CacheContainerOrPayloadVerifyCompleteEventArgs(string packageOrContainerId, string payloadId, int hrStatus)
2480 : base(hrStatus)
2481 {
@@ -2310,7 +2500,10 @@ namespace WixToolset.Mba.Core
2500 [Serializable]
2501 public class CachePayloadExtractBeginEventArgs : CancellableHResultEventArgs
2502 {
2313 - /// <summary />
2503 + /// <summary>
2504 + /// This class is for events raised by the engine.
2505 + /// It is not intended to be instantiated by user code.
2506 + /// </summary>
2507 public CachePayloadExtractBeginEventArgs(string containerId, string payloadId, bool cancelRecommendation)
2508 : base(cancelRecommendation)
2509 {
@@ -2335,7 +2528,10 @@ namespace WixToolset.Mba.Core
2528 [Serializable]
2529 public class CachePayloadExtractProgressEventArgs : CacheProgressBaseEventArgs
2530 {
2338 - /// <summary />
2531 + /// <summary>
2532 + /// This class is for events raised by the engine.
2533 + /// It is not intended to be instantiated by user code.
2534 + /// </summary>
2535 public CachePayloadExtractProgressEventArgs(string containerId, string payloadId, long progress, long total, int overallPercentage, bool cancelRecommendation)
2536 : base(containerId, payloadId, progress, total, overallPercentage, cancelRecommendation)
2537 {
@@ -2348,7 +2544,10 @@ namespace WixToolset.Mba.Core
2544 [Serializable]
2545 public class CachePayloadExtractCompleteEventArgs : StatusEventArgs
2546 {
2351 - /// <summary />
2547 + /// <summary>
2548 + /// This class is for events raised by the engine.
2549 + /// It is not intended to be instantiated by user code.
2550 + /// </summary>
2551 public CachePayloadExtractCompleteEventArgs(string containerId, string payloadId, int hrStatus)
2552 : base(hrStatus)
2553 {
@@ -2373,7 +2572,10 @@ namespace WixToolset.Mba.Core
2572 [Serializable]
2573 public class SetUpdateBeginEventArgs : HResultEventArgs
2574 {
2376 - /// <summary />
2575 + /// <summary>
2576 + /// This class is for events raised by the engine.
2577 + /// It is not intended to be instantiated by user code.
2578 + /// </summary>
2579 public SetUpdateBeginEventArgs()
2580 {
2581 }
@@ -2385,7 +2587,10 @@ namespace WixToolset.Mba.Core
2587 [Serializable]
2588 public class SetUpdateCompleteEventArgs : StatusEventArgs
2589 {
2388 - /// <summary />
2590 + /// <summary>
2591 + /// This class is for events raised by the engine.
2592 + /// It is not intended to be instantiated by user code.
2593 + /// </summary>
2594 public SetUpdateCompleteEventArgs(int hrStatus, string previousPackageId, string newPackageId)
2595 : base(hrStatus)
2596 {
@@ -2410,7 +2615,10 @@ namespace WixToolset.Mba.Core
2615 [Serializable]
2616 public class PlanRestoreRelatedBundleEventArgs : CancellableHResultEventArgs
2617 {
2413 - /// <summary />
2618 + /// <summary>
2619 + /// This class is for events raised by the engine.
2620 + /// It is not intended to be instantiated by user code.
2621 + /// </summary>
2622 public PlanRestoreRelatedBundleEventArgs(string bundleId, RequestState recommendedState, RequestState state, bool cancelRecommendation)
2623 : base(cancelRecommendation)
2624 {
@@ -2441,7 +2649,10 @@ namespace WixToolset.Mba.Core
2649 [Serializable]
2650 public class ExecuteProcessCancelEventArgs : HResultEventArgs
2651 {
2444 - /// <summary />
2652 + /// <summary>
2653 + /// This class is for events raised by the engine.
2654 + /// It is not intended to be instantiated by user code.
2655 + /// </summary>
2656 public ExecuteProcessCancelEventArgs(string packageId, int processId, BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION recommendation, BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION action)
2657 {
2658 this.PackageId = packageId;
@@ -2477,7 +2688,10 @@ namespace WixToolset.Mba.Core
2688 [Serializable]
2689 public class DetectRelatedBundlePackageEventArgs : CancellableHResultEventArgs
2690 {
2480 - /// <summary />
2691 + /// <summary>
2692 + /// This class is for events raised by the engine.
2693 + /// It is not intended to be instantiated by user code.
2694 + /// </summary>
2695 public DetectRelatedBundlePackageEventArgs(string packageId, string productCode, RelationType relationType, bool perMachine, string version, bool cancelRecommendation)
2696 : base(cancelRecommendation)
2697 {
@@ -2520,7 +2734,10 @@ namespace WixToolset.Mba.Core
2734 [Serializable]
2735 public class CachePackageNonVitalValidationFailureEventArgs : ActionEventArgs<BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION>
2736 {
2523 - /// <summary />
2737 + /// <summary>
2738 + /// This class is for events raised by the engine.
2739 + /// It is not intended to be instantiated by user code.
2740 + /// </summary>
2741 public CachePackageNonVitalValidationFailureEventArgs(string packageId, int hrStatus, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION recommendation, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION action)
2742 : base(hrStatus, recommendation, action)
2743 {
src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
+58 -225
@@ -65,14 +65,6 @@ namespace WixToolset.Mba.Core
65 /// <summary>
66 /// See <see cref="IDefaultBootstrapperApplication.DetectForwardCompatibleBundle"/>.
67 /// </summary>
68 - /// <param name="wzBundleId"></param>
69 - /// <param name="relationType"></param>
70 - /// <param name="wzBundleTag"></param>
71 - /// <param name="fPerMachine"></param>
72 - /// <param name="wzVersion"></param>
73 - /// <param name="fMissingFromCache"></param>
74 - /// <param name="fCancel"></param>
75 - /// <returns></returns>
68 [PreserveSig]
69 [return: MarshalAs(UnmanagedType.I4)]
70 int OnDetectForwardCompatibleBundle(
@@ -88,10 +80,6 @@ namespace WixToolset.Mba.Core
80 /// <summary>
81 /// See <see cref="IDefaultBootstrapperApplication.DetectUpdateBegin"/>.
82 /// </summary>
91 - /// <param name="wzUpdateLocation"></param>
92 - /// <param name="fCancel"></param>
93 - /// <param name="fSkip"></param>
94 - /// <returns></returns>
83 [PreserveSig]
84 [return: MarshalAs(UnmanagedType.I4)]
85 int OnDetectUpdateBegin(
@@ -103,18 +91,6 @@ namespace WixToolset.Mba.Core
91 /// <summary>
92 /// See <see cref="IDefaultBootstrapperApplication.DetectUpdate"/>.
93 /// </summary>
106 - /// <param name="wzUpdateLocation"></param>
107 - /// <param name="dw64Size"></param>
108 - /// <param name="wzVersion"></param>
109 - /// <param name="wzHash"></param>
110 - /// <param name="hashAlgorithm"></param>
111 - /// <param name="wzTitle"></param>
112 - /// <param name="wzSummary"></param>
113 - /// <param name="wzContentType"></param>
114 - /// <param name="wzContent"></param>
115 - /// <param name="fCancel"></param>
116 - /// <param name="fStopProcessingUpdates"></param>
117 - /// <returns></returns>
94 [PreserveSig]
95 [return: MarshalAs(UnmanagedType.I4)]
96 int OnDetectUpdate(
@@ -134,9 +110,6 @@ namespace WixToolset.Mba.Core
110 /// <summary>
111 /// See <see cref="IDefaultBootstrapperApplication.DetectUpdateComplete"/>.
112 /// </summary>
137 - /// <param name="hrStatus"></param>
138 - /// <param name="fIgnoreError"></param>
139 - /// <returns></returns>
113 [PreserveSig]
114 [return: MarshalAs(UnmanagedType.I4)]
115 int OnDetectUpdateComplete(
@@ -162,9 +135,6 @@ namespace WixToolset.Mba.Core
135 /// <summary>
136 /// See <see cref="IDefaultBootstrapperApplication.DetectPackageBegin"/>.
137 /// </summary>
165 - /// <param name="wzPackageId"></param>
166 - /// <param name="fCancel"></param>
167 - /// <returns></returns>
138 [PreserveSig]
139 [return: MarshalAs(UnmanagedType.I4)]
140 int OnDetectPackageBegin(
@@ -202,11 +172,6 @@ namespace WixToolset.Mba.Core
172 /// <summary>
173 /// See <see cref="IDefaultBootstrapperApplication.DetectPatchTarget"/>.
174 /// </summary>
205 - /// <param name="wzPackageId"></param>
206 - /// <param name="wzProductCode"></param>
207 - /// <param name="patchState"></param>
208 - /// <param name="fCancel"></param>
209 - /// <returns></returns>
175 [PreserveSig]
176 [return: MarshalAs(UnmanagedType.I4)]
177 int OnDetectPatchTarget(
@@ -219,11 +184,6 @@ namespace WixToolset.Mba.Core
184 /// <summary>
185 /// See <see cref="IDefaultBootstrapperApplication.DetectMsiFeature"/>.
186 /// </summary>
222 - /// <param name="wzPackageId"></param>
223 - /// <param name="wzFeatureId"></param>
224 - /// <param name="state"></param>
225 - /// <param name="fCancel"></param>
226 - /// <returns></returns>
187 [PreserveSig]
188 [return: MarshalAs(UnmanagedType.I4)]
189 int OnDetectMsiFeature(
@@ -248,9 +208,6 @@ namespace WixToolset.Mba.Core
208 /// <summary>
209 /// See <see cref="IDefaultBootstrapperApplication.DetectComplete"/>.
210 /// </summary>
251 - /// <param name="hrStatus"></param>
252 - /// <param name="fEligibleForCleanup"></param>
253 - /// <returns></returns>
211 [PreserveSig]
212 [return: MarshalAs(UnmanagedType.I4)]
213 int OnDetectComplete(
@@ -261,9 +218,6 @@ namespace WixToolset.Mba.Core
218 /// <summary>
219 /// See <see cref="IDefaultBootstrapperApplication.PlanBegin"/>.
220 /// </summary>
264 - /// <param name="cPackages"></param>
265 - /// <param name="fCancel"></param>
266 - /// <returns></returns>
221 [PreserveSig]
222 [return: MarshalAs(UnmanagedType.I4)]
223 int OnPlanBegin(
@@ -342,12 +296,6 @@ namespace WixToolset.Mba.Core
296 /// <summary>
297 /// See <see cref="IDefaultBootstrapperApplication.PlanPatchTarget"/>.
298 /// </summary>
345 - /// <param name="wzPackageId"></param>
346 - /// <param name="wzProductCode"></param>
347 - /// <param name="recommendedState"></param>
348 - /// <param name="pRequestedState"></param>
349 - /// <param name="fCancel"></param>
350 - /// <returns></returns>
299 [PreserveSig]
300 [return: MarshalAs(UnmanagedType.I4)]
301 int OnPlanPatchTarget(
@@ -361,12 +309,6 @@ namespace WixToolset.Mba.Core
309 /// <summary>
310 /// See <see cref="IDefaultBootstrapperApplication.PlanMsiFeature"/>.
311 /// </summary>
364 - /// <param name="wzPackageId"></param>
365 - /// <param name="wzFeatureId"></param>
366 - /// <param name="recommendedState"></param>
367 - /// <param name="pRequestedState"></param>
368 - /// <param name="fCancel"></param>
369 - /// <returns></returns>
312 [PreserveSig]
313 [return: MarshalAs(UnmanagedType.I4)]
314 int OnPlanMsiFeature(
@@ -397,10 +339,6 @@ namespace WixToolset.Mba.Core
339 /// <summary>
340 /// See <see cref="IDefaultBootstrapperApplication.PlanPackageComplete"/>.
341 /// </summary>
400 - /// <param name="wzPackageId"></param>
401 - /// <param name="hrStatus"></param>
402 - /// <param name="requested"></param>
403 - /// <returns></returns>
342 [PreserveSig]
343 [return: MarshalAs(UnmanagedType.I4)]
344 int OnPlanPackageComplete(
@@ -436,8 +374,6 @@ namespace WixToolset.Mba.Core
374 /// <summary>
375 /// See <see cref="IDefaultBootstrapperApplication.PlanComplete"/>.
376 /// </summary>
439 - /// <param name="hrStatus"></param>
440 - /// <returns></returns>
377 [PreserveSig]
378 [return: MarshalAs(UnmanagedType.I4)]
379 int OnPlanComplete(
@@ -447,9 +383,6 @@ namespace WixToolset.Mba.Core
383 /// <summary>
384 /// See <see cref="IDefaultBootstrapperApplication.ApplyBegin"/>.
385 /// </summary>
450 - /// <param name="dwPhaseCount"></param>
451 - /// <param name="fCancel"></param>
452 - /// <returns></returns>
386 [PreserveSig]
387 [return: MarshalAs(UnmanagedType.I4)]
388 int OnApplyBegin(
@@ -460,8 +393,6 @@ namespace WixToolset.Mba.Core
393 /// <summary>
394 /// See <see cref="IDefaultBootstrapperApplication.ElevateBegin"/>.
395 /// </summary>
463 - /// <param name="fCancel"></param>
464 - /// <returns></returns>
396 [PreserveSig]
397 [return: MarshalAs(UnmanagedType.I4)]
398 int OnElevateBegin(
@@ -471,8 +402,6 @@ namespace WixToolset.Mba.Core
402 /// <summary>
403 /// See <see cref="IDefaultBootstrapperApplication.ElevateComplete"/>.
404 /// </summary>
474 - /// <param name="hrStatus"></param>
475 - /// <returns></returns>
405 [PreserveSig]
406 [return: MarshalAs(UnmanagedType.I4)]
407 int OnElevateComplete(
@@ -482,10 +411,6 @@ namespace WixToolset.Mba.Core
411 /// <summary>
412 /// See <see cref="IDefaultBootstrapperApplication.Progress"/>.
413 /// </summary>
485 - /// <param name="dwProgressPercentage"></param>
486 - /// <param name="dwOverallPercentage"></param>
487 - /// <param name="fCancel"></param>
488 - /// <returns></returns>
414 [PreserveSig]
415 [return: MarshalAs(UnmanagedType.I4)]
416 int OnProgress(
@@ -497,16 +422,6 @@ namespace WixToolset.Mba.Core
422 /// <summary>
423 /// See <see cref="IDefaultBootstrapperApplication.Error"/>.
424 /// </summary>
500 - /// <param name="errorType"></param>
501 - /// <param name="wzPackageId"></param>
502 - /// <param name="dwCode"></param>
503 - /// <param name="wzError"></param>
504 - /// <param name="dwUIHint"></param>
505 - /// <param name="cData"></param>
506 - /// <param name="rgwzData"></param>
507 - /// <param name="nRecommendation"></param>
508 - /// <param name="pResult"></param>
509 - /// <returns></returns>
425 [PreserveSig]
426 [return: MarshalAs(UnmanagedType.I4)]
427 int OnError(
@@ -535,8 +450,6 @@ namespace WixToolset.Mba.Core
450 /// <summary>
451 /// See <see cref="IDefaultBootstrapperApplication.RegisterComplete"/>.
452 /// </summary>
538 - /// <param name="hrStatus"></param>
539 - /// <returns></returns>
453 [PreserveSig]
454 [return: MarshalAs(UnmanagedType.I4)]
455 int OnRegisterComplete(
@@ -546,8 +459,6 @@ namespace WixToolset.Mba.Core
459 /// <summary>
460 /// See <see cref="IDefaultBootstrapperApplication.CacheBegin"/>.
461 /// </summary>
549 - /// <param name="fCancel"></param>
550 - /// <returns></returns>
462 [PreserveSig]
463 [return: MarshalAs(UnmanagedType.I4)]
464 int OnCacheBegin(
@@ -695,9 +606,6 @@ namespace WixToolset.Mba.Core
606 /// <summary>
607 /// See <see cref="IDefaultBootstrapperApplication.ExecuteBegin"/>.
608 /// </summary>
698 - /// <param name="cExecutingPackages"></param>
699 - /// <param name="fCancel"></param>
700 - /// <returns></returns>
609 [PreserveSig]
610 [return: MarshalAs(UnmanagedType.I4)]
611 int OnExecuteBegin(
@@ -708,13 +616,6 @@ namespace WixToolset.Mba.Core
616 /// <summary>
617 /// See <see cref="IDefaultBootstrapperApplication.ExecutePackageBegin"/>.
618 /// </summary>
711 - /// <param name="wzPackageId"></param>
712 - /// <param name="fExecute"></param>
713 - /// <param name="action"></param>
714 - /// <param name="uiLevel"></param>
715 - /// <param name="fDisableExternalUiHandler"></param>
716 - /// <param name="fCancel"></param>
717 - /// <returns></returns>
619 [PreserveSig]
620 [return: MarshalAs(UnmanagedType.I4)]
621 int OnExecutePackageBegin(
@@ -729,10 +630,6 @@ namespace WixToolset.Mba.Core
630 /// <summary>
631 /// See <see cref="IDefaultBootstrapperApplication.ExecutePatchTarget"/>.
632 /// </summary>
732 - /// <param name="wzPackageId"></param>
733 - /// <param name="wzTargetProductCode"></param>
734 - /// <param name="fCancel"></param>
735 - /// <returns></returns>
633 [PreserveSig]
634 [return: MarshalAs(UnmanagedType.I4)]
635 int OnExecutePatchTarget(
@@ -744,11 +641,6 @@ namespace WixToolset.Mba.Core
641 /// <summary>
642 /// See <see cref="IDefaultBootstrapperApplication.ExecuteProgress"/>.
643 /// </summary>
747 - /// <param name="wzPackageId"></param>
748 - /// <param name="dwProgressPercentage"></param>
749 - /// <param name="dwOverallPercentage"></param>
750 - /// <param name="fCancel"></param>
751 - /// <returns></returns>
644 [PreserveSig]
645 [return: MarshalAs(UnmanagedType.I4)]
646 int OnExecuteProgress(
@@ -761,15 +653,6 @@ namespace WixToolset.Mba.Core
653 /// <summary>
654 /// See <see cref="IDefaultBootstrapperApplication.ExecuteMsiMessage"/>.
655 /// </summary>
764 - /// <param name="wzPackageId"></param>
765 - /// <param name="messageType"></param>
766 - /// <param name="dwUIHint"></param>
767 - /// <param name="wzMessage"></param>
768 - /// <param name="cData"></param>
769 - /// <param name="rgwzData"></param>
770 - /// <param name="nRecommendation"></param>
771 - /// <param name="pResult"></param>
772 - /// <returns></returns>
656 [PreserveSig]
657 [return: MarshalAs(UnmanagedType.I4)]
658 int OnExecuteMsiMessage(
@@ -800,12 +683,6 @@ namespace WixToolset.Mba.Core
683 /// <summary>
684 /// See <see cref="IDefaultBootstrapperApplication.ExecutePackageComplete"/>.
685 /// </summary>
803 - /// <param name="wzPackageId"></param>
804 - /// <param name="hrStatus"></param>
805 - /// <param name="restart"></param>
806 - /// <param name="recommendation"></param>
807 - /// <param name="pAction"></param>
808 - /// <returns></returns>
686 [PreserveSig]
687 [return: MarshalAs(UnmanagedType.I4)]
688 int OnExecutePackageComplete(
@@ -819,8 +696,6 @@ namespace WixToolset.Mba.Core
696 /// <summary>
697 /// See <see cref="IDefaultBootstrapperApplication.ExecuteComplete"/>.
698 /// </summary>
822 - /// <param name="hrStatus"></param>
823 - /// <returns></returns>
699 [PreserveSig]
700 [return: MarshalAs(UnmanagedType.I4)]
701 int OnExecuteComplete(
@@ -840,8 +715,6 @@ namespace WixToolset.Mba.Core
715 /// <summary>
716 /// See <see cref="IDefaultBootstrapperApplication.UnregisterComplete"/>.
717 /// </summary>
843 - /// <param name="hrStatus"></param>
844 - /// <returns></returns>
718 [PreserveSig]
719 [return: MarshalAs(UnmanagedType.I4)]
720 int OnUnregisterComplete(
@@ -851,11 +724,6 @@ namespace WixToolset.Mba.Core
724 /// <summary>
725 /// See <see cref="IDefaultBootstrapperApplication.ApplyComplete"/>.
726 /// </summary>
854 - /// <param name="hrStatus"></param>
855 - /// <param name="restart"></param>
856 - /// <param name="recommendation"></param>
857 - /// <param name="pAction"></param>
858 - /// <returns></returns>
727 [PreserveSig]
728 [return: MarshalAs(UnmanagedType.I4)]
729 int OnApplyComplete(
@@ -868,8 +736,6 @@ namespace WixToolset.Mba.Core
736 /// <summary>
737 /// See <see cref="IDefaultBootstrapperApplication.LaunchApprovedExeBegin"/>.
738 /// </summary>
871 - /// <param name="fCancel"></param>
872 - /// <returns></returns>
739 [PreserveSig]
740 [return: MarshalAs(UnmanagedType.I4)]
741 int OnLaunchApprovedExeBegin(
@@ -879,9 +745,6 @@ namespace WixToolset.Mba.Core
745 /// <summary>
746 /// See <see cref="IDefaultBootstrapperApplication.LaunchApprovedExeComplete"/>.
747 /// </summary>
882 - /// <param name="hrStatus"></param>
883 - /// <param name="processId"></param>
884 - /// <returns></returns>
748 [PreserveSig]
749 [return: MarshalAs(UnmanagedType.I4)]
750 int OnLaunchApprovedExeComplete(
@@ -892,9 +755,6 @@ namespace WixToolset.Mba.Core
755 /// <summary>
756 /// See <see cref="IDefaultBootstrapperApplication.BeginMsiTransactionBegin"/>.
757 /// </summary>
895 - /// <param name="wzTransactionId"></param>
896 - /// <param name="fCancel"></param>
897 - /// <returns></returns>
758 [PreserveSig]
759 [return: MarshalAs(UnmanagedType.I4)]
760 int OnBeginMsiTransactionBegin(
@@ -905,9 +765,6 @@ namespace WixToolset.Mba.Core
765 /// <summary>
766 /// See <see cref="IDefaultBootstrapperApplication.BeginMsiTransactionComplete"/>.
767 /// </summary>
908 - /// <param name="wzTransactionId"></param>
909 - /// <param name="hrStatus"></param>
910 - /// <returns></returns>
768 [PreserveSig]
769 [return: MarshalAs(UnmanagedType.I4)]
770 int OnBeginMsiTransactionComplete(
@@ -918,9 +775,6 @@ namespace WixToolset.Mba.Core
775 /// <summary>
776 /// See <see cref="IDefaultBootstrapperApplication.CommitMsiTransactionBegin"/>.
777 /// </summary>
921 - /// <param name="wzTransactionId"></param>
922 - /// <param name="fCancel"></param>
923 - /// <returns></returns>
778 [PreserveSig]
779 [return: MarshalAs(UnmanagedType.I4)]
780 int OnCommitMsiTransactionBegin(
@@ -931,12 +785,6 @@ namespace WixToolset.Mba.Core
785 /// <summary>
786 /// See <see cref="IDefaultBootstrapperApplication.CommitMsiTransactionComplete"/>.
787 /// </summary>
934 - /// <param name="wzTransactionId"></param>
935 - /// <param name="hrStatus"></param>
936 - /// <param name="restart"></param>
937 - /// <param name="recommendation"></param>
938 - /// <param name="pAction"></param>
939 - /// <returns></returns>
788 [PreserveSig]
789 [return: MarshalAs(UnmanagedType.I4)]
790 int OnCommitMsiTransactionComplete(
@@ -950,8 +798,6 @@ namespace WixToolset.Mba.Core
798 /// <summary>
799 /// See <see cref="IDefaultBootstrapperApplication.RollbackMsiTransactionBegin"/>.
800 /// </summary>
953 - /// <param name="wzTransactionId"></param>
954 - /// <returns></returns>
801 [PreserveSig]
802 [return: MarshalAs(UnmanagedType.I4)]
803 int OnRollbackMsiTransactionBegin(
@@ -961,12 +807,6 @@ namespace WixToolset.Mba.Core
807 /// <summary>
808 /// See <see cref="IDefaultBootstrapperApplication.RollbackMsiTransactionComplete"/>.
809 /// </summary>
964 - /// <param name="wzTransactionId"></param>
965 - /// <param name="hrStatus"></param>
966 - /// <param name="restart"></param>
967 - /// <param name="recommendation"></param>
968 - /// <param name="pAction"></param>
969 - /// <returns></returns>
810 [PreserveSig]
811 [return: MarshalAs(UnmanagedType.I4)]
812 int OnRollbackMsiTransactionComplete(
@@ -980,7 +820,6 @@ namespace WixToolset.Mba.Core
820 /// <summary>
821 /// See <see cref="IDefaultBootstrapperApplication.PauseAutomaticUpdatesBegin"/>.
822 /// </summary>
983 - /// <returns></returns>
823 [PreserveSig]
824 [return: MarshalAs(UnmanagedType.I4)]
825 int OnPauseAutomaticUpdatesBegin(
@@ -989,8 +828,6 @@ namespace WixToolset.Mba.Core
828 /// <summary>
829 /// See <see cref="IDefaultBootstrapperApplication.PauseAutomaticUpdatesComplete"/>.
830 /// </summary>
992 - /// <param name="hrStatus"></param>
993 - /// <returns></returns>
831 [PreserveSig]
832 [return: MarshalAs(UnmanagedType.I4)]
833 int OnPauseAutomaticUpdatesComplete(
@@ -1000,7 +837,6 @@ namespace WixToolset.Mba.Core
837 /// <summary>
838 /// See <see cref="IDefaultBootstrapperApplication.SystemRestorePointBegin"/>.
839 /// </summary>
1003 - /// <returns></returns>
840 [PreserveSig]
841 [return: MarshalAs(UnmanagedType.I4)]
842 int OnSystemRestorePointBegin(
@@ -1009,8 +845,6 @@ namespace WixToolset.Mba.Core
845 /// <summary>
846 /// See <see cref="IDefaultBootstrapperApplication.SystemRestorePointComplete"/>.
847 /// </summary>
1012 - /// <param name="hrStatus"></param>
1013 - /// <returns></returns>
848 [PreserveSig]
849 [return: MarshalAs(UnmanagedType.I4)]
850 int OnSystemRestorePointComplete(
@@ -1020,15 +854,6 @@ namespace WixToolset.Mba.Core
854 /// <summary>
855 /// See <see cref="IDefaultBootstrapperApplication.PlanForwardCompatibleBundle"/>.
856 /// </summary>
1023 - /// <param name="wzBundleId"></param>
1024 - /// <param name="relationType"></param>
1025 - /// <param name="wzBundleTag"></param>
1026 - /// <param name="fPerMachine"></param>
1027 - /// <param name="wzVersion"></param>
1028 - /// <param name="fRecommendedIgnoreBundle"></param>
1029 - /// <param name="fCancel"></param>
1030 - /// <param name="fIgnoreBundle"></param>
1031 - /// <returns></returns>
857 [PreserveSig]
858 [return: MarshalAs(UnmanagedType.I4)]
859 int OnPlanForwardCompatibleBundle(
@@ -1211,27 +1036,27 @@ namespace WixToolset.Mba.Core
1036 public enum Display
1037 {
1038 /// <summary>
1214 - ///
1039 + /// Invalid value.
1040 /// </summary>
1041 Unknown,
1042
1043 /// <summary>
1219 - ///
1044 + /// The bundle is being run through the Burn protocol by an external application.
1045 /// </summary>
1046 Embedded,
1047
1048 /// <summary>
1224 - ///
1049 + /// No UI should be shown.
1050 /// </summary>
1051 None,
1052
1053 /// <summary>
1229 - ///
1054 + /// The UI should not require any interaction from the user.
1055 /// </summary>
1056 Passive,
1057
1058 /// <summary>
1234 - ///
1059 + /// The UI should be fully interactive.
1060 /// </summary>
1061 Full,
1062 }
@@ -1343,27 +1168,27 @@ namespace WixToolset.Mba.Core
1168 public enum Restart
1169 {
1170 /// <summary>
1346 - ///
1171 + /// Invalid value.
1172 /// </summary>
1173 Unknown,
1174
1175 /// <summary>
1351 - ///
1176 + /// The bundle should never initiate a restart.
1177 /// </summary>
1178 Never,
1179
1180 /// <summary>
1356 - ///
1181 + /// The bundle should prompt the user whether to restart.
1182 /// </summary>
1183 Prompt,
1184
1185 /// <summary>
1361 - ///
1186 + /// The bundle should restart if necessary.
1187 /// </summary>
1188 Automatic,
1189
1190 /// <summary>
1366 - ///
1191 + /// The bundle should always restart when given the option.
1192 /// </summary>
1193 Always,
1194 }
@@ -1396,67 +1221,67 @@ namespace WixToolset.Mba.Core
1221 public enum Result
1222 {
1223 /// <summary>
1399 - ///
1224 + /// An error occurred.
1225 /// </summary>
1226 Error = -1,
1227
1228 /// <summary>
1404 - ///
1229 + /// Invalid value.
1230 /// </summary>
1231 None,
1232
1233 /// <summary>
1409 - ///
1234 + /// IDOK
1235 /// </summary>
1236 Ok,
1237
1238 /// <summary>
1414 - ///
1239 + /// IDCANCEL
1240 /// </summary>
1241 Cancel,
1242
1243 /// <summary>
1419 - ///
1244 + /// IDABORT
1245 /// </summary>
1246 Abort,
1247
1248 /// <summary>
1424 - ///
1249 + /// IDRETRY
1250 /// </summary>
1251 Retry,
1252
1253 /// <summary>
1429 - ///
1254 + /// IDIGNORE
1255 /// </summary>
1256 Ignore,
1257
1258 /// <summary>
1434 - ///
1259 + /// IDYES
1260 /// </summary>
1261 Yes,
1262
1263 /// <summary>
1439 - ///
1264 + /// IDNO
1265 /// </summary>
1266 No,
1267
1268 /// <summary>
1444 - /// /
1269 + /// IDCLOSE
1270 /// </summary>
1271 Close,
1272
1273 /// <summary>
1449 - ///
1274 + /// IDHELP
1275 /// </summary>
1276 Help,
1277
1278 /// <summary>
1454 - ///
1279 + /// IDTRYAGAIN
1280 /// </summary>
1281 TryAgain,
1282
1283 /// <summary>
1459 - ///
1284 + /// IDCONTINUE
1285 /// </summary>
1286 Continue,
1287 }
@@ -1467,7 +1292,7 @@ namespace WixToolset.Mba.Core
1292 public enum ResumeType
1293 {
1294 /// <summary>
1470 - ///
1295 + /// No resume information.
1296 /// </summary>
1297 None,
1298
@@ -1553,12 +1378,12 @@ namespace WixToolset.Mba.Core
1378 }
1379
1380 /// <summary>
1556 - /// The calculated operation for the related bundle.
1381 + /// The calculated operation for the related MSI package.
1382 /// </summary>
1383 public enum RelatedOperation
1384 {
1385 /// <summary>
1561 - ///
1386 + /// No relation.
1387 /// </summary>
1388 None,
1389
@@ -1697,47 +1522,55 @@ namespace WixToolset.Mba.Core
1522 public enum RelationType
1523 {
1524 /// <summary>
1700 - ///
1525 + /// No relation.
1526 /// </summary>
1527 None,
1528
1529 /// <summary>
1705 - ///
1530 + /// The related bundle is detected by the running bundle.
1531 + /// This relationship is reversed for <see cref="IBootstrapperCommand.Relation" />
1532 /// </summary>
1533 Detect,
1534
1535 /// <summary>
1710 - ///
1536 + /// The related bundle shares an upgrade code with the running bundle.
1537 + /// This relationship is reversed for <see cref="IBootstrapperCommand.Relation" />
1538 /// </summary>
1539 Upgrade,
1540
1541 /// <summary>
1715 - ///
1542 + /// The related bundle is an add-on for the running bundle.
1543 + /// This relationship is reversed for <see cref="IBootstrapperCommand.Relation" />
1544 /// </summary>
1545 Addon,
1546
1547 /// <summary>
1720 - ///
1548 + /// The related bundle is a patch for the running bundle.
1549 + /// This relationship is reversed for <see cref="IBootstrapperCommand.Relation" />
1550 /// </summary>
1551 Patch,
1552
1553 /// <summary>
1725 - ///
1554 + /// The running bundle is an add-on for the related bundle.
1555 + /// This relationship is reversed for <see cref="IBootstrapperCommand.Relation" />
1556 /// </summary>
1557 DependentAddon,
1558
1559 /// <summary>
1730 - ///
1560 + /// The running bundle is a patch for the related bundle.
1561 + /// This relationship is reversed for <see cref="IBootstrapperCommand.Relation" />
1562 /// </summary>
1563 DependentPatch,
1564
1565 /// <summary>
1735 - ///
1566 + /// The related bundle is a newer version of the running bundle.
1567 + /// This relationship is reversed for <see cref="IBootstrapperCommand.Relation" />
1568 /// </summary>
1569 Update,
1570
1571 /// <summary>
1740 - ///
1572 + /// The related bundle is in the running bundle's chain.
1573 + /// This relationship is reversed for <see cref="IBootstrapperCommand.Relation" />
1574 /// </summary>
1575 ChainPackage,
1576 }
@@ -1748,37 +1581,37 @@ namespace WixToolset.Mba.Core
1581 public enum RelatedBundlePlanType
1582 {
1583 /// <summary>
1751 - ///
1584 + /// Don't execute the related bundle.
1585 /// </summary>
1586 None,
1587
1588 /// <summary>
1756 - ///
1589 + /// The running bundle is a downgrade for the related bundle.
1590 /// </summary>
1591 Downgrade,
1592
1593 /// <summary>
1761 - ///
1594 + /// The running bundle is an upgrade for the related bundle.
1595 /// </summary>
1596 Upgrade,
1597
1598 /// <summary>
1766 - ///
1599 + /// The related bundle is an add-on of the running bundle.
1600 /// </summary>
1601 Addon,
1602
1603 /// <summary>
1771 - ///
1604 + /// The related bundle is a patch for the running bundle.
1605 /// </summary>
1606 Patch,
1607
1608 /// <summary>
1776 - ///
1609 + /// The running bundle is an add-on for the related bundle.
1610 /// </summary>
1611 DependentAddon,
1612
1613 /// <summary>
1781 - ///
1614 + /// The running bundle is a patch for the related bundle.
1615 /// </summary>
1616 DependentPatch,
1617 }
@@ -1816,7 +1649,7 @@ namespace WixToolset.Mba.Core
1649 public enum BOOTSTRAPPER_APPLYCOMPLETE_ACTION
1650 {
1651 /// <summary>
1819 - ///
1652 + /// Instructs the engine to not take any special action.
1653 /// </summary>
1654 None,
1655
@@ -1855,7 +1688,7 @@ namespace WixToolset.Mba.Core
1688 public enum BOOTSTRAPPER_CACHEACQUIRECOMPLETE_ACTION
1689 {
1690 /// <summary>
1858 - ///
1691 + /// Instructs the engine to not take any special action.
1692 /// </summary>
1693 None,
1694
@@ -1872,7 +1705,7 @@ namespace WixToolset.Mba.Core
1705 public enum BOOTSTRAPPER_CACHEPACKAGECOMPLETE_ACTION
1706 {
1707 /// <summary>
1875 - ///
1708 + /// Instructs the engine to not take any special action.
1709 /// </summary>
1710 None,
1711
@@ -1895,7 +1728,7 @@ namespace WixToolset.Mba.Core
1728 public enum BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION
1729 {
1730 /// <summary>
1898 - ///
1731 + /// Instructs the engine to not take any special action.
1732 /// </summary>
1733 None,
1734
@@ -1912,7 +1745,7 @@ namespace WixToolset.Mba.Core
1745 public enum BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION
1746 {
1747 /// <summary>
1915 - ///
1748 + /// Instructs the engine to not take any special action.
1749 /// </summary>
1750 None,
1751
@@ -1933,7 +1766,7 @@ namespace WixToolset.Mba.Core
1766 public enum BOOTSTRAPPER_EXECUTEPACKAGECOMPLETE_ACTION
1767 {
1768 /// <summary>
1936 - ///
1769 + /// Instructs the engine to not take any special action.
1770 /// </summary>
1771 None,
1772
@@ -1967,7 +1800,7 @@ namespace WixToolset.Mba.Core
1800 public enum BOOTSTRAPPER_EXECUTEMSITRANSACTIONCOMPLETE_ACTION
1801 {
1802 /// <summary>
1970 - ///
1803 + /// Instructs the engine to not take any special action.
1804 /// </summary>
1805 None,
1806
@@ -2046,7 +1879,7 @@ namespace WixToolset.Mba.Core
1879 public enum BOOTSTRAPPER_SHUTDOWN_ACTION
1880 {
1881 /// <summary>
2049 - ///
1882 + /// Instructs the engine to not take any special action.
1883 /// </summary>
1884 None,
1885
src/api/burn/WixToolset.Mba.Core/IBootstrapperApplicationFactory.cs
+1 -1
@@ -7,7 +7,7 @@ namespace WixToolset.Mba.Core
7 using System.Runtime.InteropServices;
8
9 /// <summary>
10 - /// Interface used by WixToolset.Mba.Host to dynamically load the BA.
10 + /// Interface used by the native host to dynamically load the BA.
11 /// </summary>
12 [ComVisible(true)]
13 [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
src/api/burn/WixToolset.Mba.Core/IBootstrapperEngine.cs
+39 -85
@@ -19,7 +19,6 @@ namespace WixToolset.Mba.Core
19 /// <summary>
20 /// See <see cref="IEngine.PackageCount"/>.
21 /// </summary>
22 - /// <param name="pcPackages"></param>
22 void GetPackageCount(
23 [MarshalAs(UnmanagedType.U4)] out int pcPackages
24 );
@@ -27,9 +26,6 @@ namespace WixToolset.Mba.Core
26 /// <summary>
27 /// See <see cref="IEngine.GetVariableNumeric(string)"/>.
28 /// </summary>
30 - /// <param name="wzVariable"></param>
31 - /// <param name="pllValue"></param>
32 - /// <returns></returns>
29 [PreserveSig]
30 int GetVariableNumeric(
31 [MarshalAs(UnmanagedType.LPWStr)] string wzVariable,
@@ -79,8 +75,6 @@ namespace WixToolset.Mba.Core
75 /// <summary>
76 /// See <see cref="IEngine.EvaluateCondition(string)"/>.
77 /// </summary>
82 - /// <param name="wzCondition"></param>
83 - /// <param name="pf"></param>
78 void EvaluateCondition(
79 [MarshalAs(UnmanagedType.LPWStr)] string wzCondition,
80 [MarshalAs(UnmanagedType.Bool)] out bool pf
@@ -89,8 +83,6 @@ namespace WixToolset.Mba.Core
83 /// <summary>
84 /// See <see cref="IEngine.Log(LogLevel, string)"/>.
85 /// </summary>
92 - /// <param name="level"></param>
93 - /// <param name="wzMessage"></param>
86 void Log(
87 [MarshalAs(UnmanagedType.U4)] LogLevel level,
88 [MarshalAs(UnmanagedType.LPWStr)] string wzMessage
@@ -99,10 +91,6 @@ namespace WixToolset.Mba.Core
91 /// <summary>
92 /// See <see cref="IEngine.SendEmbeddedError(int, string, int)"/>.
93 /// </summary>
102 - /// <param name="dwErrorCode"></param>
103 - /// <param name="wzMessage"></param>
104 - /// <param name="dwUIHint"></param>
105 - /// <param name="pnResult"></param>
94 void SendEmbeddedError(
95 [MarshalAs(UnmanagedType.U4)] int dwErrorCode,
96 [MarshalAs(UnmanagedType.LPWStr)] string wzMessage,
@@ -113,9 +101,6 @@ namespace WixToolset.Mba.Core
101 /// <summary>
102 /// See <see cref="IEngine.SendEmbeddedProgress(int, int)"/>.
103 /// </summary>
116 - /// <param name="dwProgressPercentage"></param>
117 - /// <param name="dwOverallProgressPercentage"></param>
118 - /// <param name="pnResult"></param>
104 void SendEmbeddedProgress(
105 [MarshalAs(UnmanagedType.U4)] int dwProgressPercentage,
106 [MarshalAs(UnmanagedType.U4)] int dwOverallProgressPercentage,
@@ -125,11 +110,6 @@ namespace WixToolset.Mba.Core
110 /// <summary>
111 /// See <see cref="IEngine.SetUpdate(string, string, long, UpdateHashType, string)"/>.
112 /// </summary>
128 - /// <param name="wzLocalSource"></param>
129 - /// <param name="wzDownloadSource"></param>
130 - /// <param name="qwValue"></param>
131 - /// <param name="hashType"></param>
132 - /// <param name="wzHash"></param>
113 void SetUpdate(
114 [MarshalAs(UnmanagedType.LPWStr)] string wzLocalSource,
115 [MarshalAs(UnmanagedType.LPWStr)] string wzDownloadSource,
@@ -141,9 +121,6 @@ namespace WixToolset.Mba.Core
121 /// <summary>
122 /// See <see cref="IEngine.SetLocalSource(string, string, string)"/>.
123 /// </summary>
144 - /// <param name="wzPackageOrContainerId"></param>
145 - /// <param name="wzPayloadId"></param>
146 - /// <param name="wzPath"></param>
124 void SetLocalSource(
125 [MarshalAs(UnmanagedType.LPWStr)] string wzPackageOrContainerId,
126 [MarshalAs(UnmanagedType.LPWStr)] string wzPayloadId,
@@ -153,11 +130,6 @@ namespace WixToolset.Mba.Core
130 /// <summary>
131 /// See <see cref="IEngine.SetDownloadSource(string, string, string, string, string)"/>.
132 /// </summary>
156 - /// <param name="wzPackageOrContainerId"></param>
157 - /// <param name="wzPayloadId"></param>
158 - /// <param name="wzUrl"></param>
159 - /// <param name="wzUser"></param>
160 - /// <param name="wzPassword"></param>
133 void SetDownloadSource(
134 [MarshalAs(UnmanagedType.LPWStr)] string wzPackageOrContainerId,
135 [MarshalAs(UnmanagedType.LPWStr)] string wzPayloadId,
@@ -169,8 +141,6 @@ namespace WixToolset.Mba.Core
141 /// <summary>
142 /// See <see cref="IEngine.SetVariableNumeric(string, long)"/>.
143 /// </summary>
172 - /// <param name="wzVariable"></param>
173 - /// <param name="llValue"></param>
144 void SetVariableNumeric(
145 [MarshalAs(UnmanagedType.LPWStr)] string wzVariable,
146 long llValue
@@ -179,9 +149,6 @@ namespace WixToolset.Mba.Core
149 /// <summary>
150 /// See <see cref="IEngine.SetVariableString(string, string, bool)"/>.
151 /// </summary>
182 - /// <param name="wzVariable"></param>
183 - /// <param name="wzValue"></param>
184 - /// <param name="fFormatted"></param>
152 void SetVariableString(
153 [MarshalAs(UnmanagedType.LPWStr)] string wzVariable,
154 IntPtr wzValue,
@@ -191,8 +158,6 @@ namespace WixToolset.Mba.Core
158 /// <summary>
159 /// See <see cref="IEngine.SetVariableVersion(string, string)"/>.
160 /// </summary>
194 - /// <param name="wzVariable"></param>
195 - /// <param name="wzValue"></param>
161 void SetVariableVersion(
162 [MarshalAs(UnmanagedType.LPWStr)] string wzVariable,
163 IntPtr wzValue
@@ -206,7 +171,6 @@ namespace WixToolset.Mba.Core
171 /// <summary>
172 /// See <see cref="IEngine.Detect(IntPtr)"/>.
173 /// </summary>
209 - /// <param name="hwndParent"></param>
174 void Detect(
175 IntPtr hwndParent
176 );
@@ -214,7 +178,6 @@ namespace WixToolset.Mba.Core
178 /// <summary>
179 /// See <see cref="IEngine.Plan(LaunchAction)"/>.
180 /// </summary>
217 - /// <param name="action"></param>
181 void Plan(
182 [MarshalAs(UnmanagedType.U4)] LaunchAction action
183 );
@@ -222,8 +185,6 @@ namespace WixToolset.Mba.Core
185 /// <summary>
186 /// See <see cref="IEngine.Elevate(IntPtr)"/>.
187 /// </summary>
225 - /// <param name="hwndParent"></param>
226 - /// <returns></returns>
188 [PreserveSig]
189 int Elevate(
190 IntPtr hwndParent
@@ -232,7 +193,6 @@ namespace WixToolset.Mba.Core
193 /// <summary>
194 /// See <see cref="IEngine.Apply(IntPtr)"/>.
195 /// </summary>
235 - /// <param name="hwndParent"></param>
196 void Apply(
197 IntPtr hwndParent
198 );
@@ -240,7 +200,6 @@ namespace WixToolset.Mba.Core
200 /// <summary>
201 /// See <see cref="IEngine.Quit(int)"/>.
202 /// </summary>
243 - /// <param name="dwExitCode"></param>
203 void Quit(
204 [MarshalAs(UnmanagedType.U4)] int dwExitCode
205 );
@@ -248,10 +207,6 @@ namespace WixToolset.Mba.Core
207 /// <summary>
208 /// See <see cref="IEngine.LaunchApprovedExe(IntPtr, string, string, int)"/>.
209 /// </summary>
251 - /// <param name="hwndParent"></param>
252 - /// <param name="wzApprovedExeForElevationId"></param>
253 - /// <param name="wzArguments"></param>
254 - /// <param name="dwWaitForInputIdleTimeout"></param>
210 void LaunchApprovedExe(
211 IntPtr hwndParent,
212 [MarshalAs(UnmanagedType.LPWStr)] string wzApprovedExeForElevationId,
@@ -262,7 +217,6 @@ namespace WixToolset.Mba.Core
217 /// <summary>
218 /// Sets the URL to the update feed.
219 /// </summary>
265 - /// <param name="url">URL of the update feed.</param>
220 void SetUpdateSource(
221 [MarshalAs(UnmanagedType.LPWStr)] string url
222 );
@@ -270,9 +224,6 @@ namespace WixToolset.Mba.Core
224 /// <summary>
225 /// See <see cref="IEngine.CompareVersions(string, string)"/>.
226 /// </summary>
273 - /// <param name="wzVersion1"></param>
274 - /// <param name="wzVersion2"></param>
275 - /// <param name="pnResult"></param>
227 void CompareVersions(
228 [MarshalAs(UnmanagedType.LPWStr)] string wzVersion1,
229 [MarshalAs(UnmanagedType.LPWStr)] string wzVersion2,
@@ -297,93 +248,94 @@ namespace WixToolset.Mba.Core
248 public enum ActionState
249 {
250 /// <summary>
300 - ///
251 + /// No action.
252 /// </summary>
253 None,
254
255 /// <summary>
305 - ///
256 + /// Uninstall action.
257 /// </summary>
258 Uninstall,
259
260 /// <summary>
310 - ///
261 + /// Install action.
262 /// </summary>
263 Install,
264
265 /// <summary>
315 - ///
266 + /// Modify action.
267 /// </summary>
268 Modify,
269
270 /// <summary>
320 - ///
271 + /// Repair action.
272 /// </summary>
273 Repair,
274
275 /// <summary>
325 - ///
276 + /// Minor upgrade action.
277 /// </summary>
278 MinorUpgrade,
279 }
280
281 /// <summary>
331 - /// The action for the BA to perform.
282 + /// The action for the bundle to perform.
283 /// </summary>
284 public enum LaunchAction
285 {
286 /// <summary>
336 - ///
287 + /// Invalid action.
288 /// </summary>
289 Unknown,
290
291 /// <summary>
341 - ///
292 + /// Provide help information.
293 /// </summary>
294 Help,
295
296 /// <summary>
346 - ///
297 + /// Layout the bundle on disk, normally to prepare for offline installation.
298 /// </summary>
299 Layout,
300
301 /// <summary>
351 - ///
302 + /// Same as Uninstall, except it will always remove itself from the package cache and Add/Remove Programs.
303 + /// This should only be used to remove corrupt bundles since it might not properly clean up its packages.
304 /// </summary>
305 UnsafeUninstall,
306
307 /// <summary>
356 - ///
308 + /// Uninstall the bundle.
309 /// </summary>
310 Uninstall,
311
312 /// <summary>
361 - ///
313 + /// Cache the bundle and its packages.
314 /// </summary>
315 Cache,
316
317 /// <summary>
366 - ///
318 + /// Install the bundle.
319 /// </summary>
320 Install,
321
322 /// <summary>
371 - ///
323 + /// Modify the bundle.
324 /// </summary>
325 Modify,
326
327 /// <summary>
376 - ///
328 + /// Repair the bundle
329 /// </summary>
330 Repair,
331
332 /// <summary>
381 - ///
333 + /// Launch the update registered with <see cref="IEngine.SetUpdate(string, string, long, UpdateHashType, string)"/> and then exit without waiting for it to complete.
334 /// </summary>
335 UpdateReplace,
336
337 /// <summary>
386 - ///
338 + /// Launch the update registered with <see cref="IEngine.SetUpdate(string, string, long, UpdateHashType, string)"/> as an embedded bundle.
339 /// </summary>
340 UpdateReplaceEmbedded,
341 }
@@ -441,32 +393,32 @@ namespace WixToolset.Mba.Core
393 public enum PackageState
394 {
395 /// <summary>
444 - ///
396 + /// Invalid state.
397 /// </summary>
398 Unknown,
399
400 /// <summary>
449 - ///
401 + /// The package is not on the machine (except possibly MspPackage) and should not be installed.
402 /// </summary>
403 Obsolete,
404
405 /// <summary>
454 - ///
406 + /// The package is not installed.
407 /// </summary>
408 Absent,
409
410 /// <summary>
459 - ///
411 + /// The package is not installed but is in the package cache.
412 /// </summary>
413 Cached,
414
415 /// <summary>
464 - ///
416 + /// The package is installed.
417 /// </summary>
418 Present,
419
420 /// <summary>
469 - ///
421 + /// The package is on the machine but not active, so only uninstall operations are allowed.
422 /// </summary>
423 Superseded,
424 }
@@ -477,68 +429,70 @@ namespace WixToolset.Mba.Core
429 public enum RequestState
430 {
431 /// <summary>
480 - ///
432 + /// No change requested.
433 /// </summary>
434 None,
435
436 /// <summary>
485 - /// /
437 + /// As long as there are no dependents, the package will be uninstalled.
438 + /// There are some packages that can't be uninstalled, such as an ExePackage without an UninstallCommand.
439 /// </summary>
440 ForceAbsent,
441
442 /// <summary>
490 - ///
443 + /// Request the package to not be installed on the machine.
444 /// </summary>
445 Absent,
446
447 /// <summary>
495 - ///
448 + /// Request the package to be cached and not be installed on the machine.
449 /// </summary>
450 Cache,
451
452 /// <summary>
500 - ///
453 + /// Request the package to be installed on the machine.
454 /// </summary>
455 Present,
456
457 /// <summary>
505 - ///
458 + /// Force the bundle to install the package.
459 /// </summary>
460 ForcePresent,
461
462 /// <summary>
510 - ///
463 + /// Request the package to be repaired.
464 /// </summary>
465 Repair,
466 }
467
468 /// <summary>
469 /// Indicates the state of a feature.
470 + /// See https://learn.microsoft.com/en-us/windows/win32/api/msi/nf-msi-msiqueryfeaturestatew.
471 /// </summary>
472 public enum FeatureState
473 {
474 /// <summary>
521 - ///
475 + /// Invalid state.
476 /// </summary>
477 Unknown,
478
479 /// <summary>
526 - ///
480 + /// INSTALLSTATE_ABSENT
481 /// </summary>
482 Absent,
483
484 /// <summary>
531 - ///
485 + /// INSTALLSTATE_ADVERTISED
486 /// </summary>
487 Advertised,
488
489 /// <summary>
536 - ///
490 + /// INSTALLSTATE_LOCAL
491 /// </summary>
492 Local,
493
494 /// <summary>
541 - ///
495 + /// INSTALLSTATE_SOURCE
496 /// </summary>
497 Source,
498 }
src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs
+6 -6
@@ -10,27 +10,27 @@ namespace WixToolset.Mba.Core
10 public interface IBundleInfo
11 {
12 /// <summary>
13 - ///
13 + /// The name of the variable that contains the path to the bundle's log.
14 /// </summary>
15 string LogVariable { get; }
16
17 /// <summary>
18 - ///
18 + /// Bundle/@Name
19 /// </summary>
20 string Name { get; }
21
22 /// <summary>
23 - ///
23 + /// Variables that were marked with bal:Overridable="yes".
24 /// </summary>
25 IOverridableVariables OverridableVariables { get; }
26
27 /// <summary>
28 - ///
28 + /// The packages in the bundle's chain.
29 /// </summary>
30 IDictionary<string, IPackageInfo> Packages { get; }
31
32 /// <summary>
33 - ///
33 + /// Whether the bundle is per-machine or per-user.
34 /// </summary>
35 bool PerMachine { get; }
36
@@ -48,4 +48,4 @@ namespace WixToolset.Mba.Core
48 /// <returns>The created <see cref="IPackageInfo"/>.</returns>
49 IPackageInfo AddUpdateBundleAsPackage(SetUpdateCompleteEventArgs e);
50 }
51 -}
\ No newline at end of file
51 +}
src/api/burn/WixToolset.Mba.Core/IPackageInfo.cs
+17 -17
@@ -8,7 +8,7 @@ namespace WixToolset.Mba.Core
8 public interface IPackageInfo
9 {
10 /// <summary>
11 - ///
11 + /// The authored cache strategy for this package.
12 /// </summary>
13 BOOTSTRAPPER_CACHE_TYPE CacheType { get; }
14
@@ -18,82 +18,82 @@ namespace WixToolset.Mba.Core
18 object CustomData { get; set; }
19
20 /// <summary>
21 - ///
21 + /// The package's description.
22 /// </summary>
23 string Description { get; }
24
25 /// <summary>
26 - ///
26 + /// The authored bal:DisplayInternalUICondition.
27 /// </summary>
28 string DisplayInternalUICondition { get; }
29
30 /// <summary>
31 - ///
31 + /// The package's display name.
32 /// </summary>
33 string DisplayName { get; }
34
35 /// <summary>
36 - ///
36 + /// The package's Id.
37 /// </summary>
38 string Id { get; }
39
40 /// <summary>
41 - ///
41 + /// The authored InstallCondition.
42 /// </summary>
43 string InstallCondition { get; }
44
45 /// <summary>
46 - ///
46 + /// The authored RepairCondition.
47 /// </summary>
48 string RepairCondition { get; }
49
50 /// <summary>
51 - ///
51 + /// Whether the bundle should ever recommend the package to be uninstalled.
52 /// </summary>
53 bool Permanent { get; }
54
55 /// <summary>
56 - ///
56 + /// Whether the package should be installed by the prereq BA for managed bootstrapper applications.
57 /// </summary>
58 bool PrereqPackage { get; }
59
60 /// <summary>
61 - ///
61 + /// The file name of the license file to be shown by the prereq BA.
62 /// </summary>
63 string PrereqLicenseFile { get; }
64
65 /// <summary>
66 - ///
66 + /// The URL of the license to be shown by the prereq BA.
67 /// </summary>
68 string PrereqLicenseUrl { get; }
69
70 /// <summary>
71 - /// See <see cref="PrimaryPackageType"/>
71 + /// See <see cref="WixToolset.Mba.Core.PrimaryPackageType"/>
72 /// </summary>
73 PrimaryPackageType PrimaryPackageType { get; }
74
75 /// <summary>
76 - ///
76 + /// The package's ProductCode.
77 /// </summary>
78 string ProductCode { get; }
79
80 /// <summary>
81 - ///
81 + /// The type of the package.
82 /// </summary>
83 PackageType Type { get; }
84
85 /// <summary>
86 - ///
86 + /// The package's UpgradeCode.
87 /// </summary>
88 string UpgradeCode { get; }
89
90 /// <summary>
91 - ///
91 + /// The package's version.
92 /// </summary>
93 string Version { get; }
94
95 /// <summary>
96 - ///
96 + /// Whether the package's failure can be ignored while executing the chain.
97 /// </summary>
98 bool Vital { get; }
99 }
src/api/burn/WixToolset.Mba.Core/PackageInfo.cs
+38 -31
@@ -8,57 +8,57 @@ namespace WixToolset.Mba.Core
8 using System.Xml.XPath;
9
10 /// <summary>
11 - ///
11 + /// The type of package.
12 /// </summary>
13 public enum PackageType
14 {
15 /// <summary>
16 - ///
16 + /// Invalid type.
17 /// </summary>
18 Unknown,
19
20 /// <summary>
21 - ///
21 + /// ExePackage
22 /// </summary>
23 Exe,
24
25 /// <summary>
26 - ///
26 + /// MsiPackage
27 /// </summary>
28 Msi,
29
30 /// <summary>
31 - ///
31 + /// MspPackage
32 /// </summary>
33 Msp,
34
35 /// <summary>
36 - ///
36 + /// MsuPackage
37 /// </summary>
38 Msu,
39
40 /// <summary>
41 - ///
41 + /// Related bundle of type Upgrade
42 /// </summary>
43 UpgradeBundle,
44
45 /// <summary>
46 - ///
46 + /// Related bundle of type Addon
47 /// </summary>
48 AddonBundle,
49
50 /// <summary>
51 - ///
51 + /// Related bundle of type Patch
52 /// </summary>
53 PatchBundle,
54
55 /// <summary>
56 - ///
56 + /// Related bundle of type Update
57 /// </summary>
58 UpdateBundle,
59
60 /// <summary>
61 - ///
61 + /// BundlePackage
62 /// </summary>
63 ChainBundle,
64 }
@@ -156,10 +156,10 @@ namespace WixToolset.Mba.Core
156 internal PackageInfo() { }
157
158 /// <summary>
159 - ///
159 + /// Parse packages from BootstrapperApplicationData.xml.
160 /// </summary>
161 - /// <param name="root"></param>
162 - /// <returns></returns>
161 + /// <param name="root">The root node.</param>
162 + /// <returns>A dictionary of the packages by Id.</returns>
163 public static IDictionary<string, IPackageInfo> ParsePackagesFromXml(XPathNavigator root)
164 {
165 var packagesById = new Dictionary<string, IPackageInfo>();
@@ -213,6 +213,13 @@ namespace WixToolset.Mba.Core
213
214 package.RepairCondition = BootstrapperApplicationData.GetAttribute(node, "RepairCondition");
215
216 + BOOTSTRAPPER_CACHE_TYPE? cacheType = GetCacheTypeAttribute(node, "Cache");
217 + if (!cacheType.HasValue)
218 + {
219 + throw new Exception("Failed to get cache type for package.");
220 + }
221 + package.CacheType = cacheType.Value;
222 +
223 packagesById.Add(package.Id, package);
224 }
225
@@ -221,11 +228,11 @@ namespace WixToolset.Mba.Core
228 }
229
230 /// <summary>
224 - ///
231 + /// Parse the cache type attribute.
232 /// </summary>
226 - /// <param name="node"></param>
227 - /// <param name="attributeName"></param>
228 - /// <returns></returns>
233 + /// <param name="node">Package node</param>
234 + /// <param name="attributeName">Attribute name</param>
235 + /// <returns>The cache type</returns>
236 public static BOOTSTRAPPER_CACHE_TYPE? GetCacheTypeAttribute(XPathNavigator node, string attributeName)
237 {
238 string attributeValue = BootstrapperApplicationData.GetAttribute(node, attributeName);
@@ -250,11 +257,11 @@ namespace WixToolset.Mba.Core
257 }
258
259 /// <summary>
253 - ///
260 + /// Parse the package type attribute
261 /// </summary>
255 - /// <param name="node"></param>
256 - /// <param name="attributeName"></param>
257 - /// <returns></returns>
262 + /// <param name="node">Package node</param>
263 + /// <param name="attributeName">Attribute name</param>
264 + /// <returns>The package type</returns>
265 public static PackageType? GetPackageTypeAttribute(XPathNavigator node, string attributeName)
266 {
267 string attributeValue = BootstrapperApplicationData.GetAttribute(node, attributeName);
@@ -291,13 +298,13 @@ namespace WixToolset.Mba.Core
298 }
299
300 /// <summary>
294 - ///
301 + /// Create <see cref="IPackageInfo"/> from a related bundle.
302 /// </summary>
296 - /// <param name="id"></param>
297 - /// <param name="relationType"></param>
298 - /// <param name="perMachine"></param>
299 - /// <param name="version"></param>
300 - /// <returns></returns>
303 + /// <param name="id">Package id</param>
304 + /// <param name="relationType">Relation type</param>
305 + /// <param name="perMachine">Whether the related bundle is per-machine</param>
306 + /// <param name="version">The related bundle's version</param>
307 + /// <returns>The package info</returns>
308 public static IPackageInfo GetRelatedBundleAsPackage(string id, RelationType relationType, bool perMachine, string version)
309 {
310 PackageInfo package = new PackageInfo();
@@ -323,10 +330,10 @@ namespace WixToolset.Mba.Core
330 }
331
332 /// <summary>
326 - ///
333 + /// Create <see cref="IPackageInfo"/> from an update bundle.
334 /// </summary>
328 - /// <param name="id"></param>
329 - /// <returns></returns>
335 + /// <param name="id">Package id</param>
336 + /// <returns>The package info</returns>
337 public static IPackageInfo GetUpdateBundleAsPackage(string id)
338 {
339 PackageInfo package = new PackageInfo();
src/api/burn/WixToolset.Mba.Core/VerUtil.cs
+9 -9
@@ -110,10 +110,10 @@ namespace WixToolset.Mba.Core
110 }
111
112 /// <summary>
113 - ///
113 + /// Clone the version.
114 /// </summary>
115 - /// <param name="version"></param>
116 - /// <returns></returns>
115 + /// <param name="version">Source version</param>
116 + /// <returns>Cloned version</returns>
117 public static VerUtilVersion CopyVersion(VerUtilVersion version)
118 {
119 var handle = VerCopyVersion(version.GetHandle());
@@ -121,11 +121,11 @@ namespace WixToolset.Mba.Core
121 }
122
123 /// <summary>
124 - ///
124 + /// Parse a version.
125 /// </summary>
126 - /// <param name="version"></param>
126 + /// <param name="version">Source version</param>
127 /// <param name="strict">Whether to throw exception on invalid version.</param>
128 - /// <returns></returns>
128 + /// <returns>Parsed version</returns>
129 public static VerUtilVersion ParseVersion(string version, bool strict)
130 {
131 var handle = VerParseVersion(version, 0, strict);
@@ -133,10 +133,10 @@ namespace WixToolset.Mba.Core
133 }
134
135 /// <summary>
136 - ///
136 + /// Parse version from qword.
137 /// </summary>
138 - /// <param name="version"></param>
139 - /// <returns></returns>
138 + /// <param name="version">Source version</param>
139 + /// <returns>Parsed version</returns>
140 public static VerUtilVersion VersionFromQword(long version)
141 {
142 var handle = VerVersionFromQword(version);
src/api/burn/test/WixToolsetTest.Mba.Core/VerUtilFixture.cs
+13 -1
@@ -45,7 +45,7 @@ namespace WixToolsetTest.Mba.Core
45 public void CanCreateFromQword()
46 {
47 var version = new Version(100, 200, 300, 400);
48 - var qwVersion = Engine.VersionToLong(version);
48 + var qwVersion = VersionToLong(version);
49
50 using var parsedVersion = VerUtil.VersionFromQword(qwVersion);
51 Assert.Equal("100.200.300.400", parsedVersion.Version);
@@ -99,5 +99,17 @@ namespace WixToolsetTest.Mba.Core
99 Assert.True(parsedVersion.ReleaseLabels[4].IsNumeric);
100 Assert.Equal(5u, parsedVersion.ReleaseLabels[4].Value);
101 }
102 +
103 + private static long VersionToLong(Version version)
104 + {
105 + // In Windows, each version component has a max value of 65535,
106 + // so we truncate the version before shifting it, which will overflow if invalid.
107 + long major = (long)(ushort)version.Major << 48;
108 + long minor = (long)(ushort)version.Minor << 32;
109 + long build = (long)(ushort)version.Build << 16;
110 + long revision = (long)(ushort)version.Revision;
111 +
112 + return major | minor | build | revision;
113 + }
114 }
115 }