Ping method

Sends a ping request to the dbmlsync server to check if the connection is good and if the server is live and responding to requests.

Syntax

bool Ping( unsigned timeout )

Remarks

You must be connected to a server to call this method.

Parameters

timeout The maximum number of milliseconds to wait for the server to respond to the ping request. Use DBSC_INFINITY to wait forever.

Returns

Returns true if a response was received from the server to the ping request.

Returns false if a response to the ping request was not received. When false is returned, you can call the GetErrorInfo method to get more information about the failure. See GetErrorInfo method.

Discuss this page in DocCommentXchange.
Send feedback about this page using email.