IUccCategoryInstance.ExpiryTime Property

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.

Gets and sets the expiration time, in seconds, of this category instance.

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

Syntax

'Declaration
Property ExpiryTime As Integer

int ExpiryTime { get; set; }

property int ExpiryTime {
    int get ();
    void set (int value);
}

/** @property */
int get_ExpiryTime ()

/** @property */
void set_ExpiryTime (int value)

function get ExpiryTime () : int

function set ExpiryTime (value : int)

Property Value

A value of the LONG* (int, for a .NET application) type.

Remarks

This property is applicable only if the expiration type of this category instance is of UCC_CATEGORY_INSTANCE_EXPIRE_TYPE.UCCCIET_TIME.

Win32 COM/C++ Syntax

HRESULT get_ExpiryTime
(
   LONG* plExpiryTime
);
HRESULT put_ExpiryTime
(
   LONG plExpiryTime
);

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

This example is taken from an event handler for the OnCategoryInstanceAdded event. The example converts the returned integer to a string and displays the result on the local user's system console.

IUccCategoryInstance ci = pCategoryInstanceEvents.CategoryInstance;
if (ci.ExpireType == UCC_CATEGORY_INSTANCE_EXPIRE_TYPE.UCCCIET_TIME)
{
    Console.WriteLine("Expiration Time in seconds: " + ci.ExpiryTime.ToString());
}

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

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