CloudQueue.BeginPeekMessages Method

Definition

Overloads

BeginPeekMessages(Int32, QueueRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to peek messages from the queue.

BeginPeekMessages(Int32, AsyncCallback, Object)

Begins an asynchronous operation to peek messages from the queue.

BeginPeekMessages(Int32, QueueRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to peek messages from the queue.

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

Parameters

messageCount
Int32

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

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

Applies to

BeginPeekMessages(Int32, AsyncCallback, Object)

Begins an asynchronous operation to peek messages from the queue.

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

Parameters

messageCount
Int32

The number of messages to peek. 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

Applies to