SoapException クラス

定義

XML Web サービス メソッドが SOAP 経由で呼び出され、例外が発生したときにスローされる例外を表します。Represents the exception that is thrown when an XML Web service method is called over SOAP and an exception occurs.

public ref class SoapException : SystemException
public class SoapException : SystemException
[System.Serializable]
public class SoapException : SystemException
type SoapException = class
    inherit SystemException
Public Class SoapException
Inherits SystemException
継承
派生
属性

次の例では、XML Web サービスメソッドが Detail プロパティを設定する SoapException をスローします。The following example throws a SoapException where the XML Web service method sets the Detail property.

<%@ WebService Language="C#" class="ThrowSoapException"%>

using System;
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Xml.Serialization;
using System.Xml;

public class ThrowSoapException : WebService 
{
//    This XML Web service method generates a SOAP Client Fault code 
    [WebMethod]
    public void myThrow(){

        // Build the detail element of the SOAP fault.
        System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
        System.Xml.XmlNode node = doc.CreateNode(XmlNodeType.Element, SoapException.DetailElementName.Name, SoapException.DetailElementName.Namespace);


        // Build specific details for the SoapException.
        // Add first child of detail XML element.
        System.Xml.XmlNode details = doc.CreateNode(XmlNodeType.Element, "mySpecialInfo1", "http://tempuri.org/");
        System.Xml.XmlNode detailsChild = doc.CreateNode(XmlNodeType.Element, "childOfSpecialInfo", "http://tempuri.org/");
        details.AppendChild(detailsChild);

            
        // Add second child of detail XML element with an attribute.
        System.Xml.XmlNode details2 = doc.CreateNode(XmlNodeType.Element, "mySpecialInfo2", "http://tempuri.org/");
        XmlAttribute attr = doc.CreateAttribute("t", "attrName", "http://tempuri.org/");
        attr.Value = "attrValue";
        details2.Attributes.Append(attr);

        // Append the two child elements to the detail node.
        node.AppendChild(details);
        node.AppendChild(details2);

            
        //Throw the exception.    
        SoapException se = new SoapException("Fault occurred", SoapException.ClientFaultCode,Context.Request.Url.AbsoluteUri,node);

        throw se;
        return;    }
}
<%@ WebService Language="VB" class="ThrowSoapException"%>

Imports System
Imports System.Web.Services
Imports System.Web.Services.Protocols
Imports System.Xml.Serialization
Imports System.Xml

Public Class ThrowSoapException
    Inherits WebService
    
    ' This XML Web service method generates a SOAP Client Fault code 
    <WebMethod()> _
    Public Sub myThrow()
        
        ' Build the detail element of the SOAP fault.
        Dim doc As New System.Xml.XmlDocument()
        Dim node As System.Xml.XmlNode = doc.CreateNode(XmlNodeType.Element, _
            SoapException.DetailElementName.Name, _
            SoapException.DetailElementName.Namespace)
 
        ' Build specific details for the SoapException.
        ' Add first child of detail XML element.
        Dim details As System.Xml.XmlNode = doc.CreateNode(XmlNodeType.Element, _
            "mySpecialInfo1", "http://tempuri.org/")

        ' Add second child of detail XML element with an attribute.
        Dim details2 As System.Xml.XmlNode = doc.CreateNode(XmlNodeType.Element, _
            "mySpecialInfo2", "http://tempuri.org/")
        Dim attr As XmlAttribute = doc.CreateAttribute("t", "attrName", _
            "http://tempuri.org/")
        attr.Value = "attrValue"
        details2.Attributes.Append(attr)

        ' Append the two child elements to the detail node.
        node.AppendChild(details)
        node.AppendChild(details2)
                
        'Throw the exception    
        Dim se As New SoapException("Fault occurred", SoapException.ClientFaultCode, _
                                    Context.Request.Url.AbsoluteUri, node)
        Throw se
        Return
    End Sub
End Class

注釈

SoapException は、共通言語ランタイムまたは XML Web サービスメソッドによってスローされます。The SoapException can either be thrown by the common language runtime or by an XML Web service method. 要求への応答が正しく書式設定されていない場合、共通言語ランタイムは SoapException をスローすることがあります。The common language runtime can throw a SoapException if a response to a request is not formatted correctly. Xml Web サービスメソッドでは、XML Web サービスメソッド内で例外をスローするだけで、SoapException を生成できます。XML Web service methods can generate a SoapException by simply throwing an exception within the XML Web service method. クライアントが SOAP 経由でメソッドにアクセスした場合、例外はサーバー上でキャッチされ、新しい SoapException内にラップされます。If the client accessed the method over SOAP, the exception is caught on the server and wrapped inside a new SoapException. スローされる SoapException には、次のプロパティ値があります。The SoapException thrown has the following property values:

