ICommunicationObject.BeginClose Method (TimeSpan, AsyncCallback, Object)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Begins an asynchronous operation to close a communication object with a specified time-out.
Namespace: System.ServiceModel
Assembly: System.ServiceModel (in System.ServiceModel.dll)
Syntax
'Declaration
Function BeginClose ( _
timeout As TimeSpan, _
callback As AsyncCallback, _
state As Object _
) As IAsyncResult
IAsyncResult BeginClose(
TimeSpan timeout,
AsyncCallback callback,
Object state
)
Parameters
- timeout
Type: System.TimeSpan
The Timespan that specifies how long the send operation has to complete before timing out.
- callback
Type: System.AsyncCallback
The AsyncCallback delegate that receives notification of the completion of the asynchronous close operation.
- state
Type: System.Object
An object, specified by the application, that contains state information associated with the asynchronous close operation.
Return Value
Type: System.IAsyncResult
The IAsyncResult that references the asynchronous close operation.
Exceptions
Exception | Condition |
---|---|
CommunicationObjectFaultedException | BeginClose() was called on an object in the Faulted state. |
TimeoutException | The specified time-out elapsed before the ICommunicationObject was able to close gracefully. |
Remarks
This method causes an ICommunicationObject to gracefully transition from any state, other than the Opened state to the Closed state within a specified interval of time. The BeginClose() method allows any unfinished work to be completed before returning. (For example, finish sending any buffered messages.)
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.