From 80df808461fca91b53e232b5b504a5c868029697 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Sat, 19 Dec 2020 19:15:11 -0600 Subject: Enable XML doc. --- src/WixToolset.Mba.Core/Engine.cs | 43 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) (limited to 'src/WixToolset.Mba.Core/Engine.cs') diff --git a/src/WixToolset.Mba.Core/Engine.cs b/src/WixToolset.Mba.Core/Engine.cs index c6570f9d..d5c43a53 100644 --- a/src/WixToolset.Mba.Core/Engine.cs +++ b/src/WixToolset.Mba.Core/Engine.cs @@ -9,7 +9,7 @@ namespace WixToolset.Mba.Core using System.Text; /// - /// Container class for the interface. + /// Default implementation of . /// public sealed class Engine : IEngine { @@ -28,6 +28,7 @@ namespace WixToolset.Mba.Core this.engine = engine; } + /// public int PackageCount { get @@ -39,22 +40,26 @@ namespace WixToolset.Mba.Core } } + /// public void Apply(IntPtr hwndParent) { this.engine.Apply(hwndParent); } + /// public void CloseSplashScreen() { this.engine.CloseSplashScreen(); } + /// public int CompareVersions(string version1, string version2) { this.engine.CompareVersions(version1, version2, out var result); return result; } + /// public bool ContainsVariable(string name) { int capacity = 0; @@ -62,16 +67,19 @@ namespace WixToolset.Mba.Core return NativeMethods.E_NOTFOUND != ret; } + /// public void Detect() { this.Detect(IntPtr.Zero); } + /// public void Detect(IntPtr hwndParent) { this.engine.Detect(hwndParent); } + /// public bool Elevate(IntPtr hwndParent) { int ret = this.engine.Elevate(hwndParent); @@ -90,6 +98,7 @@ namespace WixToolset.Mba.Core } } + /// public string EscapeString(string input) { int capacity = InitialBufferSize; @@ -111,6 +120,7 @@ namespace WixToolset.Mba.Core return sb.ToString(); } + /// public bool EvaluateCondition(string condition) { bool value; @@ -119,6 +129,7 @@ namespace WixToolset.Mba.Core return value; } + /// public string FormatString(string format) { int capacity = InitialBufferSize; @@ -140,6 +151,7 @@ namespace WixToolset.Mba.Core return sb.ToString(); } + /// public long GetVariableNumeric(string name) { int ret = this.engine.GetVariableNumeric(name, out long value); @@ -151,6 +163,7 @@ namespace WixToolset.Mba.Core return value; } + /// public SecureString GetVariableSecureString(string name) { var pUniString = this.getStringVariable(name, out var length); @@ -167,6 +180,7 @@ namespace WixToolset.Mba.Core } } + /// public string GetVariableString(string name) { int length; @@ -184,6 +198,7 @@ namespace WixToolset.Mba.Core } } + /// public string GetVariableVersion(string name) { int length; @@ -201,46 +216,55 @@ namespace WixToolset.Mba.Core } } + /// public void LaunchApprovedExe(IntPtr hwndParent, string approvedExeForElevationId, string arguments) { this.LaunchApprovedExe(hwndParent, approvedExeForElevationId, arguments, 0); } + /// public void LaunchApprovedExe(IntPtr hwndParent, string approvedExeForElevationId, string arguments, int waitForInputIdleTimeout) { this.engine.LaunchApprovedExe(hwndParent, approvedExeForElevationId, arguments, waitForInputIdleTimeout); } + /// public void Log(LogLevel level, string message) { this.engine.Log(level, message); } + /// public void Plan(LaunchAction action) { this.engine.Plan(action); } + /// public void SetUpdate(string localSource, string downloadSource, long size, UpdateHashType hashType, byte[] hash) { this.engine.SetUpdate(localSource, downloadSource, size, hashType, hash, null == hash ? 0 : hash.Length); } + /// public void SetLocalSource(string packageOrContainerId, string payloadId, string path) { this.engine.SetLocalSource(packageOrContainerId, payloadId, path); } + /// public void SetDownloadSource(string packageOrContainerId, string payloadId, string url, string user, string password) { this.engine.SetDownloadSource(packageOrContainerId, payloadId, url, user, password); } + /// public void SetVariableNumeric(string name, long value) { this.engine.SetVariableNumeric(name, value); } + /// public void SetVariableString(string name, SecureString value, bool formatted) { IntPtr pValue = Marshal.SecureStringToCoTaskMemUnicode(value); @@ -254,6 +278,7 @@ namespace WixToolset.Mba.Core } } + /// public void SetVariableString(string name, string value, bool formatted) { IntPtr pValue = Marshal.StringToCoTaskMemUni(value); @@ -267,6 +292,7 @@ namespace WixToolset.Mba.Core } } + /// public void SetVariableVersion(string name, string value) { IntPtr pValue = Marshal.StringToCoTaskMemUni(value); @@ -280,6 +306,7 @@ namespace WixToolset.Mba.Core } } + /// public int SendEmbeddedError(int errorCode, string message, int uiHint) { int result = 0; @@ -287,6 +314,7 @@ namespace WixToolset.Mba.Core return result; } + /// public int SendEmbeddedProgress(int progressPercentage, int overallPercentage) { int result = 0; @@ -294,6 +322,7 @@ namespace WixToolset.Mba.Core return result; } + /// public void Quit(int exitCode) { this.engine.Quit(exitCode); @@ -423,6 +452,11 @@ namespace WixToolset.Mba.Core return value; } + /// + /// Utility method for converting a into a . + /// + /// + /// public static long VersionToLong(Version version) { // In Windows, each version component has a max value of 65535, @@ -435,6 +469,11 @@ namespace WixToolset.Mba.Core return major | minor | build | revision; } + /// + /// Utility method for converting a into a . + /// + /// + /// public static Version LongToVersion(long version) { int major = (int)((version & ((long)0xffff << 48)) >> 48); @@ -446,7 +485,7 @@ namespace WixToolset.Mba.Core } /// - /// Verifies that VersionVariables can pass on the given Version to the engine. + /// Verifies that Version can be represented in a . /// If the Build or Revision fields are undefined, they are set to zero. /// public static Version NormalizeVersion(Version version) -- cgit v1.2.3-55-g6feb