IUccContainer.Id 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 the ID of this container.

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

Syntax

'Declaration
ReadOnly Property Id As Integer
int Id { get; }
property int Id {
    int get ();
}
/** @property */
int get_Id ()
function get Id () : int

Property Value

A value of the LONG* (int, for a .NET application) type. This ID value is used to identify a specific container.

Remarks

The container Id is used to uniquely identify a container. The standard container Id's a client application is provisioned with include 0, 1, 2, 3, 100, 200, 300, 400, and 32000. A client can create a custom container whose Id should not be in the previous list.

Win32 COM/C++ Syntax

HRESULT get_Id
(
   LONG* plContainerId
);

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 is a public property of a class that wraps an IUccContainer instance. this.container is a private field of the class which stores the reference to the container interface. The property returns the container Id of the wrapped container instance.

public int ContainerID
{
   get
   {
      return this.container.Id;
   }
}

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

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