SoapException クラス

リファレンス

定義

名前空間:: System.Web.Services.Protocols

アセンブリ:: System.Web.Services.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

XML Web サービスメソッドが SOAP 経由で呼び出され、例外が発生したときにスローされる例外を表します。

public ref class SoapException : SystemException

public class SoapException : SystemException

[System.Serializable]
public class SoapException : SystemException

type SoapException = class
    inherit SystemException

[<System.Serializable>]
type SoapException = class
    inherit SystemException

Public Class SoapException
Inherits SystemException

継承: Object

Exception

SystemException
SoapException

派生: System.Web.Services.Protocols.SoapHeaderException

属性: SerializableAttribute

例

次の例では、 SoapException をスローします。ここで、XML Web サービスメソッドによってプロパティが設定されます Detail 。

<%@ 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 サービスメソッドによってスローできます。要求に対する応答が正しく書式設定されていない場合、共通言語ランタイムはをスロー SoapException できます。 XML Web サービスメソッドは、XML Web サービスメソッド内で例外をスローするだけでを生成 SoapException できます。クライアントが SOAP 経由でメソッドにアクセスした場合、例外はサーバーでキャッチされ、新しい SoapException内にラップされます。 SoapExceptionスローされたには、次のプロパティ値があります。

プロパティ	値
Message	Message元の例外のプロパティ。
Code	ServerFaultCode.
Actor	XML Web サービスメソッドの URL。
Detail	`null`が、エラー要素に空の詳細要素が存在します。

クライアントが SOAP を使用してを呼び出すときに、XML Web サービスメソッドによってが SoapException スローされる場合があります。 XML Web サービスがをスローしたSoapException場合、別の種類の例外がスローされた場合は、XML Web サービスメソッドで設定できない、、Codeおよび Detail プロパティを介してActor他の詳細を追加できます。

コンストラクター

SoapException()	SoapException クラスの新しいインスタンスを初期化します。
SoapException(SerializationInfo, StreamingContext)	シリアル化したデータを使用して、SoapException クラスの新しいインスタンスを初期化します。
SoapException(String, XmlQualifiedName)	指定した例外メッセージと例外コードを設定して、SoapException クラスの新しいインスタンスを初期化します。
SoapException(String, XmlQualifiedName, Exception)	指定した例外メッセージ、例外コード、例外の主要原因への参照を設定して、SoapException クラスの新しいインスタンスを初期化します。
SoapException(String, XmlQualifiedName, SoapFaultSubCode)	指定した例外メッセージ、例外コード、サブコードを使用して、SoapException クラスの新しいインスタンスを初期化します。
SoapException(String, XmlQualifiedName, String)	指定した例外メッセージ、例外コード、例外の原因となったコードの一部を特定する URI を設定して、SoapException クラスの新しいインスタンスを初期化します。
SoapException(String, XmlQualifiedName, String, Exception)	指定した例外メッセージ、例外コード、例外の原因となったコードを特定する URI、例外の主要原因への参照を設定して、SoapException クラスの新しいインスタンスを初期化します。
SoapException(String, XmlQualifiedName, String, String, String, XmlNode, SoapFaultSubCode, Exception)	次を使用して、SoapException クラスの新しいインスタンスを初期化します。指定した例外メッセージ、例外コード、例外の原因となったコードの一部を識別する URI、SOAP メッセージを処理中の XML Web サービス機能を表す URI、人間の言語に関連付けられたメッセージ、アプリケーション固有の例外情報、SOAP エラーのサブコード、および例外の根本原因への参照。
SoapException(String, XmlQualifiedName, String, String, XmlNode, SoapFaultSubCode, Exception)	次を使用して、SoapException クラスの新しいインスタンスを初期化します。指定した例外メッセージ、例外コード、例外の原因となったコードの一部を識別する URI、アプリケーション固有の例外情報、および例外の根本原因への参照。
SoapException(String, XmlQualifiedName, String, XmlNode)	指定した例外メッセージ、例外コード、例外の原因となったコードの一部を特定する URI、アプリケーション固有の例外情報を設定して、SoapException クラスの新しいインスタンスを初期化します。
SoapException(String, XmlQualifiedName, String, XmlNode, Exception)	次を使用して、SoapException クラスの新しいインスタンスを初期化します。指定した例外メッセージ、例外コード、例外の原因となったコードの一部を識別する URI、アプリケーション固有の例外情報、および例外の根本原因への参照。

