diff --git a/Sources/EasyExtensions.Windows/ShellLink.cs b/Sources/EasyExtensions.Windows/ShellLink.cs index 6840a61..49f7d53 100644 --- a/Sources/EasyExtensions.Windows/ShellLink.cs +++ b/Sources/EasyExtensions.Windows/ShellLink.cs @@ -8,7 +8,7 @@ namespace EasyExtensions.Windows /// /// Summary description for ShellLink. /// - public class ShellLink : IDisposable + internal class ShellLink : IDisposable { #region ComInterop for IShellLink @@ -113,53 +113,82 @@ void GetPath([Out(), MarshalAs(UnmanagedType.LPStr)] StringBuilder pszFile, /// The size, in characters, of the buffer pointed to by the pszDir parameter void GetWorkingDirectory([Out(), MarshalAs(UnmanagedType.LPStr)] StringBuilder pszDir, int cchMaxPath); - //[helpstring("Sets the name of the shell link working directory")] - void SetWorkingDirectory( - [MarshalAs(UnmanagedType.LPStr)] string pszDir); + /// + /// Sets the name of the shell link working directory. + /// + /// The new working directory. + void SetWorkingDirectory([MarshalAs(UnmanagedType.LPStr)] string pszDir); - //[helpstring("Retrieves the shell link command-line arguments")] - void GetArguments( - [Out(), MarshalAs(UnmanagedType.LPStr)] StringBuilder pszArgs, - int cchMaxPath); + /// + /// Retrieves the shell link command-line arguments. + /// + /// The buffer that receives the command-line arguments. + /// The size, in characters, of the buffer pointed to by the pszArgs parameter. + void GetArguments([Out(), MarshalAs(UnmanagedType.LPStr)] StringBuilder pszArgs, int cchMaxPath); - //[helpstring("Sets the shell link command-line arguments")] - void SetArguments( - [MarshalAs(UnmanagedType.LPStr)] string pszArgs); + /// + /// Sets the shell link command-line arguments. + /// + /// The new command-line arguments. + void SetArguments([MarshalAs(UnmanagedType.LPStr)] string pszArgs); - //[propget, helpstring("Retrieves or sets the shell link hot key")] + /// + /// Retrieves the shell link hot key. + /// + /// The address of a variable that receives the hot key. void GetHotkey(out short pwHotkey); - //[propput, helpstring("Retrieves or sets the shell link hot key")] + /// + /// Sets the shell link hot key. + /// + /// The new hot key. void SetHotkey(short pwHotkey); - //[propget, helpstring("Retrieves or sets the shell link show command")] + /// + /// Retrieves the shell link show command. + /// + /// The address of a variable that receives the show command. void GetShowCmd(out uint piShowCmd); - //[propput, helpstring("Retrieves or sets the shell link show command")] + + /// + /// Sets the shell link show command. + /// + /// The new show command. void SetShowCmd(uint piShowCmd); - //[helpstring("Retrieves the location (path and index) of the shell link icon")] - void GetIconLocation( - [Out(), MarshalAs(UnmanagedType.LPStr)] StringBuilder pszIconPath, - int cchIconPath, - out int piIcon); + /// + /// Retrieves the location (path and index) of the shell link icon. + /// + /// The buffer that receives the icon path. + /// The size, in characters, of the buffer pointed to by the pszIconPath parameter. + /// The address of a variable that receives the icon index. + void GetIconLocation([Out(), MarshalAs(UnmanagedType.LPStr)] StringBuilder pszIconPath, int cchIconPath, out int piIcon); - //[helpstring("Sets the location (path and index) of the shell link icon")] - void SetIconLocation( - [MarshalAs(UnmanagedType.LPStr)] string pszIconPath, - int iIcon); + /// + /// Sets the location (path and index) of the shell link icon. + /// + /// The new icon path. + /// The new icon index. + void SetIconLocation([MarshalAs(UnmanagedType.LPStr)] string pszIconPath, int iIcon); - //[helpstring("Sets the shell link relative path")] - void SetRelativePath( - [MarshalAs(UnmanagedType.LPStr)] string pszPathRel, - uint dwReserved); + /// + /// Sets the shell link relative path. + /// + /// The new relative path. + /// Reserved. Must be zero. + void SetRelativePath([MarshalAs(UnmanagedType.LPStr)] string pszPathRel, uint dwReserved); - //[helpstring("Resolves a shell link. The system searches for the shell link object and updates the shell link path and its list of identifiers (if necessary)")] - void Resolve( - IntPtr hWnd, - uint fFlags); + /// + /// Resolves a shell link. The system searches for the shell link object and updates the shell link path and its list of identifiers (if necessary). + /// + /// A handle to the window that the system uses as a parent for any dialog boxes that it displays. + /// Flags that control the resolution process. + void Resolve(IntPtr hWnd, uint fFlags); - //[helpstring("Sets the shell link path and filename")] - void SetPath( - [MarshalAs(UnmanagedType.LPStr)] string pszFile); + /// + /// Sets the shell link path and filename. + /// + /// The new path and filename. + void SetPath([MarshalAs(UnmanagedType.LPStr)] string pszFile); }