Click or drag to resize
QueueingServiceExtensionsListMessages Method
This API is preliminary and subject to change.

Note: This API is now obsolete.

Gets a list of messages currently in a queue.

Namespace: net.openstack.Core.Synchronous
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
[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 QueuedMessageList ListMessages(
	this IQueueingService queueingService,
	QueueName queueName,
	QueuedMessageListId marker,
	Nullable<int> limit,
	bool echo,
	bool includeClaimed
)

Parameters

queueingService
Type: net.openstack.Core.ProvidersIQueueingService
The queueing service instance.
queueName
Type: net.openstack.Core.Domain.QueuesQueueName
The queue name.
marker
Type: net.openstack.Core.Domain.QueuesQueuedMessageListId
The identifier of the message list page to return. This is obtained from NextPageId. If this value is , the list starts at the beginning.
limit
Type: SystemNullableInt32
The maximum number of messages to return. If this value is , a provider-specific default value is used.
echo
Type: SystemBoolean
to include messages created by the current client; otherwise, .
includeClaimed
Type: SystemBoolean
to include claimed messages; otherwise to return only unclaimed messages.

Return Value

Type: QueuedMessageList
A collection of QueuedMessage objects describing the messages in the queue.

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
ExceptionCondition
ArgumentNullExceptionIf queueingService is .
ArgumentNullExceptionIf queueName is .
ArgumentOutOfRangeExceptionIf limit is less than or equal to 0.
WebExceptionIf the REST request does not return successfully.
Version Information

.NET Framework

Obsolete (compiler warning) in 4.5

openstack.net

Obsolete (compiler warning) in 1.6
Obsolete (compiler warning) in 1.5
Obsolete (compiler warning) in 1.4
Obsolete (compiler warning) in 1.3.6
See Also