This documentation is archived and is not being maintained.

SqlContext Class

Represents an abstraction of the caller's context, which provides access to the SqlPipe, SqlTriggerContext, and WindowsIdentity objects. This class cannot be inherited.


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

public sealed class SqlContext

The SqlContext type exposes the following members.

Public propertyStatic memberIsAvailableSpecifies whether the calling code is running within SQL Server, and if the context connection can be accessed.
Public propertyStatic memberPipeGets the pipe object that allows the caller to send result sets, messages, and the results of executing commands back to the client.
Public propertyStatic memberTriggerContextGets the trigger context used to provide the caller with information about what caused the trigger to fire, and a map of the columns that were updated.
Public propertyStatic memberWindowsIdentityThe Microsoft Windows identity of the caller.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The SqlContext object can be used to obtain the trigger context (for code executing in a trigger) and the pipe object (when available, such as in stored procedures). It can also be used to obtain a WindowsIdentity object that represents the Microsoft Windows identity of the calling client, if the client authenticated with the server using integrated authentication.

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.

	public static void StoredProcReturnResultSet()
		// Create the record and specify the metadata for the columns.
		SqlDataRecord record = new SqlDataRecord(
			new SqlMetaData("col1", SqlDbType.NVarChar, 100),
			new SqlMetaData("col2", SqlDbType.Int));

		// Mark the begining of the result-set.

		// Send 10 rows back to the client.
		for (int i = 0; i < 10; i++)
			// Set values for each column in the row.
			record.SetString(0, "row " + i.ToString());
			record.SetInt32(1, i);

			// Send the row back to the client.

		// Mark the end of the result-set.

.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.