Export (0) Print
Expand All

CloudQueue.BeginPeekMessages 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.]

Begins an asynchronous operation to peek a set of messages from the queue.

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

'Usage
Dim instance As CloudQueue
Dim messageCount As Integer
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginPeekMessages(messageCount, callback, state)

public IAsyncResult BeginPeekMessages (
	int messageCount,
	AsyncCallback callback,
	Object state
)

Parameters

messageCount

Type: System.Int32

The number of messages to retrieve.

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 messages are retrieved from the queue using BeginPeekMessages, the message is not dequeued and the visibility of the messages remains unchanged. The messages remain available to other clients until a client retrieves them with a call to BeginGetMessages. The call to BeginPeekMessages does not update a message's PopReceipt value, so the message cannot subsequently be deleted. Additionally, calling BeginPeekMessages does not update a message's NextVisibleTime or DequeueCount properties.

Only messages that are visible may be retrieved with BeginPeekMessages. The maximum number of messages that may be retrieved with a call to BeginPeekMessages is 32.


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

 

Show:
© 2014 Microsoft