プロパティProperty [値]Value
Message 元の例外の Message プロパティ。The Message property of the original exception.
Code ServerFaultCodeServerFaultCode.
Actor XML Web サービスメソッドの URL。The URL of the XML Web service method.
Detail null。ただし、fault 要素には空の detail 要素が存在します。null, but an empty detail element is present in the fault element.

クライアントが SOAP を使用してを呼び出すと、XML Web サービスメソッドが SoapException をスローすることがあります。An XML Web service method might throw a SoapException when clients call using SOAP. XML Web サービスが SoapExceptionをスローする場合、他の種類の例外がスローされた場合に XML Web サービスメソッドによって設定できない ActorCode、および Detail プロパティを使用して、その他の詳細を追加できます。If an XML Web service throws the SoapException, other details can be added through the Actor, Code and Detail properties that cannot otherwise be set by an XML Web service method if another type of exception is thrown.

コンストラクター

SoapException()

SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class.

SoapException(SerializationInfo, StreamingContext)

シリアル化したデータを使用して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with serialized data.

SoapException(String, XmlQualifiedName)

指定した例外メッセージと例外コードを設定して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with the specified exception message and exception code.

SoapException(String, XmlQualifiedName, Exception)

指定した例外メッセージ、例外コード、例外の主要原因への参照を設定して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with the specified exception message, exception code, and reference to the root cause of the exception.

SoapException(String, XmlQualifiedName, SoapFaultSubCode)

指定した例外メッセージ、例外コード、およびサブコードを設定して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with the specified exception message, exception code, and subcode.

SoapException(String, XmlQualifiedName, String)

指定した例外メッセージ、例外コード、例外の原因となったコードの一部を特定する URI を設定して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with the specified exception message, exception code, and URI that identifies the piece of code that caused the exception.

SoapException(String, XmlQualifiedName, String, Exception)

指定した例外メッセージ、例外コード、例外の原因となったコードを特定する URI、例外の主要原因への参照を設定して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the code that caused the exception, and reference to the root cause of the exception.

SoapException(String, XmlQualifiedName, String, String, String, XmlNode, SoapFaultSubCode, Exception)

次を使用して、SoapException クラスの新しいインスタンスを初期化します。指定した例外メッセージ、例外コード、例外の原因となったコードの一部を識別する URI、SOAP メッセージを処理中の XML Web サービス機能を表す URI、人間の言語に関連付けられたメッセージ、アプリケーション固有の例外情報、SOAP エラーのサブコード、および例外の根本原因への参照。Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, URI that represents the XML Web service's function in processing the SOAP message, the human language associated with the exception, the application-specific exception information, the subcode for the SOAP fault and reference to the root cause of the exception.

SoapException(String, XmlQualifiedName, String, String, XmlNode, SoapFaultSubCode, Exception)

指定した例外メッセージ、例外コード、例外の原因となったコードの一部を特定する URI、アプリケーション固有の例外情報、例外の主要原因への参照を設定して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, application-specific exception information, and reference to the root cause of the exception.

SoapException(String, XmlQualifiedName, String, XmlNode)

指定した例外メッセージ、例外コード、例外の原因となったコードの一部を特定する URI、アプリケーション固有の例外情報を設定して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, and application specific exception information.

SoapException(String, XmlQualifiedName, String, XmlNode, Exception)

指定した例外メッセージ、例外コード、例外の原因となったコードの一部を特定する URI、アプリケーション固有の例外情報、例外の主要原因への参照を設定して、SoapException クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, application-specific exception information, and reference to the root cause of the exception.

フィールド

ClientFaultCode

クライアントによる呼び出しの書式が正しく設定されていないこと、またはクライアントによる呼び出しに適切な情報が含まれていないことを表す SOAP 違反コードを指定します。Specifies a SOAP fault code that represents a client call that is not formatted correctly or does not contain the appropriate information.

DetailElementName

SOAP 違反コードの XmlQualifiedName 要素を表す Detail を取得します。Gets an XmlQualifiedName that represents the Detail element of a SOAP Fault code.

MustUnderstandFaultCode

MustUnderstand 属性でマークされている SOAP 要素を表す SOAP 違反コードが処理されませんでした。A SOAP Fault Code that represents a SOAP element marked with the MustUnderstand attribute was not processed.

ServerFaultCode

