RoleProvider.IsUserInRole Method (String, String)
Gets a value indicating whether the specified user is in the specified role for the configured applicationName.
Assembly: System.Web.ApplicationServices (in System.Web.ApplicationServices.dll)
Parameters
- username
-
Type:
System.String
The user name to search for.
- roleName
-
Type:
System.String
The role to search in.
Return Value
Type: System.Booleantrue if the specified user is in the specified role for the configured applicationName; otherwise, false.
The IsUserInRole method is called by the IsUserInRole method of the Roles class to determine whether the current logged-on user is associated with a role from the data source for the configured ApplicationName.
If the specified user name is null or is an empty string, we recommend that your provider throw an exception.
If the specified role name is null or is an empty string, we recommend that your provider throw an exception.
The following code example shows a sample implementation of the IsUserInRole method.
public override bool IsUserInRole(string username, string rolename) { if (username == null || username == "") throw new ProviderException("User name cannot be empty or null."); if (rolename == null || rolename == "") throw new ProviderException("Role name cannot be empty or null."); bool userIsInRole = false; OdbcConnection conn = new OdbcConnection(connectionString); OdbcCommand cmd = new OdbcCommand("SELECT COUNT(*) FROM UsersInRoles " + " WHERE Username = ? AND Rolename = ? AND ApplicationName = ?", conn); cmd.Parameters.Add("@Username", OdbcType.VarChar, 255).Value = username; cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename; cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName; try { conn.Open(); int numRecs = (int)cmd.ExecuteScalar(); if (numRecs > 0) { userIsInRole = true; } } catch (OdbcException) { // Handle exception. } finally { conn.Close(); } return userIsInRole; }
Available since 2.0