IUccSubscription.Query Method

  • Article

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 one-time query of the specified category instances.

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

Syntax

'Declaration
Sub Query ( _
    pContext As UccOperationContext _
)

void Query (
    UccOperationContext pContext
)

void Query (
    UccOperationContext^ pContext
)

void Query (
    UccOperationContext pContext
)

function Query (
    pContext : UccOperationContext
)

Parameters

Remarks

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

Win32 COM/C++ Syntax

HRESULT Query
(
   IUccOperationContext* pContext
);

Note

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.

Example

The following example creates an operation context class and a context coclass object. The context object receives a named property intended to provide contextual meaning for the event handler that will receive any subscription query events. The operation context object is initialized with the context object and the subscription query request is sent to a Unified Communications server.

//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("Query Type","Self-subscription Query");

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

//call subscription query with the optional operation context
this._subscription.Query(opCtx);

Thread Safety

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

Platforms

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

See Also

Reference

IUccSubscription Interface
IUccSubscription Members
Microsoft.Office.Interop.UccApi Namespace