RoleProvider.GetUsersInRole(String) 方法

定义

命名空间:

System.Web.Security

程序集:

System.Web.ApplicationServices.dll

获取属于已配置 applicationName 的指定角色的用户的列表。

public:
 abstract cli::array <System::String ^> ^ GetUsersInRole(System::String ^ roleName);

public abstract string[] GetUsersInRole (string roleName);

abstract member GetUsersInRole : string -> string[]

Public MustOverride Function GetUsersInRole (roleName As String) As String()

参数

roleName

String

要获取其用户列表的角色的名称。

返回

String[]

一个字符串数组，其中包含属于已配置 applicationName 的指定角色的成员的所有用户名。

示例

下面的代码示例演示 方法的示例 GetUsersInRole 实现。

public override string[] GetUsersInRole(string rolename)
{
  if (rolename == null || rolename == "")
    throw new ProviderException("Role name cannot be empty or null.");
  if (!RoleExists(rolename))
    throw new ProviderException("Role does not exist.");

  string tmpUserNames = "";

  OdbcConnection conn = new OdbcConnection(connectionString);
  OdbcCommand cmd = new OdbcCommand("SELECT Username FROM UsersInRoles "  +
                                    " WHERE Rolename = ? AND ApplicationName = ?", conn);

  cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename;
  cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName;

  OdbcDataReader reader = null;

  try
  {
    conn.Open();

    reader = cmd.ExecuteReader();

    while (reader.Read())
    {
      tmpUserNames += reader.GetString(0) + ",";
    }
  }
  catch (OdbcException)
  {
    // Handle exception.
  }
  finally
  {
    if (reader != null) { reader.Close(); }
    conn.Close();      
  }

  if (tmpUserNames.Length > 0)
  {
    // Remove trailing comma.
    tmpUserNames = tmpUserNames.Substring(0, tmpUserNames.Length - 1);
    return tmpUserNames.Split(',');
  }

  return new string[0];
}

Public Overrides Function GetUsersInRole(ByVal rolename As String) As String()
    If rolename Is Nothing OrElse rolename = "" Then _
      Throw New ProviderException("Role name cannot be empty or null.")
    If Not RoleExists(rolename) Then _
      Throw New ProviderException("Role does not exist.")

    Dim tmpUserNames As String = ""

    Dim conn As OdbcConnection = New OdbcConnection(connectionString)
    Dim cmd As OdbcCommand = New OdbcCommand("SELECT Username FROM UsersInRoles " & _
                                             " WHERE Rolename = ? AND ApplicationName = ?", conn)

    cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename
    cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName

    Dim reader As OdbcDataReader = Nothing

    Try
        conn.Open()

        reader = cmd.ExecuteReader()

        Do While reader.Read()
            tmpUserNames &= reader.GetString(0) + ","
        Loop
    Catch e As OdbcException
        ' Handle exception.
    Finally
        If Not reader Is Nothing Then reader.Close()
        conn.Close()
    End Try

    If tmpUserNames.Length > 0 Then
        ' Remove trailing comma.
        tmpUserNames = tmpUserNames.Substring(0, tmpUserNames.Length - 1)
        Return tmpUserNames.Split(CChar(","))
    End If

    Return New String() {}
End Function

注解

GetUsersInRole 由 GetUsersInRole 类的 Roles 方法调用，以从数据源检索与角色关联的用户名。 仅检索已配置 ApplicationName 的角色。

如果配置的 applicationName 不存在指定的角色名称，或者如果为 null 或为空字符串，建议提供程序引发异常。

如果没有用户与配置的 applicationName的指定角色相关联，我们建议提供程序返回不带元素的字符串数组。

另请参阅

• 实现角色提供程序