ServiceBusNamespaceClient.GetQueue Method
Retrieves the queue from the service namespace.
Namespace: Microsoft.ServiceBus
Assembly: Microsoft.ServiceBus.Messaging (in Microsoft.ServiceBus.Messaging.dll)
Syntax
'Declaration
Public Function GetQueue ( _
path As String _
) As Queue
'Usage
Dim instance As ServiceBusNamespaceClient
Dim path As String
Dim returnValue As Queue
returnValue = instance.GetQueue(path)
public Queue GetQueue(
string path
)
public:
Queue^ GetQueue(
String^ path
)
member GetQueue :
path:string -> Queue
public function GetQueue(
path : String
) : Queue
Parameters
- path
Type: System.String
Path of the queue relative to the service namespace base address.
Return Value
Type: Microsoft.ServiceBus.Messaging.Queue
A Queue handle to the queue, or null if the queue does not exist in the service namespace.
Exceptions
Exception | Condition |
---|---|
ArgumentException | path is empty or null, or path starts or ends with "/". |
TimeoutException | The operation times out. The timeout period is initialized through the ServiceBusNamespaceClientSettings class. You may need to increase the value of the OperationTimeout property to avoid this exception if the timeout value is relatively low. |
UnauthorizedAccessException | The ServiceBusNamespaceClient object does not have sufficient permission to perform this operation. You should check to ensure that your ServiceBusNamespaceClient has the correct Credential credentials to perform this operation. |
MessagingException | An internal error or unexpected exception occurs. |