IDirectPlayLobby3::SetLobbyMessageEvent

The IDirectPlayLobby3::SetLobbyMessageEvent method registers an event that will be set when a lobby message is received. The application must call this method if it needs to synchronize with messages. The lobby client can call this method to change the events specified in the call to the IDirectPlayLobby3::RunApplication method.

HRESULT SetLobbyMessageEvent(
  DWORD dwFlags,
  DWORD dwAppID,
  HANDLE hReceiveEvent
);

Parameters

dwFlags

Reserved; must be 0.

dwAppID

Identifies which application the event is associated with when called from a lobby client (that communicates with several applications). When called from an application (that communicates with only one lobby client), this parameter must be 0. This ID number is obtained from IDirectPlayLobby3::RunApplication.

hReceiveEvent

Event handle to be set when a message is received.

Return Values

Returns DP_OK if successful, or one of the following error values otherwise:

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dplobby.h.
  Import Library: Use dplayx.lib.

See Also

IDirectPlayLobby3::ReceiveLobbyMessage, IDirectPlayLobby3::SendLobbyMessage