This documentation is archived and is not being maintained.

IUccEndpoint.Enable Method

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Starts a user logon with the computer running Office Communications Server using a particular communications device.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

void Enable (
	UccOperationContext pOperationContext
)
void Enable (
	UccOperationContext pOperationContext
)
function Enable (
	pOperationContext : UccOperationContext
)

Parameters

pOperationContext

A value of the IUccOperationContext* (UccOperationContext, for a .NET application) type. The default value is NULL. Application-specified operational context for this asynchronous operation.

Endpoints cannot communicate with each other until they are registered with the computer running Office Communications Server. An application starts a request for the registration by calling this method. Before that the application must set the required signaling settings as represented by an IUccServerSignalingSettings instance. An application must watch for the _IUccEndpointEvents::OnEnable event to determine whether the endpoint is indeed registered with the server.

The caller is notified of the status of the Enable operation by the OnEnable event.

The local client is not privisioned with subscribed categories until the endpoint is enabled. It is a good idea to subscribe to interested categories in the OnEnable event to begin receiving presentity, category context, and category instance events.

Win32 COM/C++ Syntax

HRESULT Enable
(
   IUccOperationContext* pOperationContext
);
Cc702974.note(en-us,office.12).gifNote:
In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

The following example starts to sign a user into an Office Communications server by calling Enable on a user endpoint. To verify the signin is successful, the client must have advised for endpoint events. If the signin is succesful, the user endpoint object will raise an OnEnable event. To review a complete example of the sign in process, see CreateEndpoint

//Enable the endpoint to login
this.endpoint.Enable(null);

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

Show: