• Article

CursorCloseOnCommit Property

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 CursorCloseOnCommit property specifies cursor behavior when modifications made within a transaction are committed or rolled back.

Syntax

object.CursorCloseOnCommit [=value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    TRUE or FALSE

Data Type

Boolean

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetCursorCloseOnCommit(LPBOOL pRetVal);
HRESULT SetCursorCloseOnCommit(BOOL NewValue);

Remarks

If TRUE, Microsoft SQL Server cursors are closed when an action ends a transaction, such as the CommitTransaction method of the SQLServer object. TRUE is the default.

If FALSE, cursors remain open after a transaction-ending action. The cursor should be closed by the application when the cursor is no longer needed.

Setting the property affects all statements executed on the SQLServer object from which the DBOption object is selected.

Applies To:

DBOption Object