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

Attempts to get a container with a given category.

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

Syntax

'Declaration
Function TryGetContainerWithCategory ( _
    bstrCategoryName As String, _
    <OutAttribute> ByRef ppContainer As IUccContainer _
) As Boolean

bool TryGetContainerWithCategory (
    string bstrCategoryName,
    out IUccContainer ppContainer
)

bool TryGetContainerWithCategory (
    String^ bstrCategoryName, 
    [OutAttribute] IUccContainer^% ppContainer
)

boolean TryGetContainerWithCategory (
    String bstrCategoryName, 
    /** @attribute OutAttribute() */ /** @ref */ IUccContainer ppContainer
)

Parameters

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

• ppContainer
  A value of the IUccContainer** (IUccContainer, for a .NET application) type. This returns the container containing category instances of the given category name if the container exists. This returns NULL if the container does not exist.

Return Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. This returns TRUE if the container exists and FALSE if not.

Remarks

This method can be used to determine whether a container with a given category already exists. For an existing container with the given category, the method returns the container of the largest container ID value if multiple containers contain this container member and the given category. The method returns TRUE as well. The method returns FALSE if the container does not exist.

Win32 COM/C++ Syntax

HRESULT TryGetContainerWithCategory
(
   BSTR bstrCategoryName,
   IUccContainer** ppContainer,
   VARIANT_BOOL* pbFound
);

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 Id from the container member's collection of IUccContainer instances where the instance container includes the "contactCard" category instances. In this example this.cm is a client application instance of the IUccContainerMember interface.

IUccContainer i;
if (this.cm.TryGetContainerWithCategory("contactCard", out i))
{
   Console.WriteLine("contactCard is in container " + i.Id.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

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