Share via

IUccContainerMember.CompareTo 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.

Compares this container member to another container member.

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

Syntax

'Declaration
Function CompareTo ( _
    pOtherMember As IUccContainerMember _
) As UCC_CONTAINER_MEMBER_COMPARE_RESULT

UCC_CONTAINER_MEMBER_COMPARE_RESULT CompareTo (
    IUccContainerMember pOtherMember
)

UCC_CONTAINER_MEMBER_COMPARE_RESULT CompareTo (
    IUccContainerMember^ pOtherMember
)

UCC_CONTAINER_MEMBER_COMPARE_RESULT CompareTo (
    IUccContainerMember pOtherMember
)

function CompareTo (
    pOtherMember : IUccContainerMember
) : UCC_CONTAINER_MEMBER_COMPARE_RESULT

Parameters

  • pOtherMember
    A value of the IUccContainerMember* (IUccContainerMember, for a .NET application) type. This specifies the container member to be compared to.

Return Value

A value of the UCC_CONTAINER_MEMBER_COMPARE_RESULT* (UCC_CONTAINER_MEMBER_COMPARE_RESULT, for a .NET application) type. This returns the result of comparison.

Remarks

Win32 COM/C++ Syntax

HRESULT CompareTo
(
   IUccContainerMember* pOtherMember,
   UCC_CONTAINER_MEMBER_COMPARE_RESULT* penResult
);

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 handles the OnMemberAdded container event by comparing the newly received container member with each member of a collection of previously received container members. The collection items are instances of a client application class that wraps the IUccContainerMember interface. The wrapped interface is exposed by the Member property of the application class.

void _IUccContainerEvents.OnMemberAdded(
   IUccContainer pContainer, 
   UccContainerMemberCollectionEvent pEventData)
{
   this.cm = pEventData.ContainerMember;
   Boolean addMember = false;
   foreach (ContainerMember m in this.containerMembers.Values)
   {
      UCC_CONTAINER_MEMBER_COMPARE_RESULT r = cm.CompareTo(m.Member);
      if (r != UCC_CONTAINER_MEMBER_COMPARE_RESULT.UCCCMCR_SAME)
      {
         addMember = true;
         break;
      }
   }
   if (addMember == true)
   {
      Console.WriteLine("New Container Member is not duplicated");
   }
}

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

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