Share via

IUccCollection.GetEnumerator 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.

Returns an enumerator for the collection.

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

Syntax

'Declaration
ReadOnly Property GetEnumerator As IEnumerator

IEnumerator GetEnumerator { get; }

property IEnumerator^ GetEnumerator {
    IEnumerator^ get ();
}

/** @property */
IEnumerator get_GetEnumerator ()

function get GetEnumerator () : IEnumerator

Property Value

A value of the IUnknown** (System.Collections.IEnumerator, for a .NET application) type.

Remarks

It is not necessary to explicitly call this method in client code. If using a .NET language such as C#, using the foreach keyword allows the run-time to make the call implicitly..

Win32 COM/C++ Syntax

HRESULT get__NewEnum
(
   IUnknown** ppVariantEnumerator
);

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 accepts an IUccCollection object, verifies the collection is not null and has at least one member. If these conditions are met, a string representing the object type is displayed on the local user's console. Ordinarily, a client can cast the object to the appropriate interface. For the purpose of illustration, members of the collection are treated as objects.

private void IterateCollection(IUccCollection pCollection)
{
   if (pCollection != null && pCollection.Count > 0)
   {
      foreach (object collectionItem in pCollection)
      {
         Console.WriteLine(
            "Item of type: " + 
            collectionItem.ToString() + 
            " in collection");
      }
   }
}

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

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