Microsoft SDK for Java

enumGroups

This method of the DirectPlay2 Class enumerates the groups available to a session. Use the stopEnumGroups method to stop the enumeration.

Syntax

public void enumGroups(_Guid sessionGuid, IEnumPlayersCallback2 callback, IUnknown context, int flags);

Parameters

sessionGuid The GUID of the DirectPlay session of interest. This parameter must be set to NULL unless the DPENUMPLAYERS_SESSION flag is specified.
callback The callback interface that contains the callback function to be called for every group in the session.
context A caller-defined context that is passed to each enumeration callback.
flags The value can be 0 or DPENUMPLAYERS_SESSION. This flag is passed to the callback function.

Remarks

By default, this method will enumerate using the local player list for the current session. The DPENUMPLAYERS_SESSION flag can be used, along with a session instance GUID, to request that a session's host provide its list for enumeration. This method cannot be called from within an enumSessions enumeration. Furthermore, use of the DPENUMPLAYERS_SESSION flag with this method must occur after the enumSessions method has been called and before any calls to close or open.

See Also

createGroup, destroyGroup, enumSessions, stopEnumGroups

© 1999 Microsoft Corporation. All rights reserved. Terms of use.