Share via

IUccSubscription.CategoryNames 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 collection of the names of the categories subscribed to by the local user.

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

Syntax

'Declaration
ReadOnly Property CategoryNames As IUccCollection

IUccCollection CategoryNames { get; }

property IUccCollection^ CategoryNames {
    IUccCollection^ get ();
}

/** @property */
IUccCollection get_CategoryNames ()

function get CategoryNames () : IUccCollection

Property Value

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

Remarks

This collection is read only. To learn about adding a category name to the collection, see AddCategoryName.The CategoryNames property returns an IUccCollection object that can be iterated over but not added to.Win32 COM/C++ Syntax

HRESULT get_CategoryNames
(
   IUccCollection** ppNameCollection
);

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 example below iterates on the category names collection to find a category name instance of "Containers". The foreach structure utilizes the enumerator returned by an implicit interrogation of the GetEnumerator property of the collection.

string name = "Containers";
if (_subscription.CategoryNames.Count > 0)
{
   foreach (string n in _subscription.CategoryNames)
   {
      if (n == name)
         return;
   }
}

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

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