windows - 在线程中调用 SHGetFileInfo 以避免 UI 卡住

Question

在 .NET 4.0 应用程序 (WPF) 中，我们使用 SHGetFileInfo 获取目录树的 shell 图标。由于在某些情况下这需要相当长的时间(即对于无法访问的网络驱动器或软盘驱动器)，我们希望在线程中执行此操作，然后在读入图标时更新图标。

调用方式基本相同，只是在一个线程内执行。因为有人说线程必须是 STA 才能起作用，所以我们使用 Thread 而不是 ThreadPool 进行测试，结果相同。使用 ThreadPool 也不起作用。

SHGetFileInfo 成功(返回 1)，但结构中的 hIcon 成员为零。

IntPtr GetIcon(string name)
{
    Shell32.SHFILEINFO shfi = new Shell32.SHFILEINFO();
    uint flags = Shell32.SHGFI_ICON | Shell32.SHGFI_USEFILEATTRIBUTES | Shell32.SHGFI_SMALLICON;

    Shell32.SHGetFileInfo(
        name, System.IO.Directory.Exists(name) ? Shell32.FILE_ATTRIBUTE_DIRECTORY : Shell32.FILE_ATTRIBUTE_NORMAL,
        ref shfi, 
        (uint) System.Runtime.InteropServices.Marshal.SizeOf(shfi), 
        flags );
    return shfi.hIcon;
}

完全相同的代码在 GUI 线程中运行良好。必须做些什么才能使该函数从单独的线程运行，或者使其在不阻塞 GUI 线程的情况下运行？

---

更新:围绕这个的代码基本上是这样的:

var thread = new System.Threading.Thread(() => {
    var result = GetIcon("C:\\");
    // ... do something with the result
});
thread.SetApartmentState(System.Threading.ApartmentState.STA);
thread.Start();

如果只保留线程委托(delegate)中的行，它可以正常工作(当然是在 GUI 线程上)。

---

更新:目前，我们只需调用 SHGetFileInfo 即可使其正常工作。这样做的好处是解决了原来的问题(在加载所有图标之前不会显示带有文件 View 的页面)，尽管这意味着页面会因每个图标而挂起。但至少用户现在看到了一些事情正在发生。我们仍在寻找问题的实际解决方案。

Answer 1

刚刚成功地得到了这样的东西。在 Visual Studio 之外运行时，它以前曾严重崩溃。在此之前，我们经常取回默认图标，而不是文件类型的正确图标(因为我们要找的是文件图标，而不是目录图标)。

要考虑的因素的总结。

• 如前所述，与 Shell 交互需要使用 STA 线程来发送消息。 BackgroundWorker 在这里是不够的。
• 当您初始化 SHFILEINFO 时，将两个字符串属性(显示名称和类型名称)设置为 string.Empty。这在大多数示例中都没有显示，但不这样做会导致我们崩溃。 (在 Debug模式下，这意味着我们返回的第一个图标是错误的，这可能与您的问题相同。)
• 检查您的互操作声明是否正确。例如，SHFILEINFO 类大概应该有一个 [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode, Pack = 4)] 属性。

STA 线程后台任务的 TaskScheduler

我们正在使用 Task Parallel Library，因此需要一个 TaskScheduler 来在合适的后台线程上安排工作。以下代码示例适用于公开可用于此目的的 TaskScheduler 属性的类。

请注意，在我们的应用程序的整个生命周期中，我们只有一个此类的实例，因此我们没有实现 IDisposable。如果你想创建/销毁这些，你需要处理它。

namespace MyNamespace
{
    using System;
    using System.ComponentModel.Composition;
    using System.Threading;
    using System.Threading.Tasks;
    using System.Windows;
    using System.Windows.Threading;

    /// <summary>
    /// Exposes a <see cref="TaskScheduler"/> that schedules its work on a STA background thread.
    /// </summary>
    [Export]
    public class StaTaskSchedulerSource
    {
        /// <summary>
        /// A window that is used for message pumping.
        /// </summary>
        private Window window;

