2.2.53 DPSP_MSG_SUPERENUMPLAYERSREPLY

The DPSP_MSG_SUPERENUMPLAYERSREPLY packet can be sent in response to a DPSP_MSG_ENUMPLAYER (section 2.2.27) message or a DPSP_MSG_ADDFORWARDREQUEST (section 2.2.11) message.

Note If the CS flag in the DPSESSIONDESC2 (section 2.2.5) structure associated with the game session is not set, implementations SHOULD use the DPSP_MSG_SUPERENUMPLAYERSREPLY message; otherwise implementations SHOULD use the DPSP_MSG_ENUMPLAYERSREPLY (section 2.2.28) message.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

DPSP_MSG_HEADER (28 bytes)

...

...

PlayerCount

GroupCount

PackedOffset

ShortcutCount

DescriptionOffset

NameOffset

PasswordOffset

DPSessionDesc (variable)

...

SessionName (variable)

...

Password (variable)

...

SuperPackedPlayer (variable)

...

DPSP_MSG_HEADER (28 bytes): Message header for this packet. The Command Value member of this field MUST be set to 41 (0x29).

PlayerCount (4 bytes): Number of players.

GroupCount (4 bytes): Number of groups.

PackedOffset (4 bytes): Offset, in octets, of the SuperPackedPlayer field from the beginning of the message.

ShortcutCount (4 bytes): Number of groups with shortcuts.

DescriptionOffset (4 bytes): MUST be set to the offset, in octets, of the DPSessionDesc field from the beginning of the message.

NameOffset (4 bytes): MUST be set to the offset, in octets, from the beginning of the message in the SessionName field. A value of zero means a null game session name.

PasswordOffset (4 bytes): MUST be set to the offset, in octets, of the Password field from the beginning of the message. A value of zero means there is no password.

DPSessionDesc (variable): MUST be set to a DPSESSIONDESC2 (section 2.2.5) structure that contains the game session description information.

SessionName (variable): MUST be set to the null-terminated Unicode string that contains the game session name.

Password (variable): If present, MUST be set to the null-terminated Unicode string that contains the password for the game session.

SuperPackedPlayer (variable): Array of DPLAYI_SUPERPACKEDPLAYER (section 2.2.3) structures. The number of elements in the array is determined by finding the sum of the PlayerCount, GroupCount, and ShortcutCount fields. The order of items in the array is fixed, and is as follows: players, groups, and shortcuts.