Export (0) Print
Expand All

SoapMessage Class

Represents the data in a SOAP request or SOAP response at a specific SoapMessageStage.

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

[<AbstractClass>]
[<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")>]
type SoapMessage =  class end

The SoapMessage type exposes the following members.

  NameDescription
Public propertyActionWhen overridden in a derived class, gets the SOAPAction HTTP request header field for the SOAP request or SOAP response.
Public propertyContentEncodingGets or sets the contents of the Content-Encoding HTTP header.
Public propertyContentTypeGets or sets the HTTP Content-Type of the SOAP request or SOAP response.
Public propertyExceptionGets the SoapException from the call to the XML Web service method.
Public propertyHeadersA collection of the SOAP headers applied to the current SOAP request or SOAP response.
Public propertyMethodInfoWhen overridden in a derived class, gets a representation of the method prototype for the XML Web service method for which the SOAP request is intended.
Public propertyOneWayGets a value indicating the SoapDocumentMethodAttribute.OneWay property of either the SoapDocumentMethodAttribute or the SoapRpcMethodAttribute attribute applied to the XML Web service method.
Public propertySoapVersionGets the version of the SOAP protocol used to communicate with the XML Web service.
Public propertyStageGets the SoapMessageStage of the SoapMessage.
Public propertyStreamGets the data representing the SOAP request or SOAP response in the form of a Stream.
Public propertyUrlWhen overridden in a derived class, gets the base URL of the XML Web service.
Top

  NameDescription
Protected methodEnsureInStageWhen overridden in a derived class, asserts that the current SoapMessageStage is a stage where in parameters are available.
Protected methodEnsureOutStageWhen overridden in a derived class, asserts that the current SoapMessageStage stage is a stage where out parameters are available.
Protected methodEnsureStageEnsures that the SoapMessageStage of the call to the XML Web service method is the stage or stages passed in. If the current processing stage is not one of the stages passed in, an exception is thrown.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetInParameterValueGets the parameter passed into the XML Web service method at the specified index.
Public methodGetOutParameterValueGets the out parameter passed into the XML Web service method at the specified index.
Public methodGetReturnValueGets the return value of an XML Web service method.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The primary use of the SoapMessage class is for SOAP extensions, representing the data in a SOAP request or SOAP response. When the ProcessMessage method is called, a SoapExtension receives a SoapMessage at each SoapMessageStage. It is up to the particular SOAP extension to choose how to process the SoapMessage. Common SOAP extensions include encryption and compression.

SOAP extensions can be applied to either or both an XML Web service method created using ASP.NET or an XML Web service client. When a SOAP extension is applied to an XML Web service method, the ProcessMessage method receives an instance of SoapServerMessage, which derives from SoapMessage. Likewise, when a SOAP extension is applied to an XML Web service client, ProcessMessage receives an instance of SoapClientMessage.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft