IUccCategoryContext.get_CategoryInstances 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.

Returns a collection of the category instances of this category class in a given container.

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

Syntax

'Declaration
Function get_CategoryInstances ( _
    lContainerId As Integer _
) As IUccCollection

IUccCollection get_CategoryInstances (
    int lContainerId
)

IUccCollection^ get_CategoryInstances (
    int lContainerId
)

IUccCollection get_CategoryInstances (
    int lContainerId
)

function get_CategoryInstances (
    lContainerId : int
) : IUccCollection

Parameters

• lContainerId
  A value of the LONG (int, for a .NET application) type. This specifies the container ID.

Return Value

A value of the IUccCollection** (IUccCollection, for a .NET application) type. If it exists, this returns the category instance collection. Otherwise, it returns NULL.

Remarks

An Office Communicator client publishes category instances to containers in the set o f: 100, 200, 300, 400, and 32000. Container Id's published by custom OC clients can also be passed into this method when the local client is interested in obtaining custom container category instances.

Win32 COM/C++ Syntax

HRESULT get_CategoryInstances
(
   LONG lContainerId,
   IUccCollection** ppCategoryInstanceCollection
);

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 gets the collection of category instances belonging to container 100 for the given category context. The collection of instances is iterated over to display the contents of the Value property of each instance on the local computer console.

void _IUccCategoryContextEvents.OnCategoryInstanceAdded(
    IUccCategoryContext pCategoryCtx, 
    UccCategoryInstanceEvent pCategory)
{
   if (pCategoryCtx.get_CategoryInstances(100).Count > 0)
   {
      foreach (IUccCategoryInstance i in pCategoryCtx.get_CategoryInstances(100))
      {
         if (i.Value != null)
         {
            Console.Writeline(
               "Context:" +
               i.CategoryContext.Name +
               " Value:" +
               i.Value.ToString());
         }
      }
   }
}

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

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