This documentation is archived and is not being maintained.

IUccSubscription.Subscribe 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.

Begins the subscription.

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

void Subscribe (
	UccOperationContext pContext
)
void Subscribe (
	UccOperationContext pContext
)
function Subscribe (
	pContext : UccOperationContext
)

Parameters

pContext

A value of the IUccOperationContext* (UccOperationContext, for a .NET application) type. The default value is NULL.

After this method is called an application begins to receive subscribed category instances and their ongoing updates. The notifications come in a chain of events involving those defined in _IUccPresentityEventsand _IUccCategoryContextEvents as well as _IUccCategoryInstanceEvents. The status of completion of this request is returned as an OnSubscribe event defined in _IUccSubscriptionEvents.

Win32 COM/C++ Syntax

HRESULT Subscribe
(
   IUccOperationContext* pContext
);
Cc667594.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 example below sends a subscription request to a Unified Communications server for a subscription object.

//create new operation context coclass
UccOperationContext opCtx = new UccOperationContext();

//create context coclass
IUccContext cx = new UccContext();

//add a named property and string value 
cx.AddNamedProperty("Subscription Type","Contact subscription ");

//initialize operation context with created context
opCtx.Initialize(1, cx);

contactSubscription.Subscribe(opCtx);

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: