IUccPlatform.CreateProxyEndpoint Method

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.

Creates a proxy endpoint for controlling a telephone connected to PSTN.

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

Syntax

'Declaration
Function CreateProxyEndpoint ( _
    eType As UCC_ENDPOINT_TYPE, _
    pControllingEndpoint As IUccEndpoint, _
    pUri As UccUri, _
    bstrEndpointId As String, _
    pContext As UccContext _
) As IUccEndpoint

IUccEndpoint CreateProxyEndpoint (
    UCC_ENDPOINT_TYPE eType,
    IUccEndpoint pControllingEndpoint,
    UccUri pUri,
    string bstrEndpointId,
    UccContext pContext
)

IUccEndpoint^ CreateProxyEndpoint (
    UCC_ENDPOINT_TYPE eType, 
    IUccEndpoint^ pControllingEndpoint, 
    UccUri^ pUri, 
    String^ bstrEndpointId, 
    UccContext^ pContext
)

IUccEndpoint CreateProxyEndpoint (
    UCC_ENDPOINT_TYPE eType, 
    IUccEndpoint pControllingEndpoint, 
    UccUri pUri, 
    String bstrEndpointId, 
    UccContext pContext
)

function CreateProxyEndpoint (
    eType : UCC_ENDPOINT_TYPE, 
    pControllingEndpoint : IUccEndpoint, 
    pUri : UccUri, 
    bstrEndpointId : String, 
    pContext : UccContext
) : IUccEndpoint

Parameters

• eType
  A value of the UCC_ENDPOINT_TYPE type. This specifies the type of the proxy endpoint to be created.

• pControllingEndpoint
  A value of the IUccEndpoint* (IUccEndpoint, for a .NET application) type. This specifies the controlling endpoint object created by the CreateEndpoint method of this interface.

• pUri
  A value of the IUccUri* (UccUri, for a .NET application) type. This specifies the SIP URI (in the form of "sip:+14255551111@cstasvr.contoso.com") of a proxy endpoint representing a PSTN telephone.

• bstrEndpointId
  A value of the BSTR (string, for a .NET application) type. This specifies the TEL URI (in the form of "tel:+14255551111;ext=12345") of the proxy endpoint to be created. For more information about tel URI formatting, see [MS-PRES]

• pContext
  A value of the IUccContext* (UccContext, for a .NET application) type. This is used to specify any application-specific properties of the proxy endpoint to be created.

Return Value

A value of the IUccEndpoint** (IUccEndpoint, for a .NET application) type. This points to an IUccEndpoint instance if the operation is successful.

Remarks

A proxy endpoint represents a telephone connected to PSTN and is used in remote call controls.

To create a proxy endpoint representing a PBX telephone, an application must set the eType parameter to the UCC_ENDPOINT_TYPE.UCC_ENDPOINT_TYPE.UCCET_PROXY_TELEPHONY value. This proxy endpoint allows a Unified Communications API client to make and receive telephone calls through the telephone serviced by an organization's Public Branch Exchange (PBX).

It is not necessary to advise for events on the proxy endpoint. All endpoint events are raised by the controlling user endpoint.

Note

The proxy endpoint can only be created after a client application has created a user endpoint. The second parameter of the CreateProxyEndpoint method is the previously created user endpoint as controlling endpoint.

Win32 COM/C++ Syntax

HRESULT CreateProxyEndpoint
(
   UCC_ENDPOINT_TYPE eType,
   IUccEndpoint* pControllingEndpoint,
   IUccUri* pUri,
   BSTR bstrEndpointId,
   IUccContext* pContext,
   IUccEndpoint** ppEndpoint
);

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

private string proxyEndpointSipURI = "sip:AB32-LAB@PBXServer.contoso.com"; 
private string proxyEndpointTelId = "tel:1234;phone-context=AB32-cdp.AB32-udp";

IUccEndpoint telEndpoint = platform.CreateProxyEndpoint(
     UCC_ENDPOINT_TYPE.UCCET_PROXY_TELEPHONY,
     endpoint,
     proxyEndpointSipURI,
     proxyEndpointTelId,
     null);

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

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