SALES: 1-800-867-1380
This topic has not yet been rated - Rate this topic

CloudQueue.BeginPeekMessage Method

Updated: September 27, 2013

[This topic is part of the Windows Azure Storage Client Library 1.7, which has been deprecated. The current recommended version is Storage Client Library 3.0.]

Begins an asynchronous operation to peek a message from the queue.

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

public:
IAsyncResult^ BeginPeekMessage (
	AsyncCallback^ callback, 
	Object^ state
)

Parameters

callback

Type: System.AsyncCallback

The callback delegate that will receive notification when the asynchronous operation completes.

state

Type: System.Object

A user-defined object that will be passed to the callback delegate.

Return Value

Type: System.IAsyncResult

An IAsyncResult that references the asynchronous operation.

When a message is retrieved from the queue using BeginPeekMessage, 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 BeginGetMessage. The call to BeginPeekMessage does not update the message's PopReceipt value, so the message cannot subsequently be deleted. Additionally, calling BeginPeekMessage does not update the message's NextVisibleTime or DequeueCount properties.

Only messages that are visible may be retrieved with BeginPeekMessage.


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 and Windows Server 2008

Target Platforms

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.