Private the ctors for ShellLinkFile so only our factory methods can be used.

Author: mjr4077au

src/PSADT/PSADT/ShortcutManagement/ShellLinkFile.cs

@@ -26,76 +26,83 @@ namespace PSADT.ShortcutManagement
     internal sealed class ShellLinkFile : IDisposable
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="ShellLinkFile"/> class.
         /// Creates a new, empty shell link.
         /// </summary>
-        public ShellLinkFile()
-        {
-            _shellLink = (IShellLinkW)new ShellLink();
-        }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="ShellLinkFile"/> class and loads an existing shortcut file.
-        /// </summary>
-        /// <param name="filePath">The path to the shortcut file to load.</param>
-        /// <exception cref="ArgumentNullException">Thrown when <paramref name="filePath"/> is null.</exception>
-        /// <exception cref="ArgumentException">Thrown when <paramref name="filePath"/> is empty or whitespace.</exception>
-        /// <exception cref="FileNotFoundException">Thrown when the specified file does not exist.</exception>
-        public ShellLinkFile(string filePath) : this()
+        /// <returns>A new <see cref="ShellLinkFile"/> instance.</returns>
+        public static ShellLinkFile New()
         {
-            Load(filePath);
+            return new();
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ShellLinkFile"/> class with the specified target path.
+        /// Creates a new shell link with the specified target path.
         /// </summary>
         /// <param name="targetPath">The target path for the shortcut.</param>
-        /// <param name="createNew">Must be <see langword="true"/> to use this constructor. This parameter disambiguates from the file loading constructor.</param>
-        /// <exception cref="ArgumentException">Thrown when <paramref name="createNew"/> is false.</exception>
-        public ShellLinkFile(string targetPath, bool createNew) : this()
+        /// <returns>A new <see cref="ShellLinkFile"/> instance with the target path set.</returns>
+        public static ShellLinkFile New(string targetPath)
         {
-            if (!createNew)
-            {
-                throw new ArgumentException("Use the single-parameter constructor to load an existing file.", nameof(createNew));
-            }
-            TargetPath = targetPath;
+            return new() { TargetPath = targetPath };
         }
 
         /// <summary>
-        /// Finalizes an instance of the <see cref="ShellLinkFile"/> class.
-        /// </summary>
-        ~ShellLinkFile()
-        {
-            Dispose(false);
-        }
-
-        /// <summary>
-        /// Loads a shortcut file.
+        /// Loads an existing shortcut file in read-only mode.
         /// </summary>
         /// <param name="filePath">The path to the shortcut file to load.</param>
+        /// <returns>A new <see cref="ShellLinkFile"/> instance loaded from the specified file.</returns>
         /// <exception cref="ArgumentNullException">Thrown when <paramref name="filePath"/> is null.</exception>
         /// <exception cref="ArgumentException">Thrown when <paramref name="filePath"/> is empty or whitespace.</exception>
         /// <exception cref="FileNotFoundException">Thrown when the specified file does not exist.</exception>
         /// <exception cref="COMException">Thrown when the COM operation fails.</exception>
-        public void Load(string filePath)
+        /// <remarks>Use <see cref="Load(string, STGM)"/> with <see cref="STGM.STGM_READWRITE"/> if you need to modify the shortcut.</remarks>
+        public static ShellLinkFile Load(string filePath)
         {
-            Load(filePath, STGM.STGM_READWRITE);
+            return Load(filePath, STGM.STGM_READ);
         }
 
         /// <summary>
-        /// Loads a shortcut file with the specified storage mode.
+        /// Loads an existing shortcut file with the specified storage mode.
         /// </summary>
         /// <param name="filePath">The path to the shortcut file to load.</param>
         /// <param name="storageMode">The storage mode flags.</param>
+        /// <returns>A new <see cref="ShellLinkFile"/> instance loaded from the specified file.</returns>
         /// <exception cref="ArgumentNullException">Thrown when <paramref name="filePath"/> is null.</exception>
         /// <exception cref="ArgumentException">Thrown when <paramref name="filePath"/> is empty or whitespace.</exception>
         /// <exception cref="FileNotFoundException">Thrown when the specified file does not exist.</exception>
         /// <exception cref="COMException">Thrown when the COM operation fails.</exception>
-        public void Load(string filePath, STGM storageMode)
+        public static ShellLinkFile Load(string filePath, STGM storageMode)
         {
-            ObjectDisposedException.ThrowIf(_disposed, this);
             ArgumentException.ThrowIfNullOrWhiteSpace(filePath);
-            ((IPersistFile)_shellLink).Load(filePath.ThrowIfFileDoesNotExist(), storageMode);
+            if (!File.Exists(filePath))
+            {
+                throw new FileNotFoundException("The specified shortcut file does not exist.", filePath);
+            }
+            ShellLinkFile shellLink = new();
+            try
+            {
+                ((IPersistFile)shellLink._shellLink).Load(filePath, storageMode);
+                return shellLink;
+            }
+            catch
+            {
+                shellLink.Dispose();
+                throw;
+            }
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ShellLinkFile"/> class.
+        /// </summary>
+        private ShellLinkFile()
+        {
+            _shellLink = (IShellLinkW)new ShellLink();
+        }
+
+        /// <summary>
+        /// Finalizes an instance of the <see cref="ShellLinkFile"/> class.
+        /// </summary>
+        ~ShellLinkFile()
+        {
+            Dispose(false);
         }
 
         /// <summary>