IUccEndpoint.SignalingCapabilities 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 signaling capabilities for the current endpoint.

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

Syntax

'Declaration
ReadOnly Property SignalingCapabilities As Integer

int SignalingCapabilities { get; }

property int SignalingCapabilities {
    int get ();
}

/** @property */
int get_SignalingCapabilities ()

function get SignalingCapabilities () : int

Property Value

A value of the LONG* (int, for a .NET application) type. This returns a value as enumerated in the UCC_ENDPOINT_SIGNALING_CAPABILITIES enumeration type.

Remarks

Endpoint signaling capabilities represent the telephony functionality that an endpoint supports. Such capbilities include transfering calls, forwarding calls, and conferencing calls. A client should verify a specific capability exists before attempting to perform such a telephony related action. For example, a client UI control such as a telephone call transfer button should be disabled if the endpoint signalingCabilities property indicates that call transfer is not supported.

Win32 COM/C++ Syntax

HRESULT get_SignalingCapabilities
(
   LONG* pVal
);

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 casts the integer returned by reading the MediaCapabilities property into the UCC_ENDPOINT_SIGNALING_CAPABILITIES enumeration and converts the resulting object to a string for display on a local user's system console.

int signalingCapabilities = this.endpoint.SignalingCapabilities;
Console.WriteLine(
   "Endpoint Signaling Capabilities:" +
   ((UCC_ENDPOINT_SIGNALING_CAPABILITIES)signalingCapabilities).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