フィールド

ClientFaultCode	クライアントによる呼び出しの書式が正しく設定されていないこと、またはクライアントによる呼び出しに適切な情報が含まれていないことを表す SOAP 違反コードを指定します。
DetailElementName	SOAP 違反コードの XmlQualifiedName 要素を表す Detail を取得します。
MustUnderstandFaultCode	`MustUnderstand` 属性でマークされている SOAP 要素を表す SOAP 違反コードが処理されませんでした。
ServerFaultCode	クライアントによる呼び出しをサーバーで処理しているときに、メッセージの内容以外の原因により発生したエラーを表す SOAP 違反コードを指定します。
VersionMismatchFaultCode	SOAP エンベロープに対して無効な名前空間を表す SOAP 違反コードが、SOAP メッセージの処理中に見つかりました。

プロパティ

Actor	例外の原因となったコードの一部を取得します。
Code	SOAP 違反コードの種類を取得します。
Data	例外に関する追加のユーザー定義情報を提供する、キーと値のペアのコレクションを取得します。 (継承元 Exception)
Detail	アプリケーション固有のエラー情報を表す XmlNode を取得します。
HelpLink	この例外に関連付けられているヘルプファイルへのリンクを取得または設定します。 (継承元 Exception)
HResult	特定の例外に割り当てられているコード化数値である HRESULT を取得または設定します。 (継承元 Exception)
InnerException	現在の例外の原因となる Exception インスタンスを取得します。 (継承元 Exception)
Lang	例外に関連付けられている言語を取得します。
Message	現在の例外を説明するメッセージを取得します。 (継承元 Exception)
Node	例外の原因となったコードの一部を表す URI を取得します。
Role	SOAP メッセージの処理での XML Web サービスの関数を表す URL を取得します。
Source	エラーの原因となるアプリケーションまたはオブジェクトの名前を取得または設定します。 (継承元 Exception)
StackTrace	呼び出し履歴で直前のフレームの文字列形式を取得します。 (継承元 Exception)
SubCode	SOAP エラーの `subcode` XML 要素に含まれるオプションのエラー情報を取得します。
TargetSite	現在の例外がスローされたメソッドを取得します。 (継承元 Exception)

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetBaseException()	派生クラスでオーバーライドされた場合、それ以後に発生する 1 つ以上の例外の根本原因である Exception を返します。 (継承元 Exception)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetObjectData(SerializationInfo, StreamingContext)	例外に関する情報を含む SerializationInfo を設定します。
GetObjectData(SerializationInfo, StreamingContext)	古い. 派生クラスでオーバーライドされた場合は、その例外に関する情報を使用して SerializationInfo を設定します。 (継承元 Exception)
GetType()	現在のインスタンスのランタイム型を取得します。 (継承元 Exception)
IsClientFaultCode(XmlQualifiedName)	使用している SOAP プロトコルのバージョンに関係なく、SOAP 違反コードが `Client` SOAP 違反コードと等価であるかどうかを示す値を返します。
IsMustUnderstandFaultCode(XmlQualifiedName)	使用している SOAP プロトコルのバージョンに関係なく、SOAP 違反コードが `MustUnderstand` と等価であるかどうかを示す値を返します。
IsServerFaultCode(XmlQualifiedName)	使用している SOAP プロトコルのバージョンに関係なく、SOAP 違反コードが `Server` SOAP 違反コードと等価であるかどうかを示す値を返します。
IsVersionMismatchFaultCode(XmlQualifiedName)	使用している SOAP プロトコルのバージョンに関係なく、SOAP 違反コードが `VersionMismatch` SOAP 違反コードと等価であるかどうかを示す値を返します。
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在の例外の文字列形式を作成して返します。 (継承元 Exception)

イベント

SerializeObjectState

古い.

例外がシリアル化され、例外に関するシリアル化されたデータを含む例外状態オブジェクトが作成されたときに発生します。

(継承元 Exception)

適用対象