SoapException.Detail プロパティとは何？わかりやすく解説 Weblio辞書

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

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

SoapException.Detail プロパティ

アプリケーション固有のエラー情報を表す XmlNode を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 Detail As XmlNode

Visual Basic (使用法)

Dim instance As SoapException
Dim value As XmlNode

value = instance.Detail

public XmlNode Detail { get; }

C++

public:
property XmlNode^ Detail {
    XmlNode^ get ();
}

/** @property */
public XmlNode get_Detail ()

JScript

public function get Detail
 () : XmlNode

プロパティ値
アプリケーション固有のエラー情報。

解説

Detail プロパティは、Detail 値を受け入れるクラスコンストラクタの 1 つを使用して設定できます。

Detail プロパティを使用して、SOAP 要求の Body 要素に関連している、アプリケーション固有のエラー詳細を提供します。SOAP 要求の Body 要素が原因でクライアント要求を処理できないためにエラーが発生した場合は、SOAP 仕様に従い、Detail プロパティを設定する必要があります。SOAP 要求のヘッダーエントリ内でエラーが発生した場合は、SOAP ヘッダーでエラー詳細が返されるように、SoapHeaderException をスローする必要があります。Body 要素の処理が原因となるエラーが発生しなかった場合は、Detail プロパティを設定しないでください。

Detail プロパティの XmlNode を構築するときに、DetailElementName の Name プロパティと Namespace プロパティを使用すると、SOAP 仕様に確実に準拠させることができます。

詳細要素の直下の子要素は、詳細エントリと呼ばれます。各詳細エントリは、詳細要素内の独立した要素としてエンコードされています。

使用例

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

Visual Basic

<%@ 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

<%@ 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;    }
}