SoapHeaderAttribute-Konstruktor

Initialisiert eine neue Instanz der SoapHeaderAttribute-Klasse, wobei der Member der XML-Webdienstklasse festgelegt wird, die den Inhalt des SOAP-Headers darstellt.

Namespace: System.Web.Services.Protocols
Assembly: System.Web.Services (in system.web.services.dll)

Syntax

'Declaration
Public Sub New ( _
    memberName As String _
)
'Usage
Dim memberName As String

Dim instance As New SoapHeaderAttribute(memberName)

public SoapHeaderAttribute (
    string memberName
)

public:
SoapHeaderAttribute (
    String^ memberName
)

public SoapHeaderAttribute (
    String memberName
)

public function SoapHeaderAttribute (
    memberName : String
)

Parameter

• memberName
  Der Member der XML-Webdienstklasse, die den Inhalt des SOAP-Headers darstellt. Die MemberName-Eigenschaft wird auf den Wert dieses Parameters festgelegt.

Hinweise

Ein XML-Webdienstclient bzw. XML-Webdienst kann die für bestimmte XML-Webdienstmethoden zu verarbeitenden SOAP-Header angeben, indem er ein SoapHeaderAttribute auf die XML-Webdienstmethode in der XML-Webdienstklasse oder die entsprechende Methode der Proxyklasse anwendet. Damit die XML-Webdienstmethode den Inhalt des SOAP-Headers empfängt, wird der XML-Webdienstklasse eines von SoapHeader abgeleiteten Type ein Member hinzugefügt. Ähnlich fügt ein XML-Webdienstclient einen Member der Proxyklasse hinzu, die von SoapHeader abgeleitet ist. Der von SoapHeader abgeleitete Type stellt den Inhalt des SOAP-Headers dar und wird vom Entwickler des XML-Webdiensts bzw. des XML-Webdienstclients erstellt, der den SOAP-Header empfangen soll. Sobald die Klasse erstellt wurde, kann ein SoapHeaderAttribute auf die XML-Webdienstmethode oder die entsprechende Methode in der Proxyklasse des XML-Webdienstclients angewendet werden, die den Member für den Empfang des Inhalts des SOAP-Headers mit dem memberName-Parameter für diesen Konstruktor oder der MemberName-Eigenschaft angibt.

Eine XML-Webdienstmethode kann mehrere SOAP-Header empfangen, indem der XML-Webdienstklasse oder der Proxyklasse des XML-Webdiensts mehrere Member hinzugefügt werden und wiederum mehrere SoapHeaderAttribute-Attribute auf die XML-Webdienstmethode angewendet werden.

Um beim Schreiben des XML-Webdiensts unbekannte SOAP-Header zu empfangen bzw. zu verarbeiten, geben Sie als Type des Members SoapUnknownHeader, SoapHeader oder ein Array beider Klassen an.

Beispiel

Der folgende MyWebService-XML-Webdienst definiert einen SoapHeader vom Typ MyHeader. Die Hello-XML-Webdienstmethode gibt den myHeader-Member als MemberName-Eigenschaft für den Empfang des Inhalts von MyHeader-SOAP-Headern an, die an die XML-Webdienstmethode übergeben werden.

Imports System
Imports System.Web.Services
Imports System.Web.Services.Protocols

' Define a SOAP header by deriving from the SoapHeader base class.
' The header contains just one string value.
Public Class MyHeader
   Inherits SoapHeader
   Public MyValue As String
End Class 'MyHeader


Public Class MyWebService
   ' Member variable to receive the contents of the MyHeader SOAP header.
   Public myHeader As MyHeader

   
   <WebMethod, _ 
    SoapHeader("myHeader", Direction := SoapHeaderDirection.InOut)> _
   Public Sub Hello()

   End Sub 'Hello
End Class 'MyWebService

using System;
using System.Web.Services;
using System.Web.Services.Protocols;

// Define a SOAP header by deriving from the SoapHeader base class.
// The header contains just one string value.
public class MyHeader : SoapHeader {
    public string MyValue;
}

public class MyWebService {
    // Member variable to receive the contents of the MyHeader SOAP header.
    public MyHeader myHeader;
 
    [WebMethod]
    [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)]
    public void Hello() {
    
    }
}

#using <System.EnterpriseServices.dll>
#using <System.Web.Services.dll>

using namespace System;
using namespace System::Web::Services;
using namespace System::Web::Services::Protocols;

// Define a SOAP header by deriving from the SoapHeader base class.
// The header contains just one string value.
public ref class MyHeader: public SoapHeader
{
public:
   String^ MyValue;
};

public ref class MyWebService
{
public:

   // Member variable to receive the contents of the MyHeader SOAP header.
   MyHeader^ myHeader;

   [WebMethod]
   [SoapHeader("myHeader",Direction=SoapHeaderDirection::InOut)]
   void Hello(){}

};

import System.*;
import System.Web.Services.*;
import System.Web.Services.Protocols.*;

// Define a SOAP header by deriving from the SoapHeader base class.
// The header contains just one string value.
public class MyHeader extends SoapHeader
{
    public String myValue;
} //MyHeader

public class MyWebService
{
    // Member variable to receive the contents of the MyHeader SOAP header.
    public MyHeader myHeader;

    /** @attribute WebMethod()
     */
    /** @attribute SoapHeader("myHeader", Direction = SoapHeaderDirection.InOut)
     */

    public void Hello()
    {
    } //Hello
} //MyWebService

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

SoapHeaderAttribute-Klasse
SoapHeaderAttribute-Member
System.Web.Services.Protocols-Namespace