This documentation is archived and is not being maintained.

ICommunicationObject.BeginOpen Method (AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

IAsyncResult BeginOpen(
	AsyncCallback callback,
	Object state
)

Parameters

callback
Type: System.AsyncCallback
The AsyncCallback delegate that receives notification of the completion of the asynchronous open operation.
state
Type: System.Object
An object, specified by the application, that contains state information associated with the asynchronous open operation.

Return Value

Type: System.IAsyncResult
The IAsyncResult that references the asynchronous open operation.

ExceptionCondition
CommunicationException

The ICommunicationObject was unable to be opened and has entered the Faulted state.

TimeoutException

The default open timeout elapsed before the ICommunicationObject was able to enter the Opened state and has entered the Faulted state.

When an ICommunicationObject is instantiated, it begins in the Created state. In the Created state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The BeginOpen() method causes an ICommunicationObject to enter into the Opening state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the ICommunicationObject is aborted.

In the Opened state, the ICommunicationObject is usable (for example, messages can be received), but it is no longer configurable.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: