ServiceBusNamespaceClient.BeginGetQueue Method

Asynchronous version of GetQueue(String).

Namespace:  Microsoft.ServiceBus
Assembly:  Microsoft.ServiceBus.Messaging (in Microsoft.ServiceBus.Messaging.dll)

Syntax

'Declaration
Public Function BeginGetQueue ( _
    path As String, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As ServiceBusNamespaceClient
Dim path As String
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginGetQueue(path, _
    callback, state)
public IAsyncResult BeginGetQueue(
    string path,
    AsyncCallback callback,
    Object state
)
public:
IAsyncResult^ BeginGetQueue(
    String^ path, 
    AsyncCallback^ callback, 
    Object^ state
)
member BeginGetQueue : 
        path:string * 
        callback:AsyncCallback * 
        state:Object -> IAsyncResult 
public function BeginGetQueue(
    path : String, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

  • path
    Type: System.String
    Path of the queue relative to the service namespace base address.
  • state
    Type: System.Object
    A user-defined object that contains information about the receive operation. This object is passed to the EndGetQueue(IAsyncResult) delegate when the operation is complete.

Return Value

Type: System.IAsyncResult
A IAsyncResult that references the asynchronous operation to retrieve all queues from the service namespace.

Exceptions

Exception Condition
ArgumentException

path is empty or null.

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.

See Also

Reference

ServiceBusNamespaceClient Class

Microsoft.ServiceBus Namespace