クライアントによる呼び出しをサーバーで処理しているときに、メッセージの内容以外の原因により発生したエラーを表す SOAP 違反コードを指定します。Specifies that a SOAP fault code that represents an error occurred during the processing of a client call on the server, where the problem is not due to the message contents.

VersionMismatchFaultCode

SOAP エンベロープに対して無効な名前空間を表す SOAP 違反コードが、SOAP メッセージの処理中に見つかりました。A SOAP fault code that represents an invalid namespace for a SOAP envelope was found during the processing of the SOAP message.

プロパティ

Actor

例外の原因となったコードの一部を取得します。Gets the piece of code that caused the exception.

Code

SOAP 違反コードの種類を取得します。Gets the type of SOAP fault code.

Data

例外に関する追加のユーザー定義情報を提供する、キーと値のペアのコレクションを取得します。Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(継承元 Exception)
Detail

アプリケーション固有のエラー情報を表す XmlNode を取得します。Gets an XmlNode that represents the application-specific error information details.

HelpLink

この例外に関連付けられているヘルプ ファイルへのリンクを取得または設定します。Gets or sets a link to the help file associated with this exception.

(継承元 Exception)
HResult

特定の例外に割り当てられているコード化数値である HRESULT を取得または設定します。Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

(継承元 Exception)
InnerException

現在の例外の原因となる Exception インスタンスを取得します。Gets the Exception instance that caused the current exception.

(継承元 Exception)
Lang

例外に関連付けられている言語を取得します。Gets the human language associated with the exception.

Message

現在の例外を説明するメッセージを取得します。Gets a message that describes the current exception.

(継承元 Exception)
Node

例外の原因となったコードの一部を表す URI を取得します。Gets a URI that represents the piece of code that caused the exception.

Role

SOAP メッセージの処理での XML Web サービスの関数を表す URL を取得します。Gets a URI that represents the XML Web service's function in processing the SOAP message.

Source

エラーの原因となるアプリケーションまたはオブジェクトの名前を取得または設定します。Gets or sets the name of the application or the object that causes the error.

(継承元 Exception)
StackTrace

呼び出し履歴で直前のフレームの文字列形式を取得します。Gets a string representation of the immediate frames on the call stack.

(継承元 Exception)
SubCode

SOAP エラーの subcode XML 要素に含まれるオプションのエラー情報を取得します。Gets the optional error information contained in the subcode XML element of a SOAP fault.

TargetSite

現在の例外がスローされたメソッドを取得します。Gets the method that throws the current exception.

(継承元 Exception)

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetBaseException()

派生クラスでオーバーライドされた場合、それ以後に発生する 1 つ以上の例外の根本原因である Exception を返します。When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.

(継承元 Exception)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetObjectData(SerializationInfo, StreamingContext)

例外に関する情報を含む SerializationInfo を設定します。Sets the SerializationInfo with information about the exception.

GetType()

現在のインスタンスのランタイム型を取得します。Gets the runtime type of the current instance.

(継承元 Exception)
IsClientFaultCode(XmlQualifiedName)

使用している SOAP プロトコルのバージョンに関係なく、SOAP 違反コードが Client SOAP 違反コードと等価であるかどうかを示す値を返します。Returns a value that indicates whether the SOAP fault code is equivalent to the Client SOAP fault code regardless of the version of the SOAP protocol used.

IsMustUnderstandFaultCode(XmlQualifiedName)

使用している SOAP プロトコルのバージョンに関係なく、SOAP 違反コードが MustUnderstand と等価であるかどうかを示す値を返します。Returns a value that indicates whether the SOAP fault code is equivalent to MustUnderstand regardless of the version of the SOAP protocol used.

IsServerFaultCode(XmlQualifiedName)

使用している SOAP プロトコルのバージョンに関係なく、SOAP 違反コードが Server SOAP 違反コードと等価であるかどうかを示す値を返します。Returns a value that indicates whether the SOAP fault code is equivalent to the Server SOAP fault code regardless of the version of the SOAP protocol used.

IsVersionMismatchFaultCode(XmlQualifiedName)

使用している SOAP プロトコルのバージョンに関係なく、SOAP 違反コードが VersionMismatch SOAP 違反コードと等価であるかどうかを示す値を返します。Returns a value that indicates whether the SOAP fault code is equivalent to the VersionMismatch SOAP fault code regardless of the version of the SOAP protocol used.

MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在の例外の文字列形式を作成して返します。Creates and returns a string representation of the current exception.

(継承元 Exception)

イベント

SerializeObjectState

例外がシリアル化され、例外に関するシリアル化されたデータを含む例外状態オブジェクトが作成されたときに発生します。Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(継承元 Exception)

適用対象