Adds a message to the queue, with a value specifying its expiration (the length of time it can remain in the queue), and a value specifying how long it must first remain invisible (delayed visibility). Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Usage
| Visual Basic |
|---|
Dim instance As CloudQueue Dim message As CloudQueueMessage Dim timeToLive As Nullable(Of TimeSpan) Dim initialVisibilityDelay As Nullable(Of TimeSpan) instance.AddMessage(message, timeToLive, initialVisibilityDelay) |
Syntax
| Visual Basic |
|---|
Public Sub AddMessage ( _ message As CloudQueueMessage, _ timeToLive As Nullable(Of TimeSpan), _ initialVisibilityDelay As Nullable(Of TimeSpan) _ ) |
| C# |
|---|
public void AddMessage ( CloudQueueMessage message, Nullable<TimeSpan> timeToLive, Nullable<TimeSpan> initialVisibilityDelay ) |
| C++ |
|---|
public: void AddMessage ( CloudQueueMessage^ message, Nullable<TimeSpan> timeToLive, Nullable<TimeSpan> initialVisibilityDelay ) |
| J# |
|---|
| JScript |
|---|
Parameters
- message
A queue message.
- timeToLive
A value indicating the message time-to-live.
- initialVisibilityDelay
The visibility delay for the message.
Remarks
The AddMessage method adds a message to the back of the queue.
A message can be up to 64 KB in size for SDK version 1.6 or newer, or 8 KB in size for older SDK versions. The storage client library encodes the message content using Base64 when EncodeMessage is set to true, its default. Encode messages if message content can contain characters that are invalid in XML.
 Note |
|---|
| Encoding with Base64 adds overhead to the message size. You can use Convert.ToBase64String() to verify content encoded with Base64 fits within the 64 KB message size limit. |
The message time-to-live specifies how long a message will remain in the queue, from the time it is added to the time it is retrieved and deleted. If a message is not retrieved before the time-to-live interval expires, the message is removed from the queue.
The message visibility delay specifies the time that the message will be invisible. After the delay expires, the message will become visible. Visibility of a message can be delayed for up to 7 days.