Share via

IUccEndpoint.Type Property

  • 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.

Gets the endpoint type.

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

Syntax

'Declaration
ReadOnly Property Type As UCC_ENDPOINT_TYPE

UCC_ENDPOINT_TYPE Type { get; }

property UCC_ENDPOINT_TYPE Type {
    UCC_ENDPOINT_TYPE get ();
}

/** @property */
UCC_ENDPOINT_TYPE get_Type ()

function get Type () : UCC_ENDPOINT_TYPE

Property Value

A value of the UCC_ENDPOINT_TYPE type.

Remarks

The endpoint types can be:

  1. Server based endpoint. This is the local user's actual endpoint

  2. Proxy endpoint. This is a logical endpoint that represents a user UC enabled telephone. The proxy endpoint is controlled by the local server based endpoint.

An endpoint type cannot be changed by a client. In other words, a server endpoint created by an instance of IUccPlatform on the client cannot be changed to a proxy endpoint. Instead, the platform object must be used to create a new proxy endpoint.

Win32 COM/C++ Syntax

HRESULT get_Type
(
   UCC_ENDPOINT_TYPE* peType
);

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 example displays the type of an instantiated endpoint on the local users's system console. The Type property returns an enumeration that can be converted to a human readable string by calling the ToString method on the returned object.

Console.WriteLine(
   "Endpoint Type:" +
   this.endpoint.Type.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

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