Libs/ShellLink/ShellLink.cs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
using System;
using System.IO;
using System.Runtime.InteropServices;
using System.Runtime.InteropServices.ComTypes;
using System.Text;
using ComTypes = System.Runtime.InteropServices.ComTypes;
 
// Original code is https://emoacht.wordpress.com/2012/11/14/csharp-appusermodelid/
public class ShellLink : IDisposable
{
    #region Win32 and COM
 
    // IShellLink Interface
    [ComImport]
    [Guid("000214F9-0000-0000-C000-000000000046")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    private interface IShellLinkW
    {
        uint GetPath([Out, MarshalAs(UnmanagedType.LPWStr)] StringBuilder pszFile, int cch, ref WIN32_FIND_DATAW pfd, uint fFlags);
        uint GetIDList(out IntPtr ppidl);
        uint SetIDList(IntPtr pidl);
        uint GetDescription([Out, MarshalAs(UnmanagedType.LPWStr)] StringBuilder pszName, int cch);
        uint SetDescription([MarshalAs(UnmanagedType.LPWStr)] string pszName);
        uint GetWorkingDirectory([Out, MarshalAs(UnmanagedType.LPWStr)] StringBuilder pszDir, int cch);
        uint SetWorkingDirectory([MarshalAs(UnmanagedType.LPWStr)] string pszDir);
        uint GetArguments([Out, MarshalAs(UnmanagedType.LPWStr)] StringBuilder pszArgs, int cch);
        uint SetArguments([MarshalAs(UnmanagedType.LPWStr)] string pszArgs);
        uint GetHotKey(out ushort pwHotkey);
        uint SetHotKey(ushort wHotKey);
        uint GetShowCmd(out int piShowCmd);
        uint SetShowCmd(int iShowCmd);
        uint GetIconLocation([Out, MarshalAs(UnmanagedType.LPWStr)] StringBuilder pszIconPath, int cch, out int piIcon);
        uint SetIconLocation([MarshalAs(UnmanagedType.LPWStr)] string pszIconPath, int iIcon);
        uint SetRelativePath([MarshalAs(UnmanagedType.LPWStr)] string pszPathRel, uint dwReserved);
        uint Resolve(IntPtr hwnd, uint fFlags);
        uint SetPath([MarshalAs(UnmanagedType.LPWStr)] string pszFile);
    }
 
    // ShellLink CoClass (ShellLink object)
    [ComImport]
    [ClassInterface(ClassInterfaceType.None)]
    [Guid("00021401-0000-0000-C000-000000000046")]
    private class CShellLink { }
 
    // WIN32_FIND_DATAW Structure
    [StructLayout(LayoutKind.Sequential, Pack = 4, CharSet = CharSet.Unicode)]
    private struct WIN32_FIND_DATAW
    {
        public uint dwFileAttributes;
        public ComTypes.FILETIME ftCreationTime;
        public ComTypes.FILETIME ftLastAccessTime;
        public ComTypes.FILETIME ftLastWriteTime;
        public uint nFileSizeHigh;
        public uint nFileSizeLow;
        public uint dwReserved0;
        public uint dwReserved1;
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst = MAX_PATH)]
        public string cFileName;
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 14)]
        public string cAlternateFileName;
    }
 
    // IPropertyStore Interface
    [ComImport]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    [Guid("886D8EEB-8CF2-4446-8D02-CDBA1DBDCF99")]
    private interface IPropertyStore
    {
        uint GetCount([Out] out uint cProps);
        uint GetAt([In] uint iProp, out PropertyKey pkey);
        uint GetValue([In] ref PropertyKey key, [Out] PropVariant pv);
        uint SetValue([In] ref PropertyKey key, [In] PropVariant pv);
        uint Commit();
    }
 
    // PropertyKey Structure
    // Narrowed down from PropertyKey.cs of Windows API Code Pack 1.1
    [StructLayout(LayoutKind.Sequential, Pack = 4)]
    private struct PropertyKey
    {
        #region Fields
 
        private Guid formatId; // Unique GUID for property
        private Int32 propertyId; // Property identifier (PID)
 
        #endregion
 
        #region Public Properties
 
        public Guid FormatId
        {
            get { return formatId; }
        }
 
        public Int32 PropertyId
        {
            get { return propertyId; }
        }
 
        #endregion
 
        #region Constructor
 
        public PropertyKey(Guid formatId, Int32 propertyId)
        {
            this.formatId = formatId;
            this.propertyId = propertyId;
        }
 
        public PropertyKey(string formatId, Int32 propertyId)
        {
            this.formatId = new Guid(formatId);
            this.propertyId = propertyId;
        }
 
        #endregion
    }
 
    // PropVariant Class (only for string value)
    // Narrowed down from PropVariant.cs of Windows API Code Pack 1.1
    // Originally from http://blogs.msdn.com/b/adamroot/archive/2008/04/11
    // /interop-with-propvariants-in-net.aspx
    [StructLayout(LayoutKind.Explicit)]
    private sealed class PropVariant : IDisposable
    {
        #region Fields
 
        [FieldOffset(0)]
        ushort valueType; // Value type
 
        // [FieldOffset(2)]
        // ushort wReserved1; // Reserved field
        // [FieldOffset(4)]
        // ushort wReserved2; // Reserved field
        // [FieldOffset(6)]
        // ushort wReserved3; // Reserved field
 
        [FieldOffset(8)]
        IntPtr ptr; // Value
 
        #endregion
 
        #region Public Properties
 
        // Value type (System.Runtime.InteropServices.VarEnum)
        public VarEnum VarType
        {
            get { return (VarEnum)valueType; }
            set { valueType = (ushort)value; }
        }
 
        // Whether value is empty or null
        public bool IsNullOrEmpty
        {
            get { return (valueType == (ushort)VarEnum.VT_EMPTY || valueType == (ushort)VarEnum.VT_NULL); }
        }
 
        // Value (only for string value)
        public string Value
        {
            get { return Marshal.PtrToStringUni(ptr); }
        }
 
        #endregion
 
        #region Constructor
 
        public PropVariant() { }
 
        // Construct with string value
        public PropVariant(string value)
        {
            if (value == null)
                throw new ArgumentException("Failed to set value.");
 
            valueType = (ushort)VarEnum.VT_LPWSTR;
            ptr = Marshal.StringToCoTaskMemUni(value);
        }
 
        #endregion
 
        #region Destructor
 
        ~PropVariant()
        {
            Dispose();
        }
 
        public void Dispose()
        {
            PropVariantClear(this);
            GC.SuppressFinalize(this);
        }
 
        #endregion
    }
 
    [DllImport("Ole32.dll", PreserveSig = false)]
    private static extern void PropVariantClear([In, Out] PropVariant pvar);
 
    [DllImport("Shell32.dll", CharSet = CharSet.Unicode, PreserveSig = false)]
    private static extern void SHGetNameFromIDList(IntPtr pidl, uint sigdnName, [Out, MarshalAs(UnmanagedType.LPTStr)] out string ppszName);
 
    [DllImport("Shell32.dll")]
    private static extern void ILFree(IntPtr pidl);
 
    #endregion
 
    #region Private
 
    private IShellLinkW shellLinkW = null;
 
    private bool readOnly = false;
 
    private readonly PropertyKey AppUserModelIDKey =
        new PropertyKey("{9F4C2855-9F79-4B39-A8D0-E1D42DE1D5F3}", 5);
 
    private const int MAX_PATH = 260;
    private const int INFOTIPSIZE = 1024;
 
    private const int SW_SHOWNORMAL = 1;
    private const int SW_SHOWMINIMIZED = 2;
    private const int SW_SHOWMAXIMIZED = 3;
    private const int SW_SHOWMINNOACTIVE = 7;
 
    private const int STGM_READ = 0x00000000;
    private const int STGM_READWRITE = 0x00000002;
    private const uint SLGP_UNCPRIORITY = 0x0002;
    private const uint SLGP_RAWPATH = 0x0004;
 
    private const uint SIGDN_DESKTOPABSOLUTEPARSING = 0x80028000;
 
 
    private IPersistFile PersistFile
    {
        get
        {
            IPersistFile PersistFile = (IPersistFile)shellLinkW;
            if (PersistFile == null)
                throw new COMException("Failed to create IPersistFile.");
            else
                return PersistFile;
        }
    }
 
    private IPropertyStore PropertyStore
    {
        get
        {
            IPropertyStore PropertyStore = (IPropertyStore)shellLinkW;
            if (PropertyStore == null)
                throw new COMException("Failed to create IPropertyStore.");
            else
                return PropertyStore;
        }
    }
 
    #endregion
 
    #region Public
 
    // Path of loaded shortcut file
    public string FilePath
    {
        get
        {
            string shortcutFile;
            PersistFile.GetCurFile(out shortcutFile);
            return shortcutFile;
        }
    }
 
    // Path of target file
    public string TargetPath
    {
        get
        {
            StringBuilder targetPath = new StringBuilder(MAX_PATH);
            WIN32_FIND_DATAW data = new WIN32_FIND_DATAW();
 
            VerifySucceeded(shellLinkW.GetPath(targetPath, targetPath.Capacity, ref data, SLGP_RAWPATH));
            return targetPath.ToString();
        }
        set
        {
            VerifyReadOnly();
            VerifySucceeded(shellLinkW.SetPath(value));
        }
    }
 
    // Shell item id list
    public string IDList
    {
        get
        {
            string idList;
            System.IntPtr pidl = IntPtr.Zero;
 
            try
            {
                VerifySucceeded(shellLinkW.GetIDList(out pidl));
                SHGetNameFromIDList(pidl, SIGDN_DESKTOPABSOLUTEPARSING, out idList);
                return idList;
            }
            finally
            {
                ILFree(pidl);
            }
        }
    }
 
    // Description
    public string Description
    {
        get
        {
            StringBuilder description = new StringBuilder(INFOTIPSIZE);
 
            VerifySucceeded(shellLinkW.GetDescription(description, description.Capacity));
            return description.ToString();
        }
        set
        {
            VerifyReadOnly();
            VerifySucceeded(shellLinkW.SetDescription(value));
        }
    }
 
    // Arguments
    public string Arguments
    {
        get
        {
            StringBuilder arguments = new StringBuilder(INFOTIPSIZE);
 
            VerifySucceeded(shellLinkW.GetArguments(arguments, arguments.Capacity));
            return arguments.ToString();
        }
        set
        {
            VerifyReadOnly();
            VerifySucceeded(shellLinkW.SetArguments(value));
        }
    }
 
    // WorkingDirectory
    public string WorkingDirectory
    {
        get
        {
            StringBuilder workingDirectory = new StringBuilder(MAX_PATH);
 
            VerifySucceeded(shellLinkW.GetWorkingDirectory(workingDirectory, workingDirectory.Capacity));
            return workingDirectory.ToString();
        }
        set
        {
            VerifyReadOnly();
            VerifySucceeded(shellLinkW.SetWorkingDirectory(value));
        }
    }
 
    // IconLocation
    public string IconLocation
    {
        get
        {
            StringBuilder iconLocation = new StringBuilder(MAX_PATH);
            int iconIdx;
            VerifySucceeded(shellLinkW.GetIconLocation(iconLocation, iconLocation.Capacity, out iconIdx));
            iconLocation.Append(",");
            iconLocation.Append(iconIdx.ToString());
            return iconLocation.ToString();
        }
        set
        {
            VerifyReadOnly();
 
            int idx = value.LastIndexOf(",");
            string iconLocation;
            string strIdx;
            int iconIdx;
            if (idx >= 0)
            {
                strIdx = value.Substring(idx + 1);
                if (Int32.TryParse(strIdx, out iconIdx))
                {
                    iconLocation = value.Substring(0, idx);
                }
                else
                {
                    iconLocation = value;
                    iconIdx = 0;
                }
            }
            else
            {
                iconLocation = value;
                iconIdx = 0;
            }
            VerifySucceeded(shellLinkW.SetIconLocation(iconLocation, iconIdx));
        }
    }
 
    // WindowStyle
    public int WindowStyle
    {
        get
        {
            int windowStyle;
 
            VerifySucceeded(shellLinkW.GetShowCmd(out windowStyle));
            switch (windowStyle)
            {
                case SW_SHOWMINIMIZED:
                case SW_SHOWMINNOACTIVE:
                    return SW_SHOWMINNOACTIVE;
 
                case SW_SHOWMAXIMIZED:
                    return SW_SHOWMAXIMIZED;
 
                case SW_SHOWNORMAL:
                    return SW_SHOWNORMAL;
 
                default:
                    return 0;
            }
        }
        set
        {
            VerifyReadOnly();
 
            int windowStyle;
            switch (value)
            {
                case 0:
                case 1:
                    windowStyle = SW_SHOWNORMAL;
                    break;
 
                case 3:
                    windowStyle = SW_SHOWMAXIMIZED;
                    break;
 
                case 7:
                    windowStyle = SW_SHOWMINNOACTIVE;
                    break;
 
                default:
                    throw new ArgumentException("Unsupported value.");
            }
 
            VerifySucceeded(shellLinkW.SetShowCmd(windowStyle));
        }
    }
 
    // Hotkey
    public ushort Hotkey
    {
        get
        {
            ushort hotKey;
            VerifySucceeded(shellLinkW.GetHotKey(out hotKey));
            return hotKey;
        }
        set
        {
            VerifyReadOnly();
            VerifySucceeded(shellLinkW.SetHotKey(value));
        }
    }
 
    // AppUserModelID
    // https://docs.microsoft.com/en-us/windows/win32/shell/appids
    public string AppUserModelID
    {
        get
        {
            using (PropVariant pv = new PropVariant())
            {
                VerifySucceeded(PropertyStore.GetValue(AppUserModelIDKey, pv));
 
                if (pv.Value == null)
                    return string.Empty;
                else
                    return pv.Value;
            }
        }
        set
        {
            VerifyReadOnly();
            using (PropVariant pv = new PropVariant(value))
            {
                VerifySucceeded(PropertyStore.SetValue(AppUserModelIDKey, pv));
                VerifySucceeded(PropertyStore.Commit());
            }
        }
    }
 
    #endregion
 
    #region Constructor
 
    public ShellLink() : this(null) { }
 
    // Construct with loading shortcut file.
    public ShellLink(string file)
    {
        try
        {
            shellLinkW = (IShellLinkW)new CShellLink();
        }
        catch
        {
            throw new COMException("Failed to create ShellLink object.");
        }
 
        if (file != null)
            Load(file);
    }
 
    #endregion
 
    #region Destructor
 
    ~ShellLink()
    {
        Dispose(false);
    }
 
    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }
 
    protected virtual void Dispose(bool disposing)
    {
        if (shellLinkW != null)
        {
            // Release all references.
            Marshal.FinalReleaseComObject(shellLinkW);
            shellLinkW = null;
        }
    }
 
    #endregion
 
    #region Methods
 
    // Save shortcut file.
    public void Save()
    {
        VerifyReadOnly();
 
        string file = FilePath;
        if (file == null)
            throw new InvalidOperationException("File name is not given.");
        else
            Save(file);
    }
 
    public void Save(string file)
    {
        if (file == null)
        {
            throw new ArgumentNullException("File name is required.");
        }
        else
        {
            VerifyReadOnly();
            PersistFile.Save(file, true);
        }
    }
 
    // Load shortcut file.
    public void Load(string file)
    {
        Load(file, STGM_READWRITE);
    }
 
    public void Load(string file, int flags)
    {
        if (!File.Exists(file))
        {
            throw new FileNotFoundException("File is not found.", file);
        }
        else
        {
            PersistFile.Load(file, flags);
            if ((flags & 0x0000000f) == 0)
                readOnly = true;
        }
    }
 
    // Verify if operation succeeded.
    private static void VerifySucceeded(uint hresult)
    {
        if (hresult > 1)
            throw new InvalidOperationException("Failed with HRESULT: " +
                hresult.ToString("X"));
    }
 
    // Verify if operation as read only.
    private void VerifyReadOnly()
    {
        if (readOnly)
            throw new UnauthorizedAccessException("This object is read-only.");
    }
 
    #endregion
}