        /// <summary>
        /// Thread on which work is scheduled.
        /// </summary>
        private Thread thread;

        /// <summary>
        /// The <see cref="TaskScheduler"/> exposed by this class.
        /// </summary>
        private TaskScheduler taskScheduler;

        /// <summary>
        /// Initializes a new instance of the <see cref="StaTaskSchedulerSource"/> class.
        /// </summary>
        public StaTaskSchedulerSource()
        {
            using (ManualResetEvent re = new ManualResetEvent(false))
            {
                this.thread = new Thread(
                    () =>
                    {
                        this.window = new Window();

                        re.Set();

                        Dispatcher.Run();
                    });

                this.thread.IsBackground = true;
                this.thread.SetApartmentState(ApartmentState.STA);

                this.thread.Start();

                re.WaitOne();
            }

            this.window.Dispatcher.Invoke(
                new Action(
                    () =>
                    {
                        this.taskScheduler = TaskScheduler.FromCurrentSynchronizationContext();
                    }));
        }

        /// <summary>
        /// Gets a <see cref="TaskScheduler"/> that schedules work on a background STA
        /// thread.
        /// </summary>
        public TaskScheduler TaskScheduler
        {
            get
            {
                return this.taskScheduler;
            }
        }
    }
}

当然，这整个事情只是使用调度程序来调用另一个线程上的调用。这可能有点慢。因此，如果处理很多图标，最好将它们分批处理。此外，我们缓存了已经检索到的图标，因此我们完全不需要第二次使用 Win Shell。

安全图标句柄

您可能还会发现以下图标句柄包装器很有用。它源自 SafeHandle并确保您的图标在任何情况下都被正确销毁。

namespace UnmanagedResourceLib
{
    using System;
    using System.Runtime.ConstrainedExecution;
    using System.Runtime.InteropServices;
    using System.Security;
    using System.Security.Permissions;
    using Microsoft.Win32.SafeHandles;

    /// <summary>
    /// A <see cref="SafeHandle"/> implementation for HICON icon handles.
    /// </summary>
    [SecurityPermission(SecurityAction.InheritanceDemand, UnmanagedCode = true)]
    [SecurityPermission(SecurityAction.Demand, UnmanagedCode = true)]
    internal class SafeIconHandle : SafeHandleZeroOrMinusOneIsInvalid
    {
        /// <summary>
        /// Prevents a default instance of the <see cref="SafeIconHandle"/> class from being created.
        /// </summary>
        private SafeIconHandle()
            : base(true)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="SafeIconHandle"/> class.
        /// </summary>
        /// <param name="nativeHandle">The HICON to wrap.</param>
        /// <param name="ownsHandle"><c>true</c> if finalization of this object should cause the icon to be destroyed.</param>
        public SafeIconHandle(IntPtr nativeHandle, bool ownsHandle)
            : base(ownsHandle)
        {
            this.handle = nativeHandle;
        }

        /// <inheritdoc />
        [ReliabilityContract(Consistency.WillNotCorruptState, Cer.MayFail)]
        override protected bool ReleaseHandle()
        {
            return NativeMethods.DestroyIcon(this.handle);
        }

        /// <summary>
        /// Exposes Windows API call to destroy an icon.
        /// </summary>
        [SuppressUnmanagedCodeSecurity]
        internal static class NativeMethods
        {
            /// <summary>
            /// Destroys an icon and frees any memory the icon occupied. 
            /// </summary>
            /// <param name="hIcon">A handle to the icon to be destroyed.</param>
            /// <returns><c>true</c> if the function succeeds.</returns>
            [System.Runtime.InteropServices.DllImport("user32.dll", SetLastError = true)]
            public static extern bool DestroyIcon(IntPtr hIcon);
        }
    }
}