如何通过C#在services.msc启动Windows服务时显示自定义错误消息？

通过services.msc启动已安装的服务时，若启动失败，Windows会在弹窗中显示通用错误消息。但在某些场景下，我们希望在此处展示有意义的提示信息，解释服务启动失败的原因，例如客户在安装过程中未完成部分配置项的情况。请问是否可以通过C#实现该功能？

要在服务启动失败时向services.msc返回自定义错误信息，核心是利用Windows服务的API设置服务退出代码和对应的错误描述，具体实现步骤如下：

• 在C#服务项目的OnStart方法中，添加启动前的校验逻辑（比如检查配置项是否完整）
• 当校验失败时，调用SetServiceStatusAPI更新服务状态为SERVICE_STOPPED，并指定自定义的退出代码（建议使用ERROR_SERVICE_SPECIFIC_ERROR作为基础代码，搭配自定义的错误编号）
• 同时通过ServiceBase的ExitCode属性设置服务退出代码，或者直接调用Win32 API注册错误描述

关键代码示例 #

using System;
using System.ServiceProcess;
using System.Runtime.InteropServices;

public class CustomService : ServiceBase
{
    // 导入Win32 API
    [DllImport("advapi32.dll", SetLastError = true)]
    private static extern bool SetServiceStatus(IntPtr handle, ref SERVICE_STATUS serviceStatus);

    private const int SERVICE_STOPPED = 0x00000001;
    private const int SERVICE_ERROR_SPECIFIC = 0x00000003;
    private const int ERROR_SERVICE_SPECIFIC_ERROR = 0x00000421;

    [StructLayout(LayoutKind.Sequential)]
    private struct SERVICE_STATUS
    {
        public int dwServiceType;
        public int dwCurrentState;
        public int dwControlsAccepted;
        public int dwWin32ExitCode;
        public int dwServiceSpecificExitCode;
        public int dwCheckPoint;
        public int dwWaitHint;
    }

    protected override void OnStart(string[] args)
    {
        // 模拟配置项检查
        if (!CheckRequiredConfig())
        {
            // 设置自定义错误信息
            SERVICE_STATUS status = new SERVICE_STATUS();
            status.dwServiceType = 0x00000010; // SERVICE_WIN32_OWN_PROCESS
            status.dwCurrentState = SERVICE_STOPPED;
            status.dwWin32ExitCode = ERROR_SERVICE_SPECIFIC_ERROR;
            status.dwServiceSpecificExitCode = 1001; // 自定义错误编号
            status.dwCheckPoint = 0;
            status.dwWaitHint = 0;

            SetServiceStatus(this.ServiceHandle, ref status);
            
            // 退出服务
            this.ExitCode = 1001;
            Stop();
            return;
        }

        // 正常启动服务逻辑
        base.OnStart(args);
    }

    private bool CheckRequiredConfig()
    {
        // 这里实现实际的配置项检查逻辑，返回true表示配置正常，false表示配置缺失
        return false; // 模拟配置缺失场景
    }
}

补充说明 #

• 自定义错误描述需要通过系统错误消息表注册，或者使用EventLog写入事件日志，用户可以通过事件查看器查看详细错误原因
• 若要让services.msc弹窗直接显示自定义文本，需要将错误信息注册到系统的消息资源文件中，这一步需要额外的资源编译步骤（使用mc.exe和rc.exe工具）

内容的提问来源于stack exchange，提问作者theimpatientcoder