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

Determines whether this container member is already in a given container.

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

Syntax

'Declaration
Function IsInContainer ( _
    lContainerID As Integer _
) As Boolean

bool IsInContainer (
    int lContainerID
)

bool IsInContainer (
    int lContainerID
)

boolean IsInContainer (
    int lContainerID
)

function IsInContainer (
    lContainerID : int
) : boolean

Parameters

• lContainerID
  A value of the LONG (int, for a .NET application) type. This is the ID of the container of interest.

Return Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. This returns TRUE if this container member is in the given container. It returns FALSE otherwise.

Remarks

Win32 COM/C++ Syntax

HRESULT IsInContainer
(
   LONG lContainerID,
   VARIANT_BOOL* pfIsInContainer
);

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 displays the container member scope or Uri in a console message indicating the given member is in container zero. In this example this.cm is a client application instance of the IUccContainerMember interface.

if (cm.IsInContainer(0) == true)
{
   if (cm.Scope == UCC_CONTAINER_MEMBERSHIP_SCOPE.UCCCMS_DOMAIN ||
       cm.Scope == UCC_CONTAINER_MEMBERSHIP_SCOPE.UCCCMS_USER)
   {
      Console.WriteLine(cm.Uri + " is in container 0");
   }
   else
   {
      Console.WriteLine(cm.Scope.ToString() + " is in container 0");
   }
}

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