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的指定角色相關聯，我們建議您的提供者傳回沒有元素的字串數位。

另請參閱

• 實作角色提供者