DirectPlayLobby3.GetConnectionSettings

The DirectPlayLobby3.GetConnectionSettings method retrieves the DirectPlayLobbyConnection object that contains all the information needed to start and connect an application. The data returned is the same data that was passed to the DirectPlayLobby3.RunApplication method by the lobby client, or set by calling the DirectPlayLobby3.SetConnectionSettings method.

object.GetConnectionSettings(applicationId As Long) _
    As DirectPlayLobbyConnection

Parameters

object

Object expression that resolves to a DirectPlayLobby3 object.

applicationId

Value that identifies which application's connection settings to retrieve when called from a lobby client (communicating with several applications). This ID number is obtained from DirectPlayLobby3.RunApplication. When called from an application (communicating with one lobby client), this parameter must be 0.

Return Values

If the method succeeds, it returns a DirectPlayLobbyConnection object.

Error Codes

If the method fails, an error is raised and Err.Number may be set to one of the following values:

See Also

DirectPlayLobby3.WaitForConnectionSettings