Share via

IMessenger2::MyGroups Property

  • Article

Deprecated. Retrieves the Group list contained in the Messenger object. The retrieved list is a MessengerGroups collection object that can be manipulated with the IMessengerGroups interface.

Syntax

HRESULT IMessenger2::get_MyGroups(IDispatch **ppMGroups);

Parameters

  • ppMGroups
    Return value. Pointer to a pointer to an IDispatch World Wide Web link interface. In practice, this returns the IMessengerGroups interface on the Contact List or MessengerGroups collection object.

Return Value

Returns one of the following values:

S_OK Success.
E_OUTOFMEMORY Error during list creation.
RPC_X_NULL_REF_POINTER ppMGroups is a NULL pointer.
MSGR_E_GROUPS_NOT_ENABLED The current service does not support groups.

Remarks

Some services, such as Microsoft Exchange Instant Messaging Service (IM), do not support groups. The use of this property on these services will return the error MSGR_E_GROUPS_NOT_ENABLED.

ppMGroups should be released when it is no longer needed. Retrieved lists can potentially have zero members in their collection.

If this property is called while the client is not signed in, the HRESULT will be S_OK and a true object will be returned. However, the resulting MessengerGroups collection object will have zero members (that is, it contains no valid MessengerGroups objects).

Note  This property is available for scripting languages.

Important  IMessenger2::MyGroups is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

IMessengerGroups