Providers Property

Roles.Providers Property

 

Gets a collection of the role providers for the ASP.NET application.

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

static member Providers : RoleProviderCollection with get

Property Value

Type: System.Web.Security.RoleProviderCollection

A RoleProviderCollection that contains the role providers configured for the ASP.NET application.

Exception Condition
System.Configuration.Provider.ProviderException

Role management is not enabled.

The Providers property references all the role providers enabled for an application, including any providers added in the Web.config file. You can control which role providers are available for an application by using the providers element of the section in the Web.config file for your application.

The following example shows a section that removes any existing providers (such as those specified in the Machine.config file) and adds a SqlRoleProvider instance as the role provider for the application.

<configuration>
  <connectionStrings>
    <add name="SqlServices" connectionString="Data Source=MySqlServer;Integrated Security=SSPI;Initial Catalog=aspnetdb;" />
  </connectionStrings>

  <system.web>
    <roleManager defaultProvider="SqlProvider" 
      enabled="true"
      cacheRolesInCookie="true"
      cookieName=".ASPROLES"
      cookieTimeout="30"
      cookiePath="/"
      cookieRequireSSL="false"
      cookieSlidingExpiration="true"
      cookieProtection="Encrypted">

      <providers>
        <clear/>
        <add
          name="SqlProvider"
          type="System.Web.Security.SqlRoleProvider"
          connectionStringName="SqlServices"
          applicationName="MyApplication" />
         </providers>

    </roleManager>
  </system.web>
</configuration>

You can obtain a strongly typed reference to a provider from the Providers collection by indexing the role provider by name and casting it as the desired type.

You can obtain a reference to the default provider for an application using the Provider property.

The following code example lists the providers enabled for an application and their respective types.

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

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft