IDirectPlay8LobbyClient Interface

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8LobbyClient Interface


Applications use methods of the IDirectPlay8LobbyClient interface to enumerate and launch lobby-enabled games on a local computer, and communicate with the games when they are running. The lobby client must register a message-handler routine to process messages from the lobby and the lobbied game application.

IDirectPlay8LobbyClient Members

Close

Deletes the lobby client.

ConnectApplication

Connects a lobby-enabled application to the session specified in the DPL_CONNECT_INFO structure. If the application is not running, this method can be used to launch the application.

When the connection is successfully established, the lobbied application generates a DPL_MSGID_CONNECT system message to the message handler.

EnumLocalPrograms

Enumerates the lobbied applications that are registered on the system.

GetConnectionSettings

Retrieves the set of connection settings for the specified connection. These settings can be set through a call to the IDirectPlay8LobbyClient::ConnectApplication, IDirectPlay8LobbyClient::SetConnectionSettings, or IDirectPlay8LobbiedApplication::SetConnectionSettings method.

When you get connection settings, a reference will be added for each address object that is returned to the user. Therefore, users must be sure to call Release on each address object when they are finished with the structure.

Initialize

Registers an entry point in the lobby client's code that receives notifications on changes of state for any launched applications. The message handler also receives messages from the lobbied application. This method must be called before calling any other methods of this interface.

ReleaseApplication

Releases a lobbied application and closes the connection between the lobby client and the application. This method should be called whenever a lobby client has finished its session with an application.

Send

Sends a message to a lobbied application that was launched by this lobby client or was connected by this lobby client.

This method sends a DPL_MSGID_RECEIVE system message to the target's message handler.

SetConnectionSettings

Sets the connection settings to be associated with the specified connection. Calling this method will generate a DPL_MSGID_CONNECTION_SETTINGS message to be sent to the client specified by hConnection.

When you set connection settings, the lobby application will add a reference to each of the address objects specified in the call.

Interface Information

Inherits fromIUnknown
Headerdplobby8.h
Minimum operating systems Windows 98, Pocket PC 2002

© 2003 Microsoft Corporation. All rights reserved.