Message.GetBody Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the body of this Message instance.
Overloads
| GetBody<T>() |
Retrieves the body of this Message instance. |
| GetBody<T>(XmlObjectSerializer) |
Retrieves the body of this Message using the specified serializer. |
Examples
The following code example shows a client that uses the channel factory to send a message and read the reply.
using System;
using System.Collections.Generic;
using System.Text;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.Runtime.Serialization;
namespace ConsoleApplication1
{
class client
{
static void RunClient()
{
//Step1: create a binding with just HTTP
CustomBinding binding = new CustomBinding();
binding.Elements.Add(new HttpTransportBindingElement());
//Step2: use the binding to build the channel factory
IChannelFactory<IRequestChannel> factory =
binding.BuildChannelFactory<IRequestChannel>(
new BindingParameterCollection());
//open the channel factory
factory.Open();
//Step3: use the channel factory to create a channel
IRequestChannel channel = factory.CreateChannel(
new EndpointAddress("http://localhost:8080/channelapp"));
channel.Open();
//Step4: create a message
Message requestmessage = Message.CreateMessage(
MessageVersion.Soap12WSAddressing10,
"http://contoso.com/someaction",
"This is the body data");
//send message
Message replymessage = channel.Request(requestmessage);
Console.WriteLine("Reply message received");
Console.WriteLine("Reply action: {0}",
replymessage.Headers.Action);
string data = replymessage.GetBody<string>();
Console.WriteLine("Reply content: {0}", data);
//Step5: don't forget to close the message
requestmessage.Close();
replymessage.Close();
//don't forget to close the channel
channel.Close();
//don't forget to close the factory
factory.Close();
}
public static void Main()
{
Console.WriteLine("Press [ENTER] when service is ready");
Console.ReadLine();
RunClient();
Console.WriteLine("Press [ENTER] to exit");
Console.ReadLine();
}
}
}
Imports System.Collections.Generic
Imports System.Text
Imports System.ServiceModel
Imports System.ServiceModel.Channels
Imports System.Runtime.Serialization
Namespace ConsoleApplication1
Friend Class client
Private Shared Sub RunClient()
'Step1: create a binding with just HTTP
Dim binding As New CustomBinding()
binding.Elements.Add(New HttpTransportBindingElement())
'Step2: use the binding to build the channel factory
Dim factory As IChannelFactory(Of IRequestChannel) = binding.BuildChannelFactory(Of IRequestChannel)(New BindingParameterCollection())
'open the channel factory
factory.Open()
'Step3: use the channel factory to create a channel
Dim channel As IRequestChannel = factory.CreateChannel(New EndpointAddress("http://localhost:8080/channelapp"))
channel.Open()
'Step4: create a message
Dim requestmessage As Message = Message.CreateMessage(MessageVersion.Soap12WSAddressing10, "http://contoso.com/someaction", "This is the body data")
'send message
Dim replymessage As Message = channel.Request(requestmessage)
Console.WriteLine("Reply message received")
Console.WriteLine("Reply action: {0}", replymessage.Headers.Action)
Dim data = replymessage.GetBody(Of String)()
Console.WriteLine("Reply content: {0}", data)
'Step5: don't forget to close the message
requestmessage.Close()
replymessage.Close()
'don't forget to close the channel
channel.Close()
'don't forget to close the factory
factory.Close()
End Sub
Public Shared Sub Main()
Console.WriteLine("Press [ENTER] when service is ready")
Console.ReadLine()
RunClient()
Console.WriteLine("Press [ENTER] to exit")
Console.ReadLine()
End Sub
End Class
End Namespace
Remarks
After a message is created, the message body can be read using the GetBody methods on the returned message. The returned object encapsulates all the child elements within the Body element. Because the body of a message is a stream, it can only be written once, or read once.
Use the GetBody<T>(XmlObjectSerializer) overload when working with JSON messages; the GetBody<T>() overload does not work.
GetBody<T>()
- Source:
- Message.cs
- Source:
- Message.cs
Retrieves the body of this Message instance.
public:
generic <typename T>
T GetBody();public T GetBody<T> ();member this.GetBody : unit -> 'TPublic Function GetBody(Of T) () As TType Parameters
- T
The body of the message.
Returns
An object of type T that contains the body of this message.
Remarks
A Message instance has a body that corresponds to the SOAP body. It can be accessed as an XmlDictionaryReader by calling GetReaderAtBodyContents. It is initially positioned directly after the <S:Body> element, and it returns EOF on reaching the </S:Body> element. Alternatively, if you expect the body to contain a serialized object, you can call GetBody instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the Body multiple times, use CreateBufferedCopy to create a MessageBuffer instance.
Use the GetBody<T>(XmlObjectSerializer) overload when working with JSON messages; the GetBody<T>() overload does not work.
Applies to
GetBody<T>(XmlObjectSerializer)
- Source:
- Message.cs
- Source:
- Message.cs
Retrieves the body of this Message using the specified serializer.
public:
generic <typename T>
T GetBody(System::Runtime::Serialization::XmlObjectSerializer ^ serializer);public T GetBody<T> (System.Runtime.Serialization.XmlObjectSerializer serializer);member this.GetBody : System.Runtime.Serialization.XmlObjectSerializer -> 'TPublic Function GetBody(Of T) (serializer As XmlObjectSerializer) As TType Parameters
- T
The body of the message.
Parameters
- serializer
- XmlObjectSerializer
A XmlObjectSerializer object used to read the body of the message.
Returns
An object of type T that contains the body of this message.
Exceptions
serializer is null.
Remarks
A Message instance has a body that corresponds to the SOAP body. It can be accessed as an XmlDictionaryReader by calling GetReaderAtBodyContents. It is initially positioned directly after the <S:Body> element, and it returns EOF on reaching the </S:Body> element. Alternatively, if you expect the body to contain a serialized object, you can call GetBody instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the body multiple times, use CreateBufferedCopy to create a MessageBuffer instance.
Use the GetBody<T>(XmlObjectSerializer) overload when working with JSON messages; the GetBody<T>() overload does not work.
