UCC_SUBSCRIPTION_CONTEXT Enumeration

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.

Enumerates the IDs of the extended properties of a subscription.

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

Syntax

'Declaration
Public Enumeration UCC_SUBSCRIPTION_CONTEXT
public enum UCC_SUBSCRIPTION_CONTEXT
public enum class UCC_SUBSCRIPTION_CONTEXT
public enum UCC_SUBSCRIPTION_CONTEXT
public enum UCC_SUBSCRIPTION_CONTEXT

Members

Member name Description
UCCSC_RETRY_TIMEOUT The ID of a property of an integer value describing the retry timeout in seconds. The default value is 30 seconds.
UCCSC_THROTTLE_LIMIT The ID of a property of an integer value describing the throttling limit in seconds. The minimum of this property value is 120 seconds or 2 minutes.

Remarks

A SUBSCRIBE request in a subscription fails when the underlying server is down or other errors occur. In such cases the UCC API resubmits the request periodically until the request succeeds. This process is known as subscription Retry. The period of Retry is known as Retry Timeout. Its value is specified by the UCCSC_RETRY_TIMEOUT property defined in this enumeration type. In a polling subscription the UCC API throttles the Query requests to control how often such a request is sent to the server. The frequency is determined by the UCCSC_THROTTLE_LIMIT property defined here. For example, a client calls Query twice in 30 seconds. The API will delays sending the second request for a time period specified by the UCCSC_THROTTLE_LIMIT property value. Because of throttling a client can get the results of a Query request that can be at minimum two minutes stale.

Win32 COM/C++ Syntax

typedef enum UCC_SUBSCRIPTION_CONTEXT
{
   UCCSC_RETRY_TIMEOUT = 1,
   UCCSC_THROTTLE_LIMIT = 2
};

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

Microsoft.Office.Interop.UccApi Namespace