Share via

IRTCCollection::get__NewEnum

  • Article

The get__NewEnum property gets an enumerator for the collection.

HRESULT get__NewEnum(IUnknown**ppNewEnum);

Parameters

  • ppNewEnum
    [out] Pointer to an IUnknown interface on an enumerator object for the collection.

    Call the QueryInterface method on the returned IUnknown interface to obtain a pointer to an IEnumVARIANT enumeration interface on the collection. IEnumVARIANT provides a number of methods that you can use to iterate through the collection.

    For more information, see the following Remarks section.

Return Values

RTC methods may return an RTC_E_ constant.

Remarks

Each RTC interface that includes a method that returns a collection also includes a method that returns a pointer to an RTC enumerator interface. If you are programming in C/C++, it can be easier to call a collection's enumerator method directly to obtain an enumerator object, instead of calling the IRTCTCollection::get__NewEnum method. For example, the IRTCClientPresence::EnumerateBuddies method returns a pointer to an IRTCEnumBuddies interface. IRTCEnumBuddies provides enumeration methods for the Buddy object.

If you are programming in Visual Basic, you do not need to call this method to enumerate a collection. This is because you can invoke the method's functionality implicitly using the For...Each...in...Next... construct.

Requirements

Client: Requires Windows XP.
Server: Requires Windows Server 2003.
Redistributable: Requires Rtcdll.dll on Windows 2000, and Windows Me/98.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCCollection is defined as EC7C8096-B918-4044-94F1-E4FBA0361D5C.

See Also

IRTCCollection, IRTCClientPresence::EnumerateBuddies, IRTCEnumBuddies