Export (0) Print
Expand All

SqlPipe.Send Method (String)

Sends a string message directly to the client or current output consumer.

Namespace:  Microsoft.SqlServer.Server
Assembly:  System.Data (in System.Data.dll)

public void Send(
	string message
)

Parameters

message
Type: System.String

The message string to be sent to the client.

ExceptionCondition
ArgumentException

The message is greater than 4,000 characters.

ArgumentNullException

The message is null.

The message string is sent as an informational message to the client. Client applications can listen to messages through different mechanisms, depending on the data access application programming interface (API) that they use. For example, if the client is using ADO.NET, the messages transmit through the InfoMessage event.

The following example uses the Send method to send a message string directly to the client.

	[Microsoft.SqlServer.Server.SqlProcedure]
	public static void StoredProcSendMessage()
	{
		// Send a message string back to the client.
		SqlContext.Pipe.Send("Hello World!");
	}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft