GetMessageBuffer Method (TransportClientEndpointBehavior, Uri, MessageVersion)

Retrieves a message buffer from the specified URI, using the specified credentials and message version.

Namespace:  Microsoft.ServiceBus
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

Syntax

'Declaration
Public Shared Function GetMessageBuffer ( _
    credential As TransportClientEndpointBehavior, _
    messageBufferUri As Uri, _
    messageVersion As MessageVersion _
) As MessageBufferClient
'Usage
Dim credential As TransportClientEndpointBehavior
Dim messageBufferUri As Uri
Dim messageVersion As MessageVersion
Dim returnValue As MessageBufferClient

returnValue = MessageBufferClient.GetMessageBuffer(credential, _
    messageBufferUri, messageVersion)
public static MessageBufferClient GetMessageBuffer(
    TransportClientEndpointBehavior credential,
    Uri messageBufferUri,
    MessageVersion messageVersion
)
public:
static MessageBufferClient^ GetMessageBuffer(
    TransportClientEndpointBehavior^ credential, 
    Uri^ messageBufferUri, 
    MessageVersion^ messageVersion
)
static member GetMessageBuffer : 
        credential:TransportClientEndpointBehavior * 
        messageBufferUri:Uri * 
        messageVersion:MessageVersion -> MessageBufferClient 
public static function GetMessageBuffer(
    credential : TransportClientEndpointBehavior, 
    messageBufferUri : Uri, 
    messageVersion : MessageVersion
) : MessageBufferClient

Parameters

Return Value

Type: Microsoft.ServiceBus. . :: . .MessageBufferClient
Returns a MessageBufferClient that is associated with the specified message buffer.

Remarks

Use when you want to connect to a message buffer, but want to filter on a specific type of message. If you do not care what types of messages to retrieve, or are sure that the message buffer will have only one type of message sent to it, use GetMessageBuffer(TransportClientEndpointBehavior, Uri) instead.

The message buffer URI will be in the following format:

https://{serviceNamespace}.servicebus.windows.net/{path}/{buffername}

For more information in accessing a message buffer, see How to: Create and Connect to an AppFabric Service Bus Message Buffer and the Message Buffer Overview.

See Also

Reference

MessageBufferClient Class

GetMessageBuffer Overload

Microsoft.ServiceBus Namespace