IUccSessionParticipant.AddParticipantEndpoint Method

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

Adds a new participant endpoint to the participant.

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

Syntax

'Declaration
Sub AddParticipantEndpoint ( _
    pParticipantEndpoint As IUccSessionParticipantEndpoint, _
    pOperationContext As UccOperationContext _
)

void AddParticipantEndpoint (
    IUccSessionParticipantEndpoint pParticipantEndpoint,
    UccOperationContext pOperationContext
)

void AddParticipantEndpoint (
    IUccSessionParticipantEndpoint^ pParticipantEndpoint, 
    UccOperationContext^ pOperationContext
)

void AddParticipantEndpoint (
    IUccSessionParticipantEndpoint pParticipantEndpoint, 
    UccOperationContext pOperationContext
)

function AddParticipantEndpoint (
    pParticipantEndpoint : IUccSessionParticipantEndpoint, 
    pOperationContext : UccOperationContext
)

Parameters

  • pParticipantEndpoint
    A value of the IUccSessionParticipantEndpoint* (IUccSessionParticipantEndpoint, for a .NET application) type. This specifies the participant endpoint to be added.
  • pOperationContext
    A value of the IUccOperationContext* (UccOperationContext, for a .NET application) type. The default value is NULL. This specifies the operation context associated with the method call.

Remarks

An application can call this method to control how a communication channel is established between specified endpoints of session participants.

Win32 COM/C++ Syntax

HRESULT AddParticipantEndpoint
(
   IUccSessionParticipantEndpoint* pParticipantEndpoint,
   IUccOperationContext* pOperationContext
);

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 adds a session participant endpoint to an instance of IUccSessionParticipant. Optionally, an operational context is created and supplied with the operation.

/// <summary>
/// Adds the provided sesion endpoint to the provided session
/// participant endpoint collection. Optionally, an operation 
/// context is added to the operation
/// </summary>
/// <param name="participant">participant who is getting the new endpoint</param>
/// <param name="endpoint">endpoint to be added</param>
/// <param name="pContextKey">optional metadata operation context property name</param>
/// <param name="pContextValue">optional metadata operation context property value</param>
private void AddParticipantEndpoint(
    IUccSessionParticipant participant,
    IUccSessionParticipantEndpoint endpoint,
    string pContextKey,
    string pContextValue)
{
    if (participant == null)
    {
        throw new ArgumentNullException("participant", "Participant cannot be null");
    }
    if (endpoint == null)
    {
        throw new ArgumentNullException("endpoint", "session participant endpoint cannot be null");
    }
    UccContext endpointContext = new UccContextClass();
    UccOperationContext opContext = new UccOperationContextClass();
    if (pContextKey.Length > 0 && pContextValue.Length > 0)
    {
        endpointContext.AddNamedProperty(pContextKey, pContextValue);
        opContext.Initialize(0,endpointContext);
    }
    participant.AddParticipantEndpoint(endpoint, opContext);
}

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

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