CommunicationObject.BeginClose Method (TimeSpan, AsyncCallback, Object)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Begins an asynchronous operation to close a communication object with a specified timeout.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
Parameters
- timeout
- Type: System.TimeSpan
The TimeSpan that specifies how long the close 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.IAsyncResultThe IAsyncResult that references the asynchronous close operation.
Implements
ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)| Exception | Condition |
|---|---|
| CommunicationObjectFaultedException | BeginClose was called on an object in the Faulted state. |
| ArgumentOutOfRangeException | timeout is less than zero. |
| TimeoutException | The interval of time specified by timeout that was allotted for the operation was exceeded before the operation was completed. |
This method causes the CommunicationObject to gracefully transition from any state, other than the Closed state, into the Closed state with in a specified interval of time. The BeginClose method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). This method calls OnBeginClose(TimeSpan, AsyncCallback, Object) if the communication object was initially in the Opened state.