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.
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
[DoesServiceRequestAttribute] public virtual ICancellableAsyncResult BeginGetMessages( int messageCount, Nullable<TimeSpan> visibilityTimeout, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state )
public: [DoesServiceRequestAttribute] virtual ICancellableAsyncResult^ BeginGetMessages( int messageCount, Nullable<TimeSpan> visibilityTimeout, QueueRequestOptions^ options, OperationContext^ operationContext, AsyncCallback^ callback, Object^ state )
[<DoesServiceRequestAttribute>] abstract BeginGetMessages : messageCount:int * visibilityTimeout:Nullable<TimeSpan> * options:QueueRequestOptions * operationContext:OperationContext * callback:AsyncCallback * state:Object -> ICancellableAsyncResult [<DoesServiceRequestAttribute>] override BeginGetMessages : messageCount:int * visibilityTimeout:Nullable<TimeSpan> * options:QueueRequestOptions * operationContext:OperationContext * callback:AsyncCallback * state:Object -> ICancellableAsyncResult
<DoesServiceRequestAttribute> 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
-
Type:
System.Int32System::Int32System.Int32System.Int32
The number of messages to retrieve.
- visibilityTimeout
-
Type:
System.Nullable<TimeSpan>System::Nullable<TimeSpan>System.Nullable<TimeSpan>System.Nullable(Of TimeSpan)
A TimeSpan specifying the visibility timeout interval.
- options
-
Type:
Microsoft.WindowsAzure.Storage.Queue.QueueRequestOptionsMicrosoft.WindowsAzure.Storage.Queue::QueueRequestOptions^Microsoft.WindowsAzure.Storage.Queue.QueueRequestOptionsMicrosoft.WindowsAzure.Storage.Queue.QueueRequestOptions
A QueueRequestOptions object that specifies additional options for the request.
- operationContext
-
Type:
Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext
An OperationContext object that represents the context for the current operation.
- callback
-
Type:
System.AsyncCallbackSystem::AsyncCallback^System.AsyncCallbackSystem.AsyncCallback
An AsyncCallback delegate that will receive notification when the asynchronous operation completes.
- state
-
Type:
System.ObjectSystem::Object^System.ObjectSystem.Object
A user-defined object that will be passed to the callback delegate.
Return Value
Type: Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage::ICancellableAsyncResult^Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage.ICancellableAsyncResultAn ICancellableAsyncResult that references the asynchronous operation.