IMessengerContacts::_NewEnum property

[_NewEnum is no longer available for use as of Windows Vista. See Windows Messenger for more information.]

Enumerates the MessengerContact objects in a collection.

This property is read-only.

Syntax

HRESULT get__NewEnum(
  [out, retval] IUnknown **ppUnknown
);

Property value

Return value. Address of a pointer to the IUnknown interface on the copy.

Error codes

Returns one of the following values.

Name Meaning
S_OK
Success.
RPC_X_NULL_REF_POINTER
ppUnknown is a NULL pointer.
E_OUTOFMEMORY
Failed during copy.

Remarks

_NewEnum returns a copy of the current collection object. It is a standard method in any collection object. This avoids problems if multiple users are accessing the same remote object and assures that objects in the collections will not change during a traverse of the list.

If this method is called while the client is offline, the returned object is a working copy from an object perspective. However, if the copy is obtained while the client is offline, the contact list will always have zero members and zero count. This should be avoided.

Note

This property is available for scripting languages.

Requirements

End of client support
Windows XP
End of server support
Windows Server 2003
Header
Msgrua.h
IDL
Msgrua.idl
DLL
Msgsc.dll

See also

IMessengerContacts