DirectPlayEnumPlayers.GetFlags

The DirectPlayEnumPlayers.GetFlags method retrieves miscellaneous information about an enumerated player or group.

object.GetFlags(index As Long) As Long 

Parameters

object

Object expression that resolves to a DirectPlayEnumPlayers object.

index

Element of the enumeration object for which to retrieve data.

Return Values

The method returns the flags for a player. These include flags that were passed into the method that created the enumeration, combined with additional information about the particular player or group.

DIRECTPLAYENUMGROUPS_ALL

All groups in this session.

DIRECTPLAYENUMGROUPS_LOCAL

Groups created locally by this DirectPlay object.

DIRECTPLAYENUMGROUPS_REMOTE

Groups created by remote DirectPlay objects.

DIRECTPLAYENUMGROUPS_SESSION

Groups for the identified session.

DIRECTPLAYENUMGROUPS_SHORTCUT

Groups that are added to the group using DirectPlay4.AddGroupToGroup. (A shortcut is a link to another group).

DIRECTPLAYENUMGROUPS_STAGINGAREA

Groups in the group that are staging areas. (Staging areas are used to marshal players together in order to launch a new session.)

DIRECTPLAYENUMPLAYERS_LOCAL

Players created locally by this DirectPlay object.

DIRECTPLAYENUMPLAYERS_OWNER

The player that is the owner of this group.

DIRECTPLAYENUMPLAYERS_REMOTE

Players created by remote DirectPlay objects.

DIRECTPLAYENUMPLAYERS_SERVERPLAYER

The server player.

DIRECTPLAYENUMPLAYERS_SESSION

Players for the identified session. This flag can only be used if there is no current open session. This flag cannot be used in a lobby session.

DIRECTPLAYENUMPLAYERS_SPECTATOR

Players who are spectators.

Error Codes

If the method fails, an error is raised and Err.Number will be set.

See Also

DirectPlay4.GetDPEnumGroups, DirectPlay4.GetDPEnumGroupsInGroup, DirectPlay4.GetDPEnumPlayers, DirectPlay4.GetDPEnumGroupPlayers