diff options
Diffstat (limited to 'src/WixToolset.Mba.Core/IEngine.cs')
-rw-r--r-- | src/WixToolset.Mba.Core/IEngine.cs | 19 |
1 files changed, 6 insertions, 13 deletions
diff --git a/src/WixToolset.Mba.Core/IEngine.cs b/src/WixToolset.Mba.Core/IEngine.cs index 84d93bb0..b486e51d 100644 --- a/src/WixToolset.Mba.Core/IEngine.cs +++ b/src/WixToolset.Mba.Core/IEngine.cs | |||
@@ -96,7 +96,7 @@ namespace WixToolset.Mba.Core | |||
96 | /// Gets <see cref="Version"/> variables for the engine. | 96 | /// Gets <see cref="Version"/> variables for the engine. |
97 | /// </summary> | 97 | /// </summary> |
98 | /// <param name="name">The name of the variable.</param> | 98 | /// <param name="name">The name of the variable.</param> |
99 | Version GetVariableVersion(string name); | 99 | string GetVariableVersion(string name); |
100 | 100 | ||
101 | /// <summary> | 101 | /// <summary> |
102 | /// Launches a preapproved executable elevated. As long as the engine already elevated, there will be no UAC prompt. | 102 | /// Launches a preapproved executable elevated. As long as the engine already elevated, there will be no UAC prompt. |
@@ -161,7 +161,7 @@ namespace WixToolset.Mba.Core | |||
161 | /// </summary> | 161 | /// </summary> |
162 | /// <param name="name">The name of the variable.</param> | 162 | /// <param name="name">The name of the variable.</param> |
163 | /// <param name="value">The value to set.</param> | 163 | /// <param name="value">The value to set.</param> |
164 | void SetVariable(string name, long value); | 164 | void SetVariableNumeric(string name, long value); |
165 | 165 | ||
166 | /// <summary> | 166 | /// <summary> |
167 | /// Sets string variables for the engine using SecureStrings. | 167 | /// Sets string variables for the engine using SecureStrings. |
@@ -169,7 +169,7 @@ namespace WixToolset.Mba.Core | |||
169 | /// <param name="name">The name of the variable.</param> | 169 | /// <param name="name">The name of the variable.</param> |
170 | /// <param name="value">The value to set.</param> | 170 | /// <param name="value">The value to set.</param> |
171 | /// <param name="formatted">False if the value is a literal string.</param> | 171 | /// <param name="formatted">False if the value is a literal string.</param> |
172 | void SetVariable(string name, SecureString value, bool formatted); | 172 | void SetVariableString(string name, SecureString value, bool formatted); |
173 | 173 | ||
174 | /// <summary> | 174 | /// <summary> |
175 | /// Sets string variables for the engine. | 175 | /// Sets string variables for the engine. |
@@ -177,21 +177,14 @@ namespace WixToolset.Mba.Core | |||
177 | /// <param name="name">The name of the variable.</param> | 177 | /// <param name="name">The name of the variable.</param> |
178 | /// <param name="value">The value to set.</param> | 178 | /// <param name="value">The value to set.</param> |
179 | /// <param name="formatted">False if the value is a literal string.</param> | 179 | /// <param name="formatted">False if the value is a literal string.</param> |
180 | void SetVariable(string name, string value, bool formatted); | 180 | void SetVariableString(string name, string value, bool formatted); |
181 | 181 | ||
182 | /// <summary> | 182 | /// <summary> |
183 | /// Sets <see cref="Version"/> variables for the engine. | 183 | /// Sets version variables for the engine. |
184 | /// | ||
185 | /// The <see cref="Version"/> class can keep track of when the build and revision fields are undefined, but the engine can't. | ||
186 | /// Therefore, the build and revision fields must be defined when setting a <see cref="Version"/> variable. | ||
187 | /// Use the NormalizeVersion method to make sure the engine can accept the Version. | ||
188 | /// | ||
189 | /// To keep track of versions without build or revision fields, use StringVariables instead. | ||
190 | /// </summary> | 184 | /// </summary> |
191 | /// <param name="name">The name of the variable.</param> | 185 | /// <param name="name">The name of the variable.</param> |
192 | /// <param name="value">The value to set.</param> | 186 | /// <param name="value">The value to set.</param> |
193 | /// <exception cref="OverflowException">The given <see cref="Version"/> was invalid.</exception> | 187 | void SetVariableVersion(string name, string value); |
194 | void SetVariable(string name, Version value); | ||
195 | 188 | ||
196 | /// <summary> | 189 | /// <summary> |
197 | /// Sends error message when embedded. | 190 | /// Sends error message when embedded. |