UCC_CATEGORY_INSTANCE_EXPIRE_TYPE 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 expiration types of a category instance.

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

Syntax

'Declaration
Public Enumeration UCC_CATEGORY_INSTANCE_EXPIRE_TYPE
public enum UCC_CATEGORY_INSTANCE_EXPIRE_TYPE
public enum class UCC_CATEGORY_INSTANCE_EXPIRE_TYPE
public enum UCC_CATEGORY_INSTANCE_EXPIRE_TYPE
public enum UCC_CATEGORY_INSTANCE_EXPIRE_TYPE

Members

Member name Description
UCCCIET_DEVICE A flag indicating that a category instance expires when the hosting device is shut down.
UCCCIET_NONE A flag indicating that the expiration type is not specified. The API sets this flag if the expiration type of a category instance cannot be determined. An application must not set this flag to publish any category instance.
UCCCIET_STATIC A flag indicating that a category instance does not expire.
UCCCIET_TIME A flag indicating that a category instance expires after a specified time.
UCCCIET_USER A flag indicating that a category instance expires when its owner is logged off.

Remarks

Category instance expiration types define the life time of a category instance. An application must specify an expiration type as defined by a member of this enumeration type when creating a category instance.

Win32 COM/C++ Syntax

typedef enum UCC_CATEGORY_INSTANCE_EXPIRE_TYPE
{
   UCCCIET_NONE = 0,
   UCCCIET_USER = 1,
   UCCCIET_DEVICE = 2,
   UCCCIET_STATIC = 3,
   UCCCIET_TIME = 4
};

Example

The following example handles the OnCategoryInstanceAdded event and displays the expiration type of the added category instance when of the type "contacts".

void _IUccCategoryContextEvents.OnCategoryInstanceAdded(
   IUccCategoryContext pCategoryCtx, 
   UccCategoryInstanceEvent pCategory)
{
   switch (pCategory.CategoryInstance.CategoryContext.Name.ToLower())
   {
      case "contacts":
         Console.WriteLine("Expiry Type: " + pCategory.CategoryInstance.ExpireType.ToString());
         break;
   }
}

The following example call to CreatePublishableCategoryInstance creates a static instance of a custom client category.

IUccCategoryInstance cat = pubMgr.CreatePublishableCategoryInstance(
   "My Custom Category",
   newContainer.Id,
   0,
   UCC_CATEGORY_INSTANCE_EXPIRE_TYPE.UCCCIET_STATIC,
   0);

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