SendMailErrorEventArgs.Handled SendMailErrorEventArgs.Handled SendMailErrorEventArgs.Handled SendMailErrorEventArgs.Handled Property

定義

Exception プロパティに格納されている SMTP 例外が処理されたかどうかを示します。Indicates if the SMTP exception that is contained in the Exception property has been handled.

public:
 property bool Handled { bool get(); void set(bool value); };
public bool Handled { get; set; }
member this.Handled : bool with get, set
Public Property Handled As Boolean

プロパティ値

true の場合、その例外は SendMailErrorEventHandler デリゲートによって処理されています。If true, the exception is consumed and handled by the SendMailErrorEventHandler delegate. false の場合、元のコール スタックとエラー メッセージを含んだ例外が再度スローされます。If false, the exception is rethrown, including the original call stack and error message.

既定値は、false です。The default is false.

次のコード例に示しますを使用する ASP.NET ページ、 ChangePassword Web コントロール、およびイベント ハンドラーが含まれています、SendMailErrorという名前のイベントSendMailErrorします。The following code example demonstrates an ASP.NET page that uses a ChangePassword Web control, and includes an event handler for the SendMailError event named SendMailError. コード例では、ASP.NET メンバーシップとフォーム認証、および、名とパスワードがわかっているユーザーが作成されているを使用する ASP.NET Web サイトが構成されている前提としています。The code example assumes that the ASP.NET Web site has been configured to use ASP.NET membership and Forms authentication, and that a user has been created whose name and password are known to you. 詳細については、次を参照してください。方法: 単純なフォーム認証を実装するします。For more information, see How to: Implement Simple Forms Authentication.

パスワードの変更が成功すると、コード、SendingMailイベント ハンドラーは、変更の確認をユーザーに電子メール メッセージを送信しようとしています。If the password change succeeds, the code in the SendingMail event handler attempts to send an email message to the user to confirm the change. SMTP でこのコード例を動作させるため、サーバーに構成されている必要があります。SMTP must already be configured on the server in order for this code example to work. SMTP サーバーを構成する方法については、次を参照してください。 NIB: 方法: インストールと構成の SMTP 仮想サーバーで IIS 6.0します。For information about how to configure an SMTP server, see NIB: How to: Install and Configure SMTP Virtual Servers in IIS 6.0. この例の目的で、必要はありません。 SMTP サーバーを構成するには電子メール メッセージを送信するエラーをテストする例が構築されます。For the purposes of this example, it is not necessary to configure an SMTP server; the example is constructed to test for a failure to send an email message.

メール サーバーが正しく構成されていないまたはその他のエラーが発生し、電子メール メッセージを送信できない場合、SendMailError関数が呼び出されます。If a mail server is not configured correctly or some other error occurs and the email message cannot be sent, the SendMailError function is called. メッセージがユーザーに表示されます。A message is displayed to the user. さらに、イベントは、既に MySamplesSite をという名前をイベント ソースが存在することを想定して Windows アプリケーション イベント ログに記録されます。In addition, an event is logged to the Windows Application event log with the assumption that an event source named MySamplesSite already exists. 指定したイベント ソースを作成する次のコード例を参照してください。See the code example below to create the specified event source. イベント ソースの作成の詳細については、次を参照してください。サーバーで ASP.NET Web フォーム ページのイベントの処理します。For more information about creating an event source, see Server Event Handling in ASP.NET Web Forms Pages. Handledのプロパティ、SendMailErrorEventArgsにオブジェクトが設定されているtrueをエラーが処理されたことを示します。The Handled property of the SendMailErrorEventArgs object is set to true to indicate that the error has been handled.

