IDirectPlay8Client Interface

Applications use the methods of the IDirectPlay8Client interface to create and manage client applications for client/server sessions.

IDirectPlay8Client Members

CancelAsyncOperation
Cancels asynchronous requests.
Close
Closes the open connection to a session and uninitializes the IDirectPlay8Client object. This method must be called on any object that is successfully initialized with a call to the IDirectPlay8Client::Initialize method.
Connect
Establishes the connection to the server.
EnumHosts
Enumerates applications that host Microsoft® DirectPlay® games.
EnumServiceProviders
Enumerates the registered service providers available to the application.
GetApplicationDesc
Retrieves the full application description for the connected application.
GetCaps
Retrieves the DPN_CAPS or DPN_CAPS_EX structure for the current interface.
GetConnectionInfo
Retrieves statistical information about the connection between the local client and the server.
GetSendQueueInfo
Used by the application to monitor the size of the send queue. DirectPlay does not send messages faster than the receiving computer can process them. As a result, if the sending computer is sending faster than the receiver can receive, messages accumulate in the sender's queue. If the application registers that the send queue is growing too large, it should decrease the rate that messages are sent.
GetServerAddress
Retrieves the address of the server for the session.
GetServerInfo
Retrieves the data set for the server set by the call to the IDirectPlay8Server::SetServerInfo method.
GetSPCaps
Retrieves the DPN_SP_CAPS structure for the specified service provider.
Initialize
Registers an entry point in the client's code that receives the messages from the IDirectPlay8Client interface and from the server. This method must be called before calling any other methods of this interface.
RegisterLobby
Allows launched applications to automatically propagate game status to the lobby.
ReturnBuffer
Retrieves message buffers provided to the application through the pReceiveData member of the DPN_MSGID_RECEIVE system message. If the user's message handler returns DPNSUCCESS_PENDING to the RECEIVE callback, DirectPlay assumes ownership of the buffer has been transferred to the application, and neither frees nor modifies it until ownership is returned to DirectPlay through this call.
Send
Transmits data to the server. The message can be sent synchronously or asynchronously.
SetCaps
Sets the DPN_CAPS or DPN_CAPS_EX structure for the current interface.
SetClientInfo
Sets the static settings of a client with an application. Call this method before connecting to relay basic player information to the application. When the client successfully connects with the application, the server can retrieve information obtained through this method by calling the IDirectPlay8Server::GetClientInfo method.
SetSPCaps
Sets the DPN_SP_CAPS structure for the specified service provider.

Interface Information

Inherits from IUnknown
Minimum operating systems Windows 98, Pocket PC 2002

CancelAsyncOperation	Cancels asynchronous requests.
Close	Closes the open connection to a session and uninitializes the IDirectPlay8Client object. This method must be called on any object that is successfully initialized with a call to the IDirectPlay8Client::Initialize method.
Connect	Establishes the connection to the server.
EnumHosts	Enumerates applications that host Microsoft® DirectPlay® games.
EnumServiceProviders	Enumerates the registered service providers available to the application.
GetApplicationDesc	Retrieves the full application description for the connected application.
GetCaps	Retrieves the DPN_CAPS or DPN_CAPS_EX structure for the current interface.
GetConnectionInfo	Retrieves statistical information about the connection between the local client and the server.
GetSendQueueInfo	Used by the application to monitor the size of the send queue. DirectPlay does not send messages faster than the receiving computer can process them. As a result, if the sending computer is sending faster than the receiver can receive, messages accumulate in the sender's queue. If the application registers that the send queue is growing too large, it should decrease the rate that messages are sent.
GetServerAddress	Retrieves the address of the server for the session.
GetServerInfo	Retrieves the data set for the server set by the call to the IDirectPlay8Server::SetServerInfo method.
GetSPCaps	Retrieves the DPN_SP_CAPS structure for the specified service provider.
Initialize	Registers an entry point in the client's code that receives the messages from the IDirectPlay8Client interface and from the server. This method must be called before calling any other methods of this interface.
RegisterLobby	Allows launched applications to automatically propagate game status to the lobby.
ReturnBuffer	Retrieves message buffers provided to the application through the pReceiveData member of the DPN_MSGID_RECEIVE system message. If the user's message handler returns DPNSUCCESS_PENDING to the RECEIVE callback, DirectPlay assumes ownership of the buffer has been transferred to the application, and neither frees nor modifies it until ownership is returned to DirectPlay through this call.
Send	Transmits data to the server. The message can be sent synchronously or asynchronously.
SetCaps	Sets the DPN_CAPS or DPN_CAPS_EX structure for the current interface.
SetClientInfo	Sets the static settings of a client with an application. Call this method before connecting to relay basic player information to the application. When the client successfully connects with the application, the server can retrieve information obtained through this method by calling the IDirectPlay8Server::GetClientInfo method.
SetSPCaps	Sets the DPN_SP_CAPS structure for the specified service provider.

Inherits from	IUnknown
Minimum operating systems	Windows 98, Pocket PC 2002