CustomError クラスとは何？わかりやすく解説 Weblio辞書

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

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

CustomError クラス

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

CustomError セクションを構成して ASP.NET エラーコードをカスタムページに割り当てます。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 CustomError
    Inherits ConfigurationElement

Visual Basic (使用法)

Dim instance As CustomError

public sealed class CustomError : ConfigurationElement

C++

public ref class CustomError sealed : public
 ConfigurationElement

public final class CustomError extends ConfigurationElement

JScript

public final class CustomError extends
 ConfigurationElement

解説

CustomError クラスを使用すると、構成ファイルの error セクションにプログラムからアクセスして変更できます。この型は、CustomErrorCollection、CustomErrorsMode、および CustomErrorsSection を含むグループの一部です。

メモ
カスタムエラーを定義すると、ASP.NET で、IIS などの基のサービスによって通常であれば発行される標準のエラーに、カスタムエラーが割り当てられます。たとえば、ステータスコード 404 に対してカスタムエラーを定義した場合、ASP.NET は、存在しない .aspx ページが参照されたときにこのエラーを発行します。カスタムエラーは、ASP.NET が処理できる要素に対してのみ発行されます。たとえば、存在しない .htm ページが参照された場合、IIS は標準 404 エラーを発行します。

メモ

カスタムエラーを定義すると、ASP.NET で、IIS などの基のサービスによって通常であれば発行される標準のエラーに、カスタムエラーが割り当てられます。たとえば、ステータスコード 404 に対してカスタムエラーを定義した場合、ASP.NET は、存在しない .aspx ページが参照されたときにこのエラーを発行します。カスタムエラーは、ASP.NET が処理できる要素に対してのみ発行されます。たとえば、存在しない .htm ページが参照された場合、IIS は標準 404 エラーを発行します。

使用例

この例では、customErrors セクションの複数の属性に対して、宣言によって値を指定する方法を示しています。これらの属性には、CustomError クラスのメンバとしてもアクセスできます。

次の構成ファイルの例では、customErrors セクションに対して、宣言によって値を指定する方法を示しています。

<customErrors mode="RemoteOnly"
  defaultRedirect="customerror.htm">
    <error statusCode="404" redirect="customerror404.htm"/>
</customErrors>

CustomError クラスを使用する方法を次のコード例に示します。

Visual Basic

' Get the Web application configuration.
  Dim configuration _
  As System.Configuration.Configuration = _
  WebConfigurationManager.OpenWebConfiguration( _
  "/aspnetTest")

' Get the section.
  Dim customErrors As CustomErrorsSection =
 _
   CType(configuration.GetSection( _
   "system.web/customErrors"), CustomErrorsSection)

' Get the collection.
  Dim customErrorsCollection _
  As CustomErrorCollection = _
  customErrors.Errors

// Get the Web application configuration.
Configuration configuration =
    WebConfigurationManager.OpenWebConfiguration(
    "/aspnetTest");

// Get the section.
CustomErrorsSection customErrors =
    (CustomErrorsSection)configuration.GetSection(
  "system.web/customErrors");

// Get the collection.
CustomErrorCollection customErrorsCollection =
    customErrors.Errors;