IUccContainerMember.Scope 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 membership scope of this container member.

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

Syntax

'Declaration
ReadOnly Property Scope As UCC_CONTAINER_MEMBERSHIP_SCOPE

UCC_CONTAINER_MEMBERSHIP_SCOPE Scope { get; }

property UCC_CONTAINER_MEMBERSHIP_SCOPE Scope {
    UCC_CONTAINER_MEMBERSHIP_SCOPE get ();
}

/** @property */
UCC_CONTAINER_MEMBERSHIP_SCOPE get_Scope ()

function get Scope () : UCC_CONTAINER_MEMBERSHIP_SCOPE

Property Value

A value of the UCC_CONTAINER_MEMBERSHIP_SCOPE* (UCC_CONTAINER_MEMBERSHIP_SCOPE, for a .NET application) type.

Remarks

The scope of a container member defines the boundaries of the set of possible users that access the contents of an owning IUccContainer instance. The possible values of the Scope property are defined by the UCC_CONTAINER_MEMBERSHIP_SCOPE enumeration. If the specified scope of a container member is either UCC_CONTAINER_MEMBERSHIP_SCOPE.UCCCMS_DOMAIN or UCC_CONTAINER_MEMBERSHIP_SCOPE.UCCCMS_USER, then the Uri property of the IUccContainerMember instance will be filled.

Win32 COM/C++ Syntax

HRESULT get_Scope
(
   UCC_CONTAINER_MEMBERSHIP_SCOPE* penScope
);

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 is a public property of an application class that wraps an instance of the IUccContainerMember class. The property returns an Uri string if the scope of the container member is a domain or user.

public string Uri
{ 
   get
   {
      if (this.cm.Scope == UCC_CONTAINER_MEMBERSHIP_SCOPE.UCCCMS_DOMAIN || 
         this.cm.Scope == UCC_CONTAINER_MEMBERSHIP_SCOPE.UCCCMS_USER)
      {
         return this.cm.Uri;
      }
      else
      {
         return string.Empty;
      }
   }
   
}

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