SubscriptionClient.OnBeginAddRule Method

Begins adding a Rule to a Subscription through the run-time client protocol.

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

Syntax

'Declaration
Protected MustOverride Function OnBeginAddRule ( _
    ruleName As String, _
    description As RuleDescription, _
    timeout As TimeSpan, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim ruleName As String
Dim description As RuleDescription
Dim timeout As TimeSpan
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = Me.OnBeginAddRule(ruleName, _
    description, timeout, callback, state)

protected abstract IAsyncResult OnBeginAddRule(
    string ruleName,
    RuleDescription description,
    TimeSpan timeout,
    AsyncCallback callback,
    Object state
)

protected:
virtual IAsyncResult^ OnBeginAddRule(
    String^ ruleName, 
    RuleDescription^ description, 
    TimeSpan timeout, 
    AsyncCallback^ callback, 
    Object^ state
) abstract

abstract OnBeginAddRule : 
        ruleName:string * 
        description:RuleDescription * 
        timeout:TimeSpan * 
        callback:AsyncCallback * 
        state:Object -> IAsyncResult 

protected abstract function OnBeginAddRule(
    ruleName : String, 
    description : RuleDescription, 
    timeout : TimeSpan, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

• ruleName
  Type: System.String
  The name of the rule to be added.

• description
  Type: Microsoft.ServiceBus.Messaging.RuleDescription
  Metadata of the rule to be added.

• timeout
  Type: System.TimeSpan
  The timeout period for the operation.

• callback
  Type: System.AsyncCallback
  An AsyncCallback delegate that references the method to invoke when the operation is complete.

• state
  Type: System.Object
  A user-defined object that contains information about the receive operation. This object is passed to the BeginAddRule(String, FilterExpression, AsyncCallback, Object) delegate when the operation is complete.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous BeginAddRule(String, FilterExpression, AsyncCallback, Object).

See Also

Reference

SubscriptionClient Class

Microsoft.ServiceBus.Messaging Namespace