RoleProvider.CreateRole メソッド

.NET Framework クラス ライブラリ リファレンス

RoleProvider.CreateRole メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

新しいロールを構成済みの applicationName のデータ ソースに追加します。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public MustOverride Sub
 CreateRole ( _
    roleName As String _
)

Visual Basic (使用法)

Dim instance As RoleProvider
Dim roleName As String

instance.CreateRole(roleName)

C#

public abstract void CreateRole (
    string roleName
)

C++

public:
virtual void CreateRole (
    String^ roleName
) abstract

J#

public abstract void CreateRole (
    String roleName
)

JScript

public abstract function CreateRole (
    roleName : String
)

パラメータ

roleName

作成するロールの名前。

解説

CreateRole は Roles クラスの CreateRole メソッドによって呼び出され、指定されたロールを構成済みの ApplicationName のデータ ソースに追加します。

指定されたロール名が構成済みの applicationName に既に存在している場合、または null 参照 (Visual Basic では Nothing) または空の文字列である場合、プロバイダから例外をスローすることをお勧めします。

指定されたロール名にコンマが含まれている場合、プロバイダから例外をスローすることをお勧めします。

データベースのテーブルの固定長の列に合わせるなど、データ ソースがロール名の長さを制限している場合、ロール名がデータ ソースで許可される最大長を超える場合に、例外をスローすることをお勧めします。

使用例

CreateRole メソッドの実装サンプルを次のコード例に示します。

Visual Basic

Public Overrides Sub CreateRole(rolename
 As String) 
  If rolename Is Nothing
 OrElse rolename = "" Then
 _
    Throw New ProviderException("Role
 name cannot be empty or null.")
  If rolename.IndexOf(",") >
 0 Then _
    Throw New ArgumentException("Role
 names cannot contain commas.")
  If RoleExists(rolename) Then _
    Throw New ProviderException("Role
 name already exists.")
  If rolename.Length > 255 Then _
    Throw New ProviderException("Role
 name cannot exceed 255 characters.")

  Dim conn As OdbcConnection = New
 OdbcConnection(connectionString)
  Dim cmd As OdbcCommand = New
 OdbcCommand("INSERT INTO [" & rolesTable &
 "]" & _
                                           " (Rolename, ApplicationName)
 " & _
                                           " Values(?, ?)",
 conn)

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

  Try
    conn.Open()

    cmd.ExecuteNonQuery()
  Catch e As OdbcException
    ' Handle exception.
  Finally
    conn.Close()      
  End Try
End Sub

C#

public override void CreateRole(string
 rolename)
{ 
  if (rolename == null || rolename == "")
    throw new ProviderException("Role name cannot be empty
 or null.");
  if (rolename.IndexOf(',') > 0)
    throw new ArgumentException("Role names cannot contain
 commas.");
  if (RoleExists(rolename))
    throw new ProviderException("Role name already exists.");
  if (rolename.Length > 255)
    throw new ProviderException("Role name cannot exceed
 255 characters.");

  OdbcConnection conn = new OdbcConnection(connectionString);
  OdbcCommand cmd = new OdbcCommand("INSERT INTO ["
 + rolesTable + "]"  +
                                    " (Rolename, ApplicationName) " +
                                    " Values(?, ?)", conn);

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

  try
  {
    conn.Open();

    cmd.ExecuteNonQuery();
  }
  catch (OdbcException)
  {
    // Handle exception.
  }
  finally
  {
    conn.Close();      
  }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RoleProvider クラス
RoleProvider メンバ
System.Web.Security 名前空間
その他の技術情報
ロール プロバイダの実装