Server.EnumProcesses Server.EnumProcesses Server.EnumProcesses Method

Definition

Enumerates a list of processes running on the instance of SQL Server.

Overloads

EnumProcesses() EnumProcesses() EnumProcesses()

Enumerates a list of processes running on the instance of SQL Server.

EnumProcesses(Boolean) EnumProcesses(Boolean) EnumProcesses(Boolean)

Enumerates a list of processes running on the instance of SQL Server with the option to exclude system processes.

EnumProcesses(Int32) EnumProcesses(Int32) EnumProcesses(Int32)

Enumerates a list of information about the specified process.

EnumProcesses(String) EnumProcesses(String) EnumProcesses(String)

Enumerates a list of processes running on the instance of SQL Server that are associated with the specified login.

EnumProcesses() EnumProcesses() EnumProcesses()

Enumerates a list of processes running on the instance of SQL Server.

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

A DataTable object value that contains a list of processes running on the instance of SQL Server. The table describes the different columns of the returned DataTable.

Column
Data type
Description
Urn
String The URN string that represents the process.
"Server[@Name='PCNAME']/Process[@Spid='51']", for example.
Name
String The name of the process.
Spid
Int32 The SQL Server session ID that uniquely identifies the process, see the session_id column in sys.dm_exec_sessions (Transact-SQL).
Login
String The login running the process.
Host
String The name of the computer on which the process is running.
Status
String The status of the process. Running and sleeping, for example.
Command
String The command currently being executed.
Database
String The database is which the process is running.
Cpu
Int32 The cumulative time taken by the process in milliseconds. See the cpu_time column in sys.dm_exec_sessions (Transact-SQL).
MemUsage
Int32 The number of pages in the procedure cache that are currently allocated to the process. A negative number indicates that the process is freeing up memory allocated by another process.
BlockingSpid
Int16 The SQL Server procedure ID of the procedure that is blocking the referenced procedure..
IsSystem
Boolean The value that specifies whether the process is a system process or not.
Program
String The name of the program the process
ExecutionContextID
Int16 The ID value that uniquely identifies the execution context under which the process is running.

Examples

C#

Server srv = new Server("(local)");  

DataTable d = srv.EnumProcesses();  
foreach (DataRow r in d.Rows)  
{  
   Console.WriteLine("============================================");  
   foreach(DataColumn c in d.Columns)  
   {  
      Console.WriteLine(c.ColumnName + " = " + r[c].ToString());  
   }  
}  

PowerShell

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

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

Remarks

Use this method to enumerate the processes that are currently running on the instance of SQL Server.

EnumProcesses(Boolean) EnumProcesses(Boolean) EnumProcesses(Boolean)

Enumerates a list of processes running on the instance of SQL Server with the option to exclude system processes.

public:
 System::Data::DataTable ^ EnumProcesses(bool excludeSystemProcesses);
public System.Data.DataTable EnumProcesses (bool excludeSystemProcesses);
Public Function EnumProcesses (excludeSystemProcesses As Boolean) As DataTable
Parameters
excludeSystemProcesses
Boolean Boolean Boolean

A Boolean value that specifies whether to include system processes in the results.

If True, system processes are excluded.

If False, system processes are included.

Returns

A DataTable object value that contains a list of processes running on the instance of SQL Server. The table describes the different columns of the returned DataTable.

Column
Data type
Description
Urn
String The URN string that represents the process.
"Server[@Name='PCNAME']/Process[@Spid='51']", for example.
Name
String The name of the process.
Spid
Int32 The SQL Server session ID that uniquely identifies the process, see the session_id column in sys.dm_exec_sessions (Transact-SQL).
Login
String The login running the process.
Host
String The name of the computer on which the process is running.
Status
String The status of the process. Running and sleeping, for example.
Command
String The command currently being executed.
Database
String The database is which the process is running.
Cpu
Int32 The cumulative time taken by the process in milliseconds. See the cpu_time column in sys.dm_exec_sessions (Transact-SQL).
MemUsage
Int32 The number of pages in the procedure cache that are currently allocated to the process. A negative number indicates that the process is freeing up memory allocated by another process.
BlockingSpid
Int16 The SQL Server procedure ID of the procedure that is blocking the referenced procedure..
IsSystem
Boolean The value that specifies whether the process is a system process or not.
Program
String The name of the program the process
ExecutionContextID
Int16 The ID value that uniquely identifies the execution context under which the process is running.

