Export (0) Print
Expand All

CloudQueue.PeekMessage Method

Updated: September 27, 2013

[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See Storage Client Library for the latest version.]

Peeks a message from the queue.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)

Dim instance As CloudQueue
Dim returnValue As CloudQueueMessage

returnValue = instance.PeekMessage

public CloudQueueMessage PeekMessage ()

Return Value

Type: Microsoft.WindowsAzure.StorageClient.CloudQueueMessage

A message.

When a message is retrieved from the queue using PeekMessage, the message is not dequeued and the visibility of the message remains unchanged. The message remains available to other clients until a client retrieves the message with a call to GetMessage. The call to PeekMessage does not update the message's PopReceipt value, so the message cannot subsequently be deleted. Additionally, calling PeekMessage does not update the message's NextVisibleTime or DequeueCount properties.

Only messages that are visible may be retrieved with PeekMessage.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012


© 2014 Microsoft