SqlRoleProvider.ApplicationName Property

Reference

Definition

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the name of the application for which to store and retrieve role information.

public:
 virtual property System::String ^ ApplicationName { System::String ^ get(); void set(System::String ^ value); };

public override string ApplicationName { get; set; }

member this.ApplicationName : string with get, set

Public Overrides Property ApplicationName As String

Property Value

String

The name of the application for which to store and retrieve role information. The default is the ApplicationPath property value for the current Request.

Exceptions

HttpException

An attempt was made to set the ApplicationName property by a caller that does not have High ASP.NET hosting permission.

ProviderException

An attempt was made to set the ApplicationName to a string that is longer than 256 characters.

Examples

The following example shows the roleManager element in the system.web section of the Web.config file for an ASP.NET application. It specifies the application's SqlRoleProvider instance and sets the ApplicationName property to MyApplication.

<roleManager defaultProvider="SqlProvider"
  enabled="true"
  cacheRolesInCookie="true"
  cookieName=".ASPROLES"
  cookieTimeout="30"
  cookiePath="/"
  cookieRequireSSL="false"
  cookieSlidingExpiration="true"
  cookieProtection="All" >
  <providers>
    <add
      name="SqlProvider"
      type="System.Web.Security.SqlRoleProvider"
      connectionStringName="SqlServices"
      applicationName="MyApplication" />
  </providers>
</roleManager>

Remarks

The ApplicationName is used by the SqlRoleProvider to associate users and roles with different applications. This enables multiple applications to use the same database to store user and role information without running into conflicts between duplicate user names or role names. Multiple ASP.NET applications can use the same database by specifying the same value in the ApplicationName property. The ApplicationName property can be set programmatically, or it can be set declaratively in the configuration file for the Web application using the applicationName attribute.

If a value is not specified for the applicationName attribute in the configuration file for the Web application, then the HttpRequest.ApplicationPath property value for the current HttpContext.Request object is used.

Caution

Because a single default role provider instance is used for all of the requests served by an HttpApplication object, you can have multiple requests executing concurrently and attempting to set the ApplicationName property value. The ApplicationName property is not thread safe for multiple writes, and changing the ApplicationName property value can result in unexpected behavior for multiple users of an application. It is recommended that you avoid writing code that allows users to set the ApplicationName property unless you must. An example of an application where setting the ApplicationName property may be required is an administrative application that manages role data for multiple applications. Such an application should be a single-user application and not a Web application.

Applies to

Delen via