IDirectPlay8LobbiedApplication::UpdateStatus Method

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8LobbiedApplication::UpdateStatus Method


Updates the status of a connected lobby client.

Syntax

HRESULT UpdateStatus(      
    const DPNHANDLE hConnection,     const DWORD dwStatus,     const DWORD dwFlags );

Parameters

hConnection
[in] Variable of type DPNHANDLE that specifies the lobby client. You may also specify the following flag.
DPLHANDLE_ALLCONNECTIONS
The status update will be sent to all lobby clients to which you are connected.
dwStatus
[in] Variable of type DWORD that is filled with one of the following values that indicate the status between the lobby client and the lobbied application.
DPLSESSION_CONNECTED
The lobby client and lobbied application are currently connected.
DPLSESSION_COULDNOTCONNECT
The lobby client was not able to connect to the lobbied application.
DPLSESSION_DISCONNECTED
The lobby client and lobbied application are currently disconnected.
DPLSESSION_TERMINATED
The connection between the lobby client and lobbied application has been terminated.
DPLSESSION_HOSTMIGRATED
The peer object associated with the connection is involved in a session where a host migration takes place and the local client is not the new host.
DPLSESSION_HOSTMIGRATEDHERE
The peer object associated with the connection is involved in a session where a host migration takes place and the local client becomes the new host.
dwFlags
[in] Reserved, must be 0.

Return Value

Returns S_OK if successful, or one of the following error values.

DPNERR_INVALIDHANDLEThe handle specified is invalid.
DPNERR_INVALIDPARAMOne or more of the parameters passed to the method are invalid.



© 2003 Microsoft Corporation. All rights reserved.