Begins an asynchronous operation to add a message to the queue.
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
[DoesServiceRequestAttribute] public virtual ICancellableAsyncResult BeginAddMessage( CloudQueueMessage message, Nullable<TimeSpan> timeToLive, Nullable<TimeSpan> initialVisibilityDelay, QueueRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state )
public: [DoesServiceRequestAttribute] virtual ICancellableAsyncResult^ BeginAddMessage( CloudQueueMessage^ message, Nullable<TimeSpan> timeToLive, Nullable<TimeSpan> initialVisibilityDelay, QueueRequestOptions^ options, OperationContext^ operationContext, AsyncCallback^ callback, Object^ state )
[<DoesServiceRequestAttribute>] abstract BeginAddMessage : message:CloudQueueMessage * timeToLive:Nullable<TimeSpan> * initialVisibilityDelay:Nullable<TimeSpan> * options:QueueRequestOptions * operationContext:OperationContext * callback:AsyncCallback * state:Object -> ICancellableAsyncResult [<DoesServiceRequestAttribute>] override BeginAddMessage : message:CloudQueueMessage * timeToLive:Nullable<TimeSpan> * initialVisibilityDelay:Nullable<TimeSpan> * options:QueueRequestOptions * operationContext:OperationContext * callback:AsyncCallback * state:Object -> ICancellableAsyncResult
<DoesServiceRequestAttribute> Public Overridable Function BeginAddMessage ( message As CloudQueueMessage, timeToLive As Nullable(Of TimeSpan), initialVisibilityDelay As Nullable(Of TimeSpan), options As QueueRequestOptions, operationContext As OperationContext, callback As AsyncCallback, state As Object ) As ICancellableAsyncResult
Parameters
- message
-
Type:
Microsoft.WindowsAzure.Storage.Queue.CloudQueueMessageMicrosoft.WindowsAzure.Storage.Queue::CloudQueueMessage^Microsoft.WindowsAzure.Storage.Queue.CloudQueueMessageMicrosoft.WindowsAzure.Storage.Queue.CloudQueueMessage
A CloudQueueMessage object.
- timeToLive
-
Type:
System.Nullable<TimeSpan>System::Nullable<TimeSpan>System.Nullable<TimeSpan>System.Nullable(Of TimeSpan)
A TimeSpan specifying the maximum time to allow the message to be in the queue, or null.
- initialVisibilityDelay
-
Type:
System.Nullable<TimeSpan>System::Nullable<TimeSpan>System.Nullable<TimeSpan>System.Nullable(Of TimeSpan)
A TimeSpan specifying the interval of time from now during which the message will be invisible. If null then the message will be visible immediately.
- 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.