CloudQueue.BeginGetMessages Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Storage.Queue
Assembly:
Microsoft.Azure.Storage.Queue.dll
Package:
Microsoft.Azure.Storage.Queue v11.2.3

Overloads

BeginGetMessages(Int32, AsyncCallback, Object)

Begins an asynchronous operation to get messages from the queue.
BeginGetMessages(Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to get the specified number of messages from the queue using the specified request options and operation context. This operation marks the retrieved messages as invisible in the queue for the default visibility timeout period.

BeginGetMessages(Int32, AsyncCallback, Object)

Begins an asynchronous operation to get messages from the queue.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.ICancellableAsyncResult BeginGetMessages (int messageCount, AsyncCallback callback, object state);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BeginGetMessages : int * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
override this.BeginGetMessages : int * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
Public Overridable Function BeginGetMessages (messageCount As Integer, callback As AsyncCallback, state As Object) As ICancellableAsyncResult

Parameters

messageCount
Int32

The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.

callback
AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state
Object

A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

Attributes
DoesServiceRequestAttribute

Applies to

BeginGetMessages(Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to get the specified number of messages from the queue using the specified request options and operation context. This operation marks the retrieved messages as invisible in the queue for the default visibility timeout period.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.ICancellableAsyncResult BeginGetMessages (int messageCount, TimeSpan? visibilityTimeout, Microsoft.Azure.Storage.Queue.QueueRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, AsyncCallback callback, object state);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BeginGetMessages : int * Nullable<TimeSpan> * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
override this.BeginGetMessages : int * Nullable<TimeSpan> * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
Public Overridable Function BeginGetMessages (messageCount As Integer, visibilityTimeout As Nullable(Of TimeSpan), options As QueueRequestOptions, operationContext As OperationContext, callback As AsyncCallback, state As Object) As ICancellableAsyncResult

Parameters

messageCount
Int32

The number of messages to retrieve. The maximum number of messages that may be retrieved at one time is 32.

visibilityTimeout
Nullable<TimeSpan>

A TimeSpan specifying the visibility timeout interval.

options
QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

callback
AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state
Object

A user-defined object that will be passed to the callback delegate.

Returns

ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

Attributes
DoesServiceRequestAttribute

Applies to