This documentation is archived and is not being maintained.

SqlPipe::SendResultsStart Method

Marks the beginning of a result set to be sent back to the client, and uses the record parameter to construct the metadata that describes the result set.

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

public:
void SendResultsStart(
	SqlDataRecord^ record
)

Parameters

record
Type: Microsoft.SqlServer.Server::SqlDataRecord
A SqlDataRecord object from which metadata is extracted and used to describe the result set.

ExceptionCondition
ArgumentNullException

The record is nullptr.

ArgumentException

The record has no columns or has not been initialized.

InvalidOperationException

A method other than SendResultsRow or SendResultsEnd was called after the SendResultsStart method.

Managed stored procedures can send result sets to clients that are not implementing a SqlDataReader. This method, along with SendResultsRow and SendResultsEnd, allow stored procedures to send custom result sets to the client.

The SendResultsStart method marks the beginning of a result set, and uses the record parameter to construct the metadata that describes the result set. All the subsequent rows, sent using the SendResultsRow method, must match that metadata definition.

Note that after calling SendResultsStart, only SendResultsRow and SendResultsEnd can be called. Any other method in the same instance of SqlPipe throws an InvalidOperationException. SendResultsEnd sets SqlPipe back to the initial state where other methods can be called.

After control returns to Transact-SQL from CLR execution, do not attempt to use a static or local variable initialized to CLR memory. For example, do not store an instance of an in process class, for example SQLDataRecord, which will be used after control returns from CLR. One exception is the SQLMetaData in process class.

The following example creates a new SqlDataRecord and its SqlMetaData. The example then marks the beginning of a result set using the SendResultsStart method, sends records with example data back to the client using the SendResultsRow method, and marks the end of the result set with the SendResultsEnd method.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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