GetQueueMetadata Method

Retrieves the user defined metadata for a queue.

Syntax

[VB.NET]
Public Sub GetQueueMetadata()

[C#]
public void GetQueueMetadata();

Remarks

This method retrieves the metadata for the queue specified by QueueName. Calling this method will populate Metadata, ApproximateMessageCount and will fire the Metadata event.

The current queue's metadata is represents in name value pair form by the Metadata property. AddUserMetadata may be used before calling CreateQueue or SetQueueMetadata.

To update a queue's metadata first call GetQueueMetadata, then make modifications by setting updated values in Metadata and adding new elements with this method. Finally, call SetQueueMetadata

To remove all metadata from a queue, first clear Metadata and then call SetQueueMetadata.

Note: metadata names must adhere to the C# identifier naming rules. See C# Identifier for more details.