Examples

C#

Server srv = new Server("(local)");  

DataTable d = srv.EnumProcesses(false);  
foreach (DataRow r in d.Rows)  
{  
   Console.WriteLine("============================================");  
   foreach(DataColumn c in d.Columns)  
   {  
      Console.WriteLine(c.ColumnName + " = " + r[c].ToString());  
   }  
}  

PowerShell

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

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

EnumProcesses(Int32) EnumProcesses(Int32) EnumProcesses(Int32)

Enumerates a list of information about the specified process.

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

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

Returns

A DataTable object value that contains a list of processes running on the instance of SQL Server. The table describes the different columns of the returned DataTable.

Column
Data type
Description
Urn
String The URN string that represents the process.
"Server[@Name='PCNAME']/Process[@Spid='51']", for example.
Name
String The name of the process.
Spid
Int32 The SQL Server session ID that uniquely identifies the process, see the session_id column in sys.dm_exec_sessions (Transact-SQL).
Login
String The login running the process.
Host
String The name of the computer on which the process is running.
Status
String The status of the process, such as. running or sleeping.
Command
String The command currently being executed.
Database
String The database is which the process is running.
Cpu
Int32 The cumulative time taken by the process in milliseconds. See the cpu_time column in sys.dm_exec_sessions (Transact-SQL).
MemUsage
Int32 The number of pages in the procedure cache that are currently allocated to the process. A negative number indicates that the process is freeing up memory allocated by another process.
BlockingSpid
Int16 The SQL Server procedure ID of the procedure that is blocking the referenced procedure..
IsSystem
Boolean The value that specifies whether the process is a system process or not.
Program
String The name of the program the process
ExecutionContextID
Int16 The ID value that uniquely identifies the execution context under which the process is running.

Examples

C#

Server srv = new Server("(local)");  

DataTable d = srv.EnumProcesses(1);  
foreach (DataRow r in d.Rows)  
{  
   Console.WriteLine("============================================");  
   foreach(DataColumn c in d.Columns)  
   {  
      Console.WriteLine(c.ColumnName + " = " + r[c].ToString());  
   }  
}  

PowerShell

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

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

Remarks

Use this method to enumerate the processes that are currently running on the instance of SQL Server.

EnumProcesses(String) EnumProcesses(String) EnumProcesses(String)

Enumerates a list of processes running on the instance of SQL Server that are associated with the specified login.

public:
 System::Data::DataTable ^ EnumProcesses(System::String ^ loginName);
public System.Data.DataTable EnumProcesses (string loginName);
Public Function EnumProcesses (loginName As String) As DataTable
Parameters
loginName
String String String

A String value that specifies the login associated with the processes running on the instance of SQL Server.

Returns

A DataTable object value that contains a list of processes running on the instance of SQL Server. The table describes the different columns of the returned DataTable.

Column
Data type
Description
Urn
String The URN string that represents the process.
"Server[@Name='PCNAME']/Process[@Spid='51']", for example.
Name
String The name of the process.
Spid
Int32 The SQL Server session ID that uniquely identifies the process, see the session_id column in sys.dm_exec_sessions (Transact-SQL).
Login
String The login running the process.
Host
String The name of the computer on which the process is running.
Status
String The status of the process. Running and sleeping, for example.
Command
String The command currently being executed.
Database
String The database is which the process is running.
Cpu
Int32 The cumulative time taken by the process in milliseconds. See the cpu_time column in sys.dm_exec_sessions (Transact-SQL).
MemUsage
Int32 The number of pages in the procedure cache that are currently allocated to the process. A negative number indicates that the process is freeing up memory allocated by another process.
BlockingSpid
Int16 The SQL Server procedure ID of the procedure that is blocking the referenced procedure..
IsSystem
Boolean The value that specifies whether the process is a system process or not.
Program
String The name of the program the process
ExecutionContextID
Int16 The ID value that uniquely identifies the execution context under which the process is running.

Examples

C#

Server srv = new Server("(local)");  

DataTable d = srv.EnumProcesses("sa");  
foreach (DataRow r in d.Rows)  
{  
   Console.WriteLine("============================================");  
   foreach(DataColumn c in d.Columns)  
   {  
      Console.WriteLine(c.ColumnName + " = " + r[c].ToString());  
   }  
}  

PowerShell

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

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

Remarks

Use this method to enumerate the processes that are currently running on the instance of SQL Server.

Applies to