<%@ Page Language="C#" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void MySendingMail(object sender, MailMessageEventArgs e)
  {
    Message1.Text = "Sent mail to you to confirm the password change.";
  }

  void MySendMailError(object sender, SendMailErrorEventArgs e)
  {
    Message1.Text = "Could not send email to confirm password change.";

    // The MySamplesSite event source has already been created by an administrator.
    System.Diagnostics.EventLog myLog = new System.Diagnostics.EventLog();
    myLog.Log = "Application";
    myLog.Source = "MySamplesSite";
    myLog.WriteEntry(
        "Sending mail via SMTP failed with the following error: " + 
        e.Exception.Message.ToString(), 
        System.Diagnostics.EventLogEntryType.Error);

    e.Handled = true;
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
  <title>ChangePassword including a SendMailError Event</title>
</head>
<body>
  <form id="form1" runat="server">
  <div style="text-align:center">

    <h1>ChangePassword</h1>
    
    <asp:LoginView ID="LoginView1" Runat="server" 
      Visible="true">
      <LoggedInTemplate>
        <asp:LoginName ID="LoginName1" Runat="server" FormatString="You are logged in as {0}." />
        <br />
      </LoggedInTemplate>
      <AnonymousTemplate>
        You are not logged in
      </AnonymousTemplate>
    </asp:LoginView><br />
    
    <asp:ChangePassword ID="ChangePassword1" Runat="server"
      BorderStyle="Solid" 
      BorderWidth="1" 
      CancelDestinationPageUrl="~/Default.aspx" 
      DisplayUserName="true"
      OnSendingMail="MySendingMail" 
      OnSendMailError="MySendMailError" 
      ContinueDestinationPageUrl="~/Default.aspx" >
      <MailDefinition 
        BodyFileName="~\MailFiles\ChangePasswordMail.htm" 
        Subject="Activity information for you">
        <EmbeddedObjects>
          <asp:EmbeddedMailObject Name="LoginGif" Path="~\MailFiles\Login.gif" />
          <asp:EmbeddedMailObject Name="PrivacyNoticeTxt" Path="~\MailFiles\PrivacyNotice.txt" />
        </EmbeddedObjects>
      </MailDefinition>
    </asp:ChangePassword><br />
  
    <asp:Label ID="Message1" Runat="server" ForeColor="Red" /><br />

    <asp:HyperLink ID="HyperLink1" Runat="server" 
      NavigateUrl="~/Default.aspx">
      Home
    </asp:HyperLink>
    
  </div>
  </form>
</body>
</html>
<%@ Page Language="VB" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  Public Sub MySendingMail(ByVal Sender As Object, ByVal e As MailMessageEventArgs)
    Message1.Text = "Sent mail to you to confirm the password change."
  End Sub

  Public Sub MySendMailError(ByVal Sender As Object, ByVal e As SendMailErrorEventArgs)
    Message1.Text = "Could not send mail to confirm the password change."
    
    ' The MySamplesSite event source has already been created by an administrator.
    Dim myLog As System.Diagnostics.EventLog
    myLog = new System.Diagnostics.EventLog
    myLog.Log = "Application"
    myLog.Source = "MySamplesSite"
    myLog.WriteEntry("Sending mail via SMTP failed with the following error: " & e.Exception.Message.ToString(), System.Diagnostics.EventLogEntryType.Error)

    e.Handled = True
    
  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
  <title>ChangePassword including a SendMailError Event</title>
</head>
<body>
  <form id="form1" runat="server">
  <div style="text-align:center">

    <h1>ChangePassword</h1>
    
    <asp:LoginView ID="LoginView1" Runat="server" 
      Visible="true">
      <LoggedInTemplate>
        <asp:LoginName ID="LoginName1" Runat="server" FormatString="You are logged in as {0}." />
        <br />
      </LoggedInTemplate>
      <AnonymousTemplate>
        You are not logged in
      </AnonymousTemplate>
    </asp:LoginView><br />
    
    <asp:ChangePassword ID="ChangePassword1" Runat="server"
      BorderStyle="Solid" 
      BorderWidth="1" 
      CancelDestinationPageUrl="~/Default.aspx" 
      DisplayUserName="true"
      OnSendingMail="MySendingMail" 
      OnSendMailError="MySendMailError" 
      ContinueDestinationPageUrl="~/Default.aspx" >
      <MailDefinition 
        BodyFileName="~\MailFiles\ChangePasswordMail.htm" 
        Subject="Activity information for you">
        <EmbeddedObjects>
          <asp:EmbeddedMailObject Name="LoginGif" Path="~\MailFiles\Login.gif" />
          <asp:EmbeddedMailObject Name="PrivacyNoticeTxt" Path="~\MailFiles\PrivacyNotice.txt" />
        </EmbeddedObjects>
      </MailDefinition>
    </asp:ChangePassword><br />
  
    <asp:Label ID="Message1" Runat="server" ForeColor="Red" /><br />

    <asp:HyperLink ID="HyperLink1" Runat="server" 
      NavigateUrl="~/Default.aspx">
      Home
    </asp:HyperLink>
    
  </div>
  </form>
</body>
</html>

MySamplesSite をという名前のアプリケーション ログにイベント ソースをプログラムで追加する必要がある場合は、次のコード例を使用します。Use the following code example if you need to programmatically add the event source named MySamplesSite to your Application log. このイベント ソースは、最初のコード例が正常に動作するために存在する必要があります。This event source must exist in order for the first code example to work correctly. 次のコード例では、管理者特権が必要です。The following code example requires Administrator privileges.

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Diagnostics;

#endregion

namespace CreateEventSource
{
    class Program
    {
        static void Main(string[] args)
        {

            try
            {
                // Create the source, if it does not already exist.
                if (!EventLog.SourceExists("MySamplesSite"))
                {
                    EventLog.CreateEventSource("MySamplesSite", "Application");
                    Console.WriteLine("Creating Event Source");
                }

                // Create an EventLog instance and assign its source.
                EventLog myLog = new EventLog();
                myLog.Source = "MySamplesSite";

                // Write an informational entry to the event log.    
                myLog.WriteEntry("Testing writing to event log.");

                Console.WriteLine("Message written to event log.");
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception:");
                Console.WriteLine("{0}", e.ToString());
            }
        }
    }
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Diagnostics


Namespace CreateEventSource
  Class Program
    Sub Main()

        Try
            ' Create the source, if it does not already exist.
            If Not (EventLog.SourceExists("MySamplesSite")) Then
                EventLog.CreateEventSource("MySamplesSite", "Application")
                Console.WriteLine("Creating Event Source")
            End If

            ' Create an EventLog instance and assign its source.
            Dim myLog As New EventLog
            myLog.Source = "MySamplesSite"

            ' Write an informational entry to the event log.
            myLog.WriteEntry("Testing writing to event log.")

            Console.WriteLine("Message written to event log.")
        Catch e As Exception
            Console.WriteLine("Exception:")
            Console.WriteLine(e.ToString)
        End Try

    End Sub
  End Class
End Namespace

注釈

Handledプロパティを示す場合、Exceptionが処理されました。The Handled property indicates if the Exception has been handled. 電子メール メッセージを送信できない場合、SMTP メール プロバイダーによって例外がスローされます、ChangePasswordコントロールまたはCreateUserWizardします。The exception is raised by the SMTP mail provider when an email message cannot be sent by the ChangePassword control or the CreateUserWizard. 例外の最も一般的な理由で構成エラー、 <smtp>要素 (ネットワーク設定)のマシン構成ファイル。The most common reason for the exception is a configuration error in the <smtp> Element (Network Settings) of the machine configuration file. ようなエラーが、通常は、開発中に発見し、アプリケーションのデバッグ、メール サーバーできます失敗が予期せず、運用環境でし、アプリケーション全体にそのような状況で失敗するかどうかを判断する必要があります。Although an error like this is typically discovered during the development and debugging of an application, mail servers can fail unexpectedly in a production environment, and you must determine whether you want the entire application to fail in that situation. ない場合は、続行する、アプリケーションは、イベントを処理します。If not, handling the event allows your application to proceed.

イベント ハンドラーを作成しない場合、SendMailErrorイベント、または元のまま残りますイベント ハンドラーを作成する場合、Handledプロパティに設定falseWeb アプリケーションは、電子メール メッセージを送信するときにエラーが発生した場合に実行を停止し、ASP.NET は、エラー メッセージが表示されます。If you do not create an event handler for the SendMailError event, or if you create an event handler but leave the Handled property set to false, your Web application will stop running if an error occurs when sending an email message, and ASP.NET will display an error message. 例外が発生した場合でも実行を継続する Web アプリケーションをイベントを処理できます。Handling the event allows your Web application to continue to run even though an exception has occurred. これは、機能は、電子メール メッセージを送信する重大でない場合に便利です。This is useful when it is not critical to send an email message. たとえば、ユーザーは、マルチ ステップのウィザードを実行するときに、例外が発生した場合、エラーを記録をユーザーに情報メッセージを表示し、ウィザードを完了できるようにすると便利なができます。For example, if the exception occurs when a user is working through a multi-step wizard, it can be advantageous to log the error, display an informative message to the user, and allow the user to complete the wizard.

適用対象

こちらもご覧ください