Click or drag to resize
CMSConnectionScope Class
Connection scope. Ensures that all queries within given context use the same database connection.
Inheritance Hierarchy
System.Object
  CMS.Base.DisposableObject
    CMS.Helpers.Trackable<CMSConnectionScope>
      CMS.DataEngine.CMSConnectionScope

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public class CMSConnectionScope : Trackable<CMSConnectionScope>, 
	INotCopyThreadItem

The CMSConnectionScope type exposes the following members.

Constructors
  NameDescription
Public methodCMSConnectionScope(Boolean, Boolean)
Empty constructor. Creates a new connection and ensures that all database connections during the live of this object will use that connection.
Public methodCMSConnectionScope(IDataConnection, Boolean)
Constructor. Ensures that all database connections during the live of this object will use the given connection.
Public methodCMSConnectionScope(String, Boolean, Boolean)
Constructor. Ensures that all database connections during the live of this object will use the given connection.
Top
Methods
  NameDescription
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.)
Public methodClose
Closes the connection.
Public methodDispose
Disposes the object.
(Overrides DisposableObject.Dispose().)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.)
Public methodOpen
Opens the connection.
Public methodResetConnection
Resets the connection to recover from error.
Public methodUsing
Adds the given object to the list of the allocated objects to dispose
(Inherited from DisposableObject.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Public propertyConnection
Connection of the current scope.
Public propertyConnectionString
Connection string name that the thread should use to access the database
Public propertyDisableConnectionDebug
If true, the debug is disabled on this connection
Public propertyDisableDebug
If true, the debug of queries is disabled on this connection
Public propertyDisableQueryDebug
If true, the debug of queries is disabled on this connection
Top
Remarks
To set the connection scope for the whole API (e.g. DataQuery), use the CMSConnectionContext class.
See Also