aboutsummaryrefslogtreecommitdiff
path: root/src/WixToolset.Mba.Core/IBootstrapperCommand.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/WixToolset.Mba.Core/IBootstrapperCommand.cs')
-rw-r--r--src/WixToolset.Mba.Core/IBootstrapperCommand.cs63
1 files changed, 63 insertions, 0 deletions
diff --git a/src/WixToolset.Mba.Core/IBootstrapperCommand.cs b/src/WixToolset.Mba.Core/IBootstrapperCommand.cs
new file mode 100644
index 00000000..332b4c3b
--- /dev/null
+++ b/src/WixToolset.Mba.Core/IBootstrapperCommand.cs
@@ -0,0 +1,63 @@
1// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
2
3namespace WixToolset.BootstrapperCore
4{
5 using System;
6
7 /// <summary>
8 /// Command information passed from the engine for the BA to perform.
9 /// </summary>
10 public interface IBootstrapperCommand
11 {
12 /// <summary>
13 /// Gets the action for the BA to perform.
14 /// </summary>
15 LaunchAction Action { get; }
16
17 /// <summary>
18 /// Gets the display level for the BA.
19 /// </summary>
20 Display Display { get; }
21
22 /// <summary>
23 /// Gets the action to perform if a reboot is required.
24 /// </summary>
25 Restart Restart { get; }
26
27 /// <summary>
28 /// Gets the command line arguments as a string array.
29 /// </summary>
30 /// <returns>
31 /// Array of command line arguments not handled by the engine.
32 /// </returns>
33 /// <exception type="Win32Exception">The command line could not be parsed into an array.</exception>
34 string[] CommandLineArgs { get; }
35
36 int CmdShow { get; }
37
38 /// <summary>
39 /// Gets the method of how the engine was resumed from a previous installation step.
40 /// </summary>
41 ResumeType Resume { get; }
42
43 /// <summary>
44 /// Gets the handle to the splash screen window. If no splash screen was displayed this value will be IntPtr.Zero.
45 /// </summary>
46 IntPtr SplashScreen { get; }
47
48 /// <summary>
49 /// If this was run from a related bundle, specifies the relation type.
50 /// </summary>
51 RelationType Relation { get; }
52
53 /// <summary>
54 /// If this was run from a backward compatible bundle.
55 /// </summary>
56 bool Passthrough { get; }
57
58 /// <summary>
59 /// Gets layout directory.
60 /// </summary>
61 string LayoutDirectory { get; }
62 }
63}