DWC_TestInetAsync

Syntax

#include <dwc.h>

BOOL DWC_TestInetAsync( int timeout );

Description

Starts an internet connection test by communicating with the server for the connection test.

After calling this function, call DWC_TestInetProcess every game frame until the process executing the connection test communication terminates. If the function is called during the connection test process, it always returns FALSE.

Because the memory required at the beginning of the connection test is secured by this function, be sure to continue processing until the connection test communication process terminates and memory is automatically freed.

Because this function performs communications with the connection test server, do not call it repeatedly over a short period of time.
For checking the connection status with an access point, see the DWC_UpdateConnection function.

Arguments

timeout Timeout interval (in msec) of the connection test.
The default timeout interval of 3000 msec is applied when a value equal to or less than 0 is specified.
The test cannot be conducted normally if the timeout interval is too short.

Return Values

TRUE Connection test started.
FALSE Failed to start connection test.

Specifically, one or more of the following conditions apply.
  • There is not enough memory for dynamic allocation inside the library.
  • A connection test is already running.
  • Not inside the interval between connecting to the Internet using the DWC_ConnectInetAsync function and disconnecting from the Internet using the DWC_CleanupInet function or the DWC_CleanupInetAsync function.

See Also

DWC_TestInetProcess
DWC_UpdateConnection
DWC_ConnectInetAsync
DWC_CleanupInet
DWC_CleanupInetAsync

Revision History

2008/04/22 Added a description of the conditions under which this function returns FALSE.
2006/11/07 Initial version.


CONFIDENTIAL