SqlServices.InstallSessionState Method (String, String, String, String, SessionStateType)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Installs components for ASP.NET session state on a SQL Server database.

Namespace:   System.Web.Management
Assembly:  System.Web (in System.Web.dll)

public static void InstallSessionState(
	string server,
	string user,
	string password,
	string customDatabase,
	SessionStateType type
)

Parameters

server
Type: System.String

The SQL Server instance on which to install the session-state components.

user
Type: System.String

The user name to use when connecting to the database.

password
Type: System.String

The password to use when connecting to the database.

customDatabase
Type: System.String

The database on which to install the session-state components.

type
Type: System.Web.Management.SessionStateType

One of the SessionStateType values, specifying the type of session state to install.

Exception Condition
ArgumentException

The type is Custom and the customDatabase value is not supplied, or the type is either Temporary or Persisted and the customDatabase value is not null.

HttpException

Unable to connect to the specified database server.

SqlExecutionException

An exception occurred while processing the SQL statements required for the operation.

If server is null or not supplied, SqlServices will use the default SQL Server instance.

System_CAPS_noteNote

The connection to the database server is made with a trusted connection.

The following code example shows how to use the InstallSessionState(String, String, String, String, SessionStateType) method of the SqlServices class.

// Install persisted session state.
SqlServices.InstallSessionState(server, user, password,
	null, SessionStateType.Persisted);

.NET Framework
Available since 2.0
Return to top
Show: