IRTCCollection::_NewEnum
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method gets an enumerator for the collection.
Syntax
HRESULT get__NewEnum(
IUnknown** ppNewEnum
);
Parameters
- ppNewEnum
[out] Pointer to the IUnknown interface on the collection object. This method adds a reference to the collection object, which the caller is responsible for releasing.
Return Value
This method can return an RTC_E_ constant.
Remarks
The application should call the QueryInterface method on the retrieved IUnknown interface to obtain a pointer to an IEnumVARIANT enumeration interface on the collection. IEnumVARIANT provides a number of methods that the application can use to iterate through the collection.
Each RTC interface that includes a method retrieving a collection also includes a method that gets a pointer to an RTC enumerator interface. If you are programming in C or C++, it can be easier for the application to call a collection's enumerator method directly to obtain an enumerator object, instead of calling IRTCCollection::_NewEnum. For example, the IRTCClientPresence::EnumerateBuddies method retrieves a pointer to an IRTCEnumBuddies interface. IRTCEnumBuddies provides enumeration methods for the Buddy object.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
See Also
Reference
IRTCCollection
IRTCClientPresence::EnumerateBuddies
IRTCEnumBuddies