QueueingServiceExtensions.GetMessage Method

QueueingServiceExtensionsGetMessage Method

This API is preliminary and subject to change.

Note: This API is now obsolete.

Gets detailed information about a specific queued message.

Namespace: net.openstack.Core.Synchronous
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

[ObsoleteAttribute("These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")]
public static QueuedMessage GetMessage(
	this IQueueingService queueingService,
	QueueName queueName,
	MessageId messageId
)

<ExtensionAttribute>
<ObsoleteAttribute("These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")>
Public Shared Function GetMessage ( 
	queueingService As IQueueingService,
	queueName As QueueName,
	messageId As MessageId
) As QueuedMessage

public:
[ExtensionAttribute]
[ObsoleteAttribute(L"These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")]
static QueuedMessage^ GetMessage(
	IQueueingService^ queueingService, 
	QueueName^ queueName, 
	MessageId^ messageId
)

[<ExtensionAttribute>]
[<ObsoleteAttribute("These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")>]
static member GetMessage : 
        queueingService : IQueueingService * 
        queueName : QueueName * 
        messageId : MessageId -> QueuedMessage

Parameters

queueingService: Type: net.openstack.Core.ProvidersIQueueingService
The queueing service instance.
queueName: Type: net.openstack.Core.Domain.QueuesQueueName
The queue name.
messageId: Type: net.openstack.Core.Domain.QueuesMessageId
The message ID. This is obtained from QueuedMessage.Id.

Return Value

Type: QueuedMessage
A QueuedMessage object containing detailed information about the specified message.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IQueueingService. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	If queueingService is .
ArgumentNullException	If queueName is . -or- If messageId is .
WebException	If the REST request does not return successfully.

Exception

Condition

ArgumentNullException

If queueingService is .

ArgumentNullException

If queueName is .

-or-

If messageId is .

WebException

If the REST request does not return successfully.

Remarks

This method will return information for the specified message regardless of the Client-ID or claim associated with the message.