IUccContainer.GetCategoryInstances 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.

Gets the collection of the category instances of a specified category name held in this container.

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

Syntax

'Declaration
Function GetCategoryInstances ( _
    bstrCategoryName As String _
) As IUccCollection

IUccCollection GetCategoryInstances (
    string bstrCategoryName
)

IUccCollection^ GetCategoryInstances (
    String^ bstrCategoryName
)

IUccCollection GetCategoryInstances (
    String bstrCategoryName
)

function GetCategoryInstances (
    bstrCategoryName : String
) : IUccCollection

Parameters

• bstrCategoryName
  A value of the BSTR (string, for a .NET application) type. This specifies the category name of the category instances.

Return Value

A value of the IUccCollection** (IUccCollection, for a .NET application) type. Each element of the resultant collection is an IUccCategoryInstance object.

Remarks

The collection of category instances in a given container represent the published categories a local user makes available to remote subscribing users. The scope of remote users who can access the categories in this container is represented by the collection of container members in the given container.

Win32 COM/C++ Syntax

HRESULT GetCategoryInstances
(
   BSTR bstrCategoryName,
   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 public method is exposed by a client application class that wraps an IUccContainer instance. The property returns the collection of category instances (IUccCategoryInstance).

public IUccCollection CategoryInstanceCollection(string pCategoryName)
{
   return this._container.GetCategoryInstances(pCategoryName);
}

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

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