CloudQueue.GetMessage Method

Definition

Gets a message from the queue using the default request options. This operation marks the retrieved message as invisible in the queue for the default visibility timeout period.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.Queue.CloudQueueMessage GetMessage (TimeSpan? visibilityTimeout = default, Microsoft.Azure.Storage.Queue.QueueRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member GetMessage : Nullable<TimeSpan> * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> Microsoft.Azure.Storage.Queue.CloudQueueMessage
override this.GetMessage : Nullable<TimeSpan> * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> Microsoft.Azure.Storage.Queue.CloudQueueMessage
Public Overridable Function GetMessage (Optional visibilityTimeout As Nullable(Of TimeSpan) = Nothing, Optional options As QueueRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As CloudQueueMessage

Parameters

visibilityTimeout
Nullable<TimeSpan>

A TimeSpan specifying the visibility timeout interval.

options
QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

Returns

A CloudQueueMessage object.

Attributes

Applies to