Call.BeginTerminate Method

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginTerminate(AsyncCallback, Object)	Terminates the call. After the call is terminated it is no longer usable.
BeginTerminate(CallTerminateOptions, AsyncCallback, Object)	Terminates the call. After the call is terminated it is no longer usable.
BeginTerminate(IEnumerable<SignalingHeader>, AsyncCallback, Object)	Terminates the call. After the call is terminated it is no longer usable.

BeginTerminate(AsyncCallback, Object)

Terminates the call. After the call is terminated it is no longer usable.

public:
 IAsyncResult ^ BeginTerminate(AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginTerminate (AsyncCallback userCallback, object state);

member this.BeginTerminate : AsyncCallback * obj -> IAsyncResult

Public Function BeginTerminate (userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

BeginTerminate(CallTerminateOptions, AsyncCallback, Object)

Terminates the call. After the call is terminated it is no longer usable.

public:
 IAsyncResult ^ BeginTerminate(Microsoft::Rtc::Collaboration::CallTerminateOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginTerminate (Microsoft.Rtc.Collaboration.CallTerminateOptions options, AsyncCallback userCallback, object state);

member this.BeginTerminate : Microsoft.Rtc.Collaboration.CallTerminateOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginTerminate (options As CallTerminateOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

options

CallTerminateOptions

Optional parameters to be applied in terminating the call. Can be null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

ArgumentException

Thrown when: The options parameter contains invalid or restricted headers.The options parameter contains invalid diagnostics information. See DiagnosticsInformation.

BeginTerminate(IEnumerable<SignalingHeader>, AsyncCallback, Object)

Terminates the call. After the call is terminated it is no longer usable.

public:
 IAsyncResult ^ BeginTerminate(System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginTerminate (System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders, AsyncCallback userCallback, object state);

member this.BeginTerminate : seq<Microsoft.Rtc.Signaling.SignalingHeader> * AsyncCallback * obj -> IAsyncResult

Public Function BeginTerminate (signalingHeaders As IEnumerable(Of SignalingHeader), userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

signalingHeaders

IEnumerable<SignalingHeader>

The collection of signaling headers to attach to call termination request. Can be null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

ArgumentException

Thrown when the signalingHeaders parameter contains invalid or restricted headers.