如何在.NET应用中获取CLR存储过程Pipe.Send返回的值？

这个问题我之前碰到过，核心原因是：SqlContext.Pipe.Send()发送的内容是SQL Server的信息消息流（对应SSMS的「消息」选项卡），而不是存储过程的返回值（RETURN语句）或输出参数，所以直接用SqlCommand的ExecuteScalar()或者读取参数值的方式是拿不到的。

下面给你两种可行的解决方案，根据你的需求选择：

方案一：直接捕获SQL Server的消息流（无需修改CLR存储过程） #

在.NET中，可以通过SqlConnection的InfoMessage事件来捕获这类消息。当SQL Server发送信息级消息（包括Pipe.Send、PRINT语句的输出）时，会触发这个事件。

VB.NET代码示例： #

Using conn As New SqlConnection("你的数据库连接字符串")
    conn.Open()

    ' 订阅InfoMessage事件，用来接收Pipe.Send的输出
    AddHandler conn.InfoMessage, Sub(sender As Object, e As SqlInfoMessageEventArgs)
                                     ' e.Message就是CLR过程发送的内容，比如'41124|4032|Ok'
                                     Dim receivedMessage As String = e.Message
                                     ' 这里可以根据需求处理消息，比如拆分字符串
                                     Console.WriteLine("收到CLR消息：" & receivedMessage)
                                 End Sub

    Using cmd As New SqlCommand("GetDistanceAndTime", conn)
        cmd.CommandType = CommandType.StoredProcedure
        ' 添加存储过程所需的输入参数
        cmd.Parameters.AddWithValue("@Profile", "你的Profile参数值")
        cmd.Parameters.AddWithValue("@Param2", "53.6924582,-2.8730636000")
        cmd.Parameters.AddWithValue("@Param3", "53.816408201,-2.990582799997")

        ' 用ExecuteNonQuery执行，因为存储过程没有返回结果集，只是发送消息
        cmd.ExecuteNonQuery()
    End Using
End Using

⚠️ 注意：InfoMessage会捕获所有SQL Server发送的信息级消息，如果你的CLR过程可能发送多条消息，需要在事件处理逻辑里做区分。

方案二：改用输出参数（需要修改并重新部署CLR存储过程） #

如果觉得捕获消息流不够直观，或者希望和传统存储过程的参数传递方式统一，可以修改CLR存储过程，把结果放到输出参数中，同时保留Pipe.Send（方便在SSMS里查看输出）。

步骤1：修改CLR存储过程代码 #

假设原来的CLR方法签名是无输出参数的，现在添加一个输出参数：

[SqlProcedure]
public static void GetDistanceAndTime(SqlString Profile, SqlString StartPoint, SqlString EndPoint, out SqlString OutputResult)
{
    try
    {
        // 你的原有业务逻辑，生成结果字符串
        string result = "41124|4032|Ok";
        
        // 保留Pipe.Send，让SSMS的消息选项卡能看到输出
        SqlContext.Pipe.Send(result);
        // 给输出参数赋值，供.NET应用获取
        OutputResult = new SqlString(result);
    }
    catch (Exception ex)
    {
        string errorMsg = ex.Message;
        SqlContext.Pipe.Send(errorMsg);
        OutputResult = new SqlString(errorMsg);
    }
}

步骤2：在SQL Server中重新部署存储过程 #

更新存储过程的定义，添加输出参数：

ALTER PROCEDURE GetDistanceAndTime
    @Profile NVARCHAR(MAX),
    @StartPoint NVARCHAR(MAX),
    @EndPoint NVARCHAR(MAX),
    @OutputResult NVARCHAR(MAX) OUTPUT
AS EXTERNAL_NAME YourAssemblyName.YourClassName.GetDistanceAndTime;

（替换YourAssemblyName和YourClassName为你实际的程序集名称和类名）

步骤3：在VB.NET中调用并获取输出参数 #

Using conn As New SqlConnection("你的数据库连接字符串")
    conn.Open()

    Using cmd As New SqlCommand("GetDistanceAndTime", conn)
        cmd.CommandType = CommandType.StoredProcedure

        ' 添加输入参数
        cmd.Parameters.AddWithValue("@Profile", "你的Profile参数值")
        cmd.Parameters.AddWithValue("@StartPoint", "53.6924582,-2.8730636000")
        cmd.Parameters.AddWithValue("@EndPoint", "53.816408201,-2.990582799997")

        ' 添加输出参数
        Dim outputParam As New SqlParameter("@OutputResult", SqlDbType.NVarChar, -1)
        outputParam.Direction = ParameterDirection.Output
        cmd.Parameters.Add(outputParam)

        ' 执行存储过程
        cmd.ExecuteNonQuery()

        ' 获取输出参数的值
        Dim resultMessage As String = outputParam.Value.ToString()
        Console.WriteLine("获取到的结果：" & resultMessage)
    End Using
End Using

两种方案对比 #

• 方案一：无需修改现有CLR存储过程，快速实现，但需要通过事件处理消息，逻辑相对间接。
• 方案二：更符合常规存储过程的参数传递模式，代码可读性更高，但需要修改并重新部署CLR组件，适合长期维护的场景。

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