QueueRequest.PeekMessages Method

Storage Client Library NET API

previous page next page
[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.]

Constructs a web request to retrieve a specified number of messages without changing their visibility.

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

Usage

Visual Basic
Dim uri As Uri
Dim timeout As Integer
Dim numberOfMessages As Nullable(Of Integer)
Dim returnValue As HttpWebRequest

returnValue = QueueRequest.PeekMessages(uri, timeout, numberOfMessages)

Syntax

Visual Basic
Public Shared Function PeekMessages ( _
	uri As Uri, _
	timeout As Integer, _
	numberOfMessages As Nullable(Of Integer) _
) As HttpWebRequest
C#
public static HttpWebRequest PeekMessages (
	Uri uri,
	int timeout,
	Nullable<int> numberOfMessages
)
C++
public:
static HttpWebRequest^ PeekMessages (
	Uri^ uri, 
	int timeout, 
	Nullable<int> numberOfMessages
)
J#
JScript
Parameters
uri
Type: System.Uri
The absolute URI to the queue.
timeout
Type: System.Int32
The server timeout interval.
numberOfMessages
Type: System.Nullable
The number of messages to retrieve.
Return Value
Type: System.Net.HttpWebRequest
A web request for performing the specified operation.
			
Remarks
For more details about this API, see the topics on the equivalent REST APIs in See Also > Other Resources.

Thread Safety

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


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

    
  



  


  
  

    
      previous page
    

     start

    
       next page