ConnectionBroken Event

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The ConnectionBroken event occurs when a connected SQLServer object loses its connection to an instance of Microsoft SQL Server.

Syntax

Private Function
object
_ConnectionBroken(
Message as String
)
as
Boolean

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

  • Message
    String that contains descriptive message text.

Prototype (C/C++)

HRESULT ConnectionBroken(SQLDMO_LPCSTR Message,
LPBOOL Retry);

Remarks

SQL Distributed Management Objects (SQL-DMO) raises the ConnectionBroken event only when the AutoReConnect property of the SQLServer object is False. When AutoReConnect is True, SQL-DMO will not raise the event, even when automatic reconnection fails.

When a ConnectionBroken event handler returns True, SQL-DMO attempts to reconnect to an instance of SQL Server indicated when the Connect method of the SQLServer object connected successfully. When a ConnectionBroken event handler does not return a value, or returns False, SQL-DMO does not attempt to reconnect the SQLServer object upon return from the event handler.

Applies To:

See Also

Reference