SqlMembershipProvider.GetUserNameByEmail メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

SqlMembershipProvider.GetUserNameByEmail メソッド

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

指定した電子メールアドレスに関連付けられているユーザー名を取得します。

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

Visual Basic (宣言)

Public Overrides Function
 GetUserNameByEmail ( _
    email As String _
) As String

Visual Basic (使用法)

Dim instance As SqlMembershipProvider
Dim email As String
Dim returnValue As String

returnValue = instance.GetUserNameByEmail(email)

public override string GetUserNameByEmail (
    string email
)

C++

public:
virtual String^ GetUserNameByEmail (
    String^ email
) override

public String GetUserNameByEmail (
    String email
)

JScript

public override function GetUserNameByEmail
 (
    email : String
) : String

パラメータ

email: 検索対象の電子メールアドレス。

戻り値
指定した電子メールアドレスに関連付けられているユーザー名。一致するユーザー名が見つからない場合、このメソッドは null 参照 (Visual Basic では Nothing) を返します。

例外

例外の種類	条件
System.ArgumentException	email が 256 文字を超えています。
System.Configuration.Provider.ProviderException	データベースに同じ電子メールアドレスを持つユーザーが複数あり、かつ RequiresUniqueEmail が true です。

解説

このメソッドは Membership クラスによって電子メールアドレスと共に呼び出され、ASP.NET アプリケーションの構成ファイル (Web.config) に指定されている SQL Server データベースから関連付けられているユーザー情報を取得します。

メンバシップデータベース内の複数のユーザーが同じ電子メールアドレスを持っている場合、最初のユーザー名が返されます。データベース内の各電子メールアドレスを一意にするように、アプリケーションの構成ファイルで requiresUniqueEmail 属性を true に設定することもできます。

email パラメータ値の先頭と末尾の空白はトリムされます。

使用例

指定の電子メールアドレス持つユーザー名を取得するコード例を次に示します。

メモ
このコード例では、Membership クラスを使用して、Web.config ファイル内の defaultProvider として指定されている SqlMembershipProvider を呼び出します。既定のプロバイダに SqlMembershipProvider 型としてアクセスする必要がある場合は、Membership クラスの Provider プロパティをキャストできます。固有のプロバイダの種類として構成されたその他のプロバイダにアクセスする場合、Membership クラスの Providers プロパティを使用して、参照されたプロバイダを固有プロバイダの種類としてキャストすることによって、構成された名前でアクセスできます。

メモ

このコード例では、Membership クラスを使用して、Web.config ファイル内の defaultProvider として指定されている SqlMembershipProvider を呼び出します。既定のプロバイダに SqlMembershipProvider 型としてアクセスする必要がある場合は、Membership クラスの Provider プロパティをキャストできます。固有のプロバイダの種類として構成されたその他のプロバイダにアクセスする場合、Membership クラスの Providers プロパティを使用して、参照されたプロバイダを固有プロバイダの種類としてキャストすることによって、構成された名前でアクセスできます。

Visual Basic

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security"
 %>
<script runat="server">

Public Sub Search_OnClick(sender As
 Object, args As EventArgs)

  Dim username As String
 = Membership.GetUserNameByEmail(EmailTextBox.Text)

  If username Is Nothing
 Then
    Msg.Text = "E-mail address " & Server.HtmlEncode(EmailTextBox.Text)
 & " is not found. Please reenter."
  Else
    Msg.Text = "The user name for " & Server.HtmlEncode(EmailTextBox.Text)
 & _
               " is " & Server.HtmlEncode(username)
 & "."
  End If

End Sub

</script>
<html>
<head>
<title>Sample: Retrieve Username By E-mail</title>
</head>
<body>

<form runat="server">
  <h3>Forgot your Username? Search for it by e-mail address.</h3>

  <asp:Label id="Msg" runat="server"
 ForeColor="maroon" /><BR>

  E-mail address: <asp:Textbox id="EmailTextBox"
 Columns="30" runat="server"
 />
                  <asp:RequiredFieldValidator id="EmailRequiredValidator"
 runat="server"
                                        ControlToValidate="EmailTextBox"
 ForeColor="red"
                                        Display="Static"
 ErrorMessage="Required" /><BR>

  <asp:Button id="SearchButton" Text="Search"
 
              OnClick="Search_OnClick" runat="server"
 />

</form>

</body>
</html>

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<script runat="server">

public void Search_OnClick(object sender, EventArgs
 args)
{
  string username = Membership.GetUserNameByEmail(EmailTextBox.Text);

  if (username == null)
  {
    Msg.Text = "E-mail address " + Server.HtmlEncode(EmailTextBox.Text)
 + " is not found. Please reenter.";
  }
  else
  {
    Msg.Text = "The user name for " + Server.HtmlEncode(EmailTextBox.Text)
 + 
               " is " + Server.HtmlEncode(username) + ".";
  }

}

</script>
<html>
<head>
<title>Sample: Retrieve Username By E-mail</title>
</head>
<body>

<form runat="server">
  <h3>Forgot your Username? Search for it by e-mail address.</h3>

  <asp:Label id="Msg" runat="server" ForeColor="maroon"
 /><BR>

  E-mail address: <asp:Textbox id="EmailTextBox" Columns="30"
 runat="server" />
                  <asp:RequiredFieldValidator id="EmailRequiredValidator"
 runat="server"
                                        ControlToValidate="EmailTextBox"
 ForeColor="red"
                                        Display="Static" ErrorMessage="Required"
 /><BR>

  <asp:Button id="SearchButton" Text="Search" 
              OnClick="Search_OnClick" runat="server" />

</form>

</body>
</html>