DirectPlay8Event.TerminateSession

Called in the message handler for each session player after a call to DirectPlay8Peer.TerminateSession.

TerminateSession( _
dpnotify As DPNMSG_TERMINATE_SESSION, _
fRejectMsg As Boolean)

Parts

dpnotify

DPNMSG_TERMINATE_SESSION message type containing the result of the message send.

fRejectMsg

Parameter is not supported in this release.

Remarks

In a peer-peer session that permits host-migration, the host migrates if the current host calls DirectPlay8Peer.Close or stops responding. When this event occurs:

• Microsoft® DirectPlay® notifies all the other players that the host has left the session by calling their DirectPlay8Event.DestroyPlayer method.
• DirectPlay then notifies the remaining players of the new host by calling their DirectPlay8Event.HostMigrate method

To prevent host-migration, the current host must terminate the session by calling DirectPlay8Peer.TerminateSession. When the host terminates a session this way:

• DirectPlay calls each players' DirectPlay8Event.TerminateSession method. The hResultCode of the associated DPNMSG_TERMINATE_SESSION type will be set to DPNERR_HOSTTERMINATEDSESSION.
• DirectPlay will then generate DirectPlay8Event.DestroyPlayer calls for each player.

In a peer-peer game that does not permit host-migration, the session is terminated if the host calls DirectPlay8Peer.Close, or stops responding. When this event occurs:

• DirectPlay calls each player's DirectPlay8Event.TerminateSession method. The hResultCode of the associated DPNMSG_TERMINATE_SESSION type will be set to set to DPNERR_HOSTTERMINATEDSESSION.
• DirectPlay will then generate DirectPlay8Event.DestroyPlayer calls for each player.

In a client/server game, the session is terminated if the host calls DirectPlay8Server.Close or stops responding. When this event occurs:

• DirectPlay calls each player's DirectPlay8Event.TerminateSession method. The hResultCode of the associated DPNMSG_TERMINATE_SESSION type will be set to DPNERR_CONNECTIONLOST.
• If the server disconnected itself from the session by calling DirectPlay8Server.Close, its DirectPlay8Event.DestroyPlayer method will be called once for each player in the session, including its own player.
• Otherwise, the server's DirectPlay8Event.DestroyPlayer method is called for each client's player, but not for the server's player.