Export (0) Print
Expand All

Process.GetProcessesByName Method (String)

.NET Framework 1.1

Creates an array of new Process components and associates them with all the process resources on the local computer that share the specified process name.

[Visual Basic]
Overloads Public Shared Function GetProcessesByName( _
   ByVal processName As String _
) As Process()
[C#]
public static Process[] GetProcessesByName(
 string processName
);
[C++]
public: static Process* GetProcessesByName(
 String* processName
) [];
[JScript]
public static function GetProcessesByName(
   processName : String
) : Process[];

Parameters

processName
The friendly name of the process.

Return Value

An array of type Process that represents the process resources running the specified application or file.

Exceptions

Exception Type Condition
InvalidOperationException There are problems accessing the performance counter API's used to get process information. This exception is specific to Windows NT, Windows 2000, and Windows XP.

Remarks

Use this method to create an array of new Process components and associate them with all the process resources that are running the same executable file on the local computer. The process resources must already exist on the computer, because GetProcessesByName does not create system resources but rather associates them with application-generated Process components. A processName can be specified for an executable file that is not currently running on the local computer, so the array the method returns can be empty.

The process name is a friendly name for the process, such as Outlook, that does not include the .exe extension or the path. GetProcessesByName is helpful for getting and manipulating all the processes that are associated with the same executable file. For example, you can pass an executable file name as the processName parameter, in order to shut down all the running instances of that executable file.

Although a process Id is unique to a single process resource on the system, multiple processes on the local computer can be running the application specified by the processName parameter. Therefore, GetProcessById returns one process at most, but GetProcessesByName returns an array containing all the associated processes. If you need to manipulate the process using standard API calls, you can query each of these processes in turn for its identifier. You cannot access process resources through the process name alone but, once you have retrieved an array of Process components that have been associated with the process resources, you can start, terminate, and otherwise manipulate the system resources.

Example

[Visual Basic, C#, C++] The following example retrieves information of the current process, all instances of Notepad running on the local computer, all instances of Notepad running on a specific computer using the computer alias and an IP address, all processes running on the local computer and a remote computer, a specific process on the local computer or a remote computer using the process id.

[Visual Basic] 
Imports System
Imports System.Diagnostics
Imports System.ComponentModel


Namespace MyProcessSample
    _
   '/ <summary>
   '/ Shell for the sample.
   '/ </summary>
   Public Class MyProcess
      
      
      
      
      Public Sub BindToRunningProcesses()
         ' Get the current process.
         Dim currentProcess As Process = Process.GetCurrentProcess()
         
         
         ' Get all instances of Notepad running on the local
         ' computer.
         Dim localByName As Process() = Process.GetProcessesByName("notepad")
         
         
         ' Get all instances of Notepad running on the specifiec
         ' computer.
         ' 1. Using the computer alias (do not precede with "\\").
         Dim remoteByName As Process() = Process.GetProcessesByName("notepad", "myComputer")
         
         ' 2. Using an IP address to specify the machineName parameter. 
         Dim ipByName As Process() = Process.GetProcessesByName("notepad", "169.0.0.0")
         
         
         ' Get all processes running on the local computer.
         Dim localAll As Process() = Process.GetProcesses()
         
         
         ' Get all processes running on the remote computer.
         Dim remoteAll As Process() = Process.GetProcesses("myComputer")
         
         
         ' Get a process on the local computer, using the process id.
         Dim localById As Process = Process.GetProcessById(1234)
         
         
         ' Get a process on a remote computer, using the process id.
         Dim remoteById As Process = Process.GetProcessById(2345, "myComputer")
      End Sub 'BindToRunningProcesses
       
      
      
      
      Public Shared Sub Main()
         
         Dim myProcess As New MyProcess()
         
         
         myProcess.BindToRunningProcesses()
      End Sub 'Main 
   End Class 'MyProcess
End Namespace 'MyProcessSample

[C#] 
using System;
using System.Diagnostics;
using System.ComponentModel;

namespace MyProcessSample
{
    /// <summary>
    /// Shell for the sample.
    /// </summary>
    public class MyProcess
    {
        
       
        
        public void BindToRunningProcesses()
        {
            // Get the current process.
            Process currentProcess = Process.GetCurrentProcess();

            
            // Get all instances of Notepad running on the local
            // computer.
            Process [] localByName = Process.GetProcessesByName("notepad");

            
            // Get all instances of Notepad running on the specifiec
            // computer.
            // 1. Using the computer alias (do not precede with "\\").
            Process [] remoteByName = Process.GetProcessesByName("notepad", "myComputer");
            
            // 2. Using an IP address to specify the machineName parameter. 
            Process [] ipByName = Process.GetProcessesByName("notepad", "169.0.0.0");
            
            
            // Get all processes running on the local computer.
            Process [] localAll = Process.GetProcesses();

            
            // Get all processes running on the remote computer.
            Process [] remoteAll = Process.GetProcesses("myComputer");

            
            // Get a process on the local computer, using the process id.
            Process localById = Process.GetProcessById(1234);

            
            // Get a process on a remote computer, using the process id.
            Process remoteById = Process.GetProcessById(2345, "myComputer");
            
        }
        


        public static void Main()
        {
                
                   MyProcess myProcess = new MyProcess();
            

            myProcess.BindToRunningProcesses();

            }    
    }
}

[C++] 
#using <mscorlib.dll>
#using <System.dll>

using namespace System;
using namespace System::Diagnostics;
using namespace System::ComponentModel;

int main() {
    // Get the current process.
    Process* currentProcess = Process::GetCurrentProcess();

    // Get all instances of Notepad running on the local
    // computer.
    Process* localByName[] = Process::GetProcessesByName(S"notepad");

    // Get all instances of Notepad running on the specific
    // computer.
    // 1. Using the computer alias (do not precede with "\\").
    Process* remoteByName[] = Process::GetProcessesByName(S"notepad", S"myComputer");

    // 2. Using an IP address to specify the machineName parameter. 
    Process* ipByName[] = Process::GetProcessesByName(S"notepad", S"169.0.0.0");

    // Get all processes running on the local computer.
    Process* localAll[] = Process::GetProcesses();

    // Get all processes running on the remote computer.
    Process* remoteAll[] = Process::GetProcesses(S"myComputer");

    // Get a process on the local computer, using the process id.
    Process* localById = Process::GetProcessById(1234);

    // Get a process on a remote computer, using the process id.
    Process* remoteById = Process::GetProcessById(2345, S"myComputer");
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Process Class | Process Members | System.Diagnostics Namespace | Process.GetProcessesByName Overload List | ProcessName | GetProcessById | GetProcesses | GetCurrentProcess

Show:
© 2014 Microsoft