SoapHeaderAttribute Kelas

Definisi

Ruang nama:

System.Web.Services.Protocols

Rakitan:

System.Web.Services.dll

Atribut ini diterapkan ke metode layanan Web XML atau klien layanan Web XML untuk menentukan header SOAP yang dapat diproses oleh metode layanan Web XML atau klien layanan Web XML. Kelas ini tidak dapat diwariskan.

public ref class SoapHeaderAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)]
public sealed class SoapHeaderAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)>]
type SoapHeaderAttribute = class
    inherit Attribute

Public NotInheritable Class SoapHeaderAttribute
Inherits Attribute

Warisan

Object

Attribute

SoapHeaderAttribute

Atribut

AttributeUsageAttribute

Contoh

Layanan Web XML berikut MyWebService mendefinisikan salah satu SoapHeader jenis MyHeader. Metode Hello layanan Web XML mengharuskan klien untuk memanggil metode layanan Web XML dengan ini SoapHeader. Layanan Hello Web XML juga menangkap header SOAP apa pun selain MyHeader.

<%@ WebService Language="C#" Class="MyWebService"%>
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 SoapHeader.
    public MyHeader myHeader;

    // Member variable to receive all headers other than MyHeader.
    public SoapUnknownHeader[] unknownHeaders;
 
    [WebMethod]
    [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)]

    // Receive any SOAP headers other than MyHeader.
    [SoapHeader("unknownHeaders")]
    public void Hello() {

       // Process the MyHeader SoapHeader.
       if (myHeader.MyValue == "Some string") {
          // Process the header.
       }
       foreach (SoapHeader header in unknownHeaders) {
           // Perform some processing on header.
           
           // For those headers that cannot be processed,
           // set the DidUnderstand property to false.
           header.DidUnderstand = false;
       }
    }
}

<%@ WebService Language="VB" Class="MyWebService"%>
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

Public Class MyWebService
    ' Member variable to receive the contents of the MyHeader SoapHeader.
    Public myHeader As MyHeader
    
    ' Member variable to receive all headers other than MyHeader.
    Public unknownHeaders() As SoapUnknownHeader
    
    ' Receive any SOAP headers other than MyHeader.
    <WebMethod, _
        SoapHeader("myHeader", Direction := SoapHeaderDirection.InOut), _
        SoapHeader("unknownHeaders")> _
    Public Sub Hello()        
        
        ' Process the MyHeader SoapHeader.
        If myHeader.MyValue = "Some string" Then
            ' Process the header.
        End If 
        Dim header As SoapHeader
        For Each header In  unknownHeaders
            ' Perform some processing on header
            ' For those headers that cannot be processed, 
            ' set the DidUnderstand to false.
            header.DidUnderstand = False
        Next header
    End Sub
End Class

Keterangan

Langkah-langkah dasar untuk menerima dan memproses header SOAP adalah:

1. Buat kelas yang berasal dari SoapHeader mewakili data yang diteruskan di header SOAP.

2. Tambahkan anggota ke kelas layanan Web XML atau kelas proksi klien layanan Web XML dari jenis yang dibuat di langkah 1.

3. Terapkan ke metode layanan Web XML atau metode yang sesuai di kelas proksi, menentukan anggota yang SoapHeaderAttribute dibuat di langkah 2 di MemberName properti .

4. Dalam metode layanan Web XML atau kode klien layanan Web XML, akses MemberName properti untuk memproses data yang dikirim di header SOAP.

Untuk detail selengkapnya, lihat MemberName properti .

Konstruktor

Nama	Deskripsi
SoapHeaderAttribute(String)	Menginisialisasi instans SoapHeaderAttribute baru kelas, mengatur anggota kelas layanan Web XML yang mewakili konten header SOAP.

Properti

Nama	Deskripsi
Direction	Mendapatkan atau mengatur apakah header SOAP ditujukan untuk layanan Web XML atau klien layanan Web XML atau keduanya.
MemberName	Mendapatkan atau mengatur anggota kelas layanan Web XML yang mewakili konten header SOAP.
Required	Kedaluwarsa. Anggota ini usang dan tidak memiliki fungsionalitas.
TypeId	Ketika diimplementasikan dalam kelas turunan, mendapatkan pengidentifikasi unik untuk Attributeini. (Diperoleh dari Attribute)

Metode

Nama	Deskripsi
Equals(Object)	Mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
GetHashCode()	Mengembalikan kode hash untuk instans ini. (Diperoleh dari Attribute)
GetType()	Mendapatkan Type instans saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Ketika ditimpa dalam kelas turunan, menunjukkan apakah nilai instans ini adalah nilai default untuk kelas turunan. (Diperoleh dari Attribute)
Match(Object)	Saat ditimpa dalam kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari Objectsaat ini. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Implementasi Antarmuka Eksplisit

Nama	Deskripsi
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Memetakan sekumpulan nama ke sekumpulan pengidentifikasi pengiriman yang sesuai. (Diperoleh dari Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Mengambil informasi jenis untuk objek, yang dapat digunakan untuk mendapatkan informasi jenis untuk antarmuka. (Diperoleh dari Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Mengambil jumlah antarmuka informasi jenis yang disediakan objek (baik 0 atau 1). (Diperoleh dari Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Menyediakan akses ke properti dan metode yang diekspos oleh objek. (Diperoleh dari Attribute)

Lihat juga

• MemberName
• SoapHeader