Database.EnumLocks Database.EnumLocks Database.EnumLocks Method

Definition

Enumerates a list of current locks on the database.

Overloads

EnumLocks() EnumLocks() EnumLocks()

Enumerates a list of all current locks held on the database.

EnumLocks(Int32) EnumLocks(Int32) EnumLocks(Int32)

Enumerates a list of current locks held on the database for a specified system process ID.

EnumLocks() EnumLocks() EnumLocks()

Enumerates a list of all current locks held on the database.

public:
 System::Data::DataTable ^ EnumLocks();
public System.Data.DataTable EnumLocks ();
Public Function EnumLocks () As DataTable
Returns

A DataTable object value that contains a list of locks held on the database and information about the type and location of the locks. The table describes the different columns of the returned DataTable.

Column
Data type
Description.
RequestorSpid
Int32 The system process ID value of the process that is holding a lock on a database resource.
LockType
String The description of the type of lock. See the syslockinfo table for a description of different lock types.
Database
String The name of the database on which the lock is held.
Table
String The name of the table on which the lock is held. This field contains a value only if the lock is held on a table.
Index
String The name of the index on which the lock is held. This field contains a value only if the lock is held on an index.
Status
Int32 The status of the lock, which can be one of the following:
1 = Granted.
2 = Converting.
3 = Waiting.

Examples

The example runs a Server object enumeration method, but extracting the information from the <xref:System.DataTable> object is the same for Database enumeration methods.

VB

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")  

$d = new-object System.Data.Datatable  
$d = $srv.EnumCollations  

Foreach ($r in $d.Rows)  
{  
   Write-Host "============================================"  
   Foreach ($c in $d.Columns)  
   {  
      Write-Host $c.ColumnName "=" $r[$c]  
   }  
}  

EnumLocks(Int32) EnumLocks(Int32) EnumLocks(Int32)

Enumerates a list of current locks held on the database for a specified system process ID.

public:
 System::Data::DataTable ^ EnumLocks(int processId);
public System.Data.DataTable EnumLocks (int processId);
Public Function EnumLocks (processId As Integer) As DataTable
Parameters
processId
Int32 Int32 Int32

An Int32 that specifies the process ID value that uniquely identifies the process.

Returns

A DataTable object value that contains a list of locks held on the database and information about the type and location of the locks. The table describes the different columns of the returned DataTable.

Column
Data type
Description
RequestorSpid
Int32 The system process ID value of the process that is holding a lock on a database resource.
LockType
String The description of the type of lock. See the syslockinfo table for a description of different lock types.
Database
String The name of the database on which the lock is held.
Table
String The name of the table on which the lock is held. This field contains a value only if the lock is held on a table.
Index
String The name of the index on which the lock is held. This field contains a value only if the lock is held on an index.
Status
Int32 The status of the lock, which can be one of the following:
1 = Granted.
2 = Converting.
3 = Waiting.

Examples

The example runs a Server object enumeration method, but extracting the information from the DataTable object is the same for database enumeration methods.

VB

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")  

$d = new-object System.Data.Datatable  
$d = $srv.EnumCollations  

Foreach ($r in $d.Rows)  
{  
   Write-Host "============================================"  
   Foreach ($c in $d.Columns)  
   {  
      Write-Host $c.ColumnName "=" $r[$c]  
   }  
}  

Applies to