Share via

CloudQueue.BeginGetMessage Method

  • Reference

Definition

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

Overloads

BeginGetMessage(AsyncCallback, Object)

Begins an asynchronous operation to get a single message from the queue.
BeginGetMessage(Nullable<TimeSpan>, QueueRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to get a single message from the queue, and specifies how long the message should be reserved before it becomes visible, and therefore available for deletion.

BeginGetMessage(AsyncCallback, Object)

Begins an asynchronous operation to get a single message from the queue.

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

Parameters

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

BeginGetMessage(Nullable<TimeSpan>, QueueRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to get a single message from the queue, and specifies how long the message should be reserved before it becomes visible, and therefore available for deletion.

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

Parameters

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