Server.EnumLocks Method ()

Enumerates a list of current locks held on the instance of Microsoft SQL Server.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Function EnumLocks As DataTable
public DataTable EnumLocks ()
public:
DataTable^ EnumLocks ()
public DataTable EnumLocks ()
public function EnumLocks () : DataTable

Return Value

A DataTable system object value that contains a list of current locks held by the specified process on the instance of SQL Server. The table describes the different columns of the returned DataTable.

Column

Data type

Description

RequestorSpid

Int32

The SQL Server process ID that uniquely identifies the process requesting the lock.

LockType

String

The type of lock. See req_mode in sys.syslockinfo (Transact-SQL).

Database

String

The name of the database that contains the lock.

Schema

String

The schema of the locked resource.

Table

String

The table that contains the lock.

Index

String

The index that contains the lock.

Status

Int32

The status of the lock. 1 for Grant, 2 for Convert, and 3 for Wait.

Remarks

Updated text:

Use this method to determine the locks that are currently held on the instance of SQL Server. The information that is returned can help you identify locking problems that might affect performance.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Call the EnumCollations method and return collation information to DataTable variable.
Dim d As DataTable
'Select the returned data into an array of DataRow.
d = srv.EnumCollations
'Iterate through the rows and display collation details for the instance of SQL Server.
Dim r As DataRow
Dim c As DataColumn
For Each r In d.Rows
    Console.WriteLine("============================================")
    For Each c In r.Table.Columns
        Console.WriteLine(c.ColumnName + " = " + r(c).ToString)
    Next
Next

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Server Class
Server Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

How to: Use an Enumeration Method that Returns a DataTable Object in Visual Basic .NET
Calling Methods
Managing Servers
sys.syslockinfo (Transact-SQL)

Change History

Release

History

New content:
  • Added code sample to the Example section.

  • Added to the description in the Remarks section.