Process.GetProcessById Method (Int32, String) (System.Diagnostics)

GetProcessById Method (Int32, Strin...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

Process.GetProcessById Method (Int32, String)

Returns a new Process component, given a process identifier and the name of a computer on the network.

Namespace: System.Diagnostics
Assembly: System (in system.dll)

Syntax

Visual Basic (Declaration)

Public Shared Function GetProcessById ( _
    processId As Integer, _
    machineName As String _
) As Process

Visual Basic (Usage)

Dim processId As Integer
Dim machineName As String
Dim returnValue As Process

returnValue = Process.GetProcessById(processId, machineName)

public static Process GetProcessById (
    int processId,
    string machineName
)

C++

public:
static Process^ GetProcessById (
    int processId, 
    String^ machineName
)

public static Process GetProcessById (
    int processId, 
    String machineName
)

JScript

public static function GetProcessById (
    processId : int, 
    machineName : String
) : Process

Parameters

processId: The system-unique identifier of a process resource.

machineName: The name of a computer on the network.

Return Value

A Process component that is associated with a remote process resource identified by the processId parameter.

Exceptions

Exception type	Condition
ArgumentException	The process specified by the processId parameter is not running. The identifier might be expired. -or- The machineName parameter syntax is invalid. The name might have length zero (0).
ArgumentNullException	The machineName parameter is a null reference (Nothing in Visual Basic).

Exception type

Condition

ArgumentException

The process specified by the processId parameter is not running. The identifier might be expired.

-or-

The machineName parameter syntax is invalid. The name might have length zero (0).

ArgumentNullException

The machineName parameter is a null reference (Nothing in Visual Basic).

Remarks

Use this method to create a new Process component and associate it with a process resource on a remote computer on the network. The process resource must already exist on the specified computer, because GetProcessById does not create a system resource, but rather associates a resource with an application-generated Process component. A process Id can be retrieved only for a process that is currently running on the computer. After the process terminates, GetProcessById throws an exception if you pass it an expired identifier.

On any particular computer, the identifier of a process is unique. GetProcessById returns one process at most. If you want to get all the processes running a particular application, use GetProcessesByName. If multiple processes exist on the computer running the specified application, GetProcessesByName returns an array containing all the associated processes. You can query each of these processes in turn for its identifier. The process identifier can be viewed in the Processes panel of the Windows Task Manager. The PID column displays the process identifier that is assigned to a process.

If you do not specify a machineName, the local computer is used. Alternatively, you can specify the local computer by setting machineName to the value "." or to an empty string ("").

Windows 98, Windows Millennium Edition Platform Note: The machineName parameter is not supported on Windows 98 or Windows Millennium Edition (Windows Me).

Example

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>
   Class MyProcess
      
      
      
      
      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
       
      
      
      
      Shared Sub Main()
         
         Dim myProcess As New MyProcess()
         
         
         myProcess.BindToRunningProcesses()
      End Sub 'Main 
   End Class 'MyProcess
End Namespace 'MyProcessSample

using System;
using System.Diagnostics;
using System.ComponentModel;

namespace MyProcessSample
{
    /// <summary>
    /// Shell for the sample.
    /// </summary>
    class MyProcess
    {
        
       
        
        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");
            
        }
        


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

            myProcess.BindToRunningProcesses();

            }    
    }
}

C++

#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.
   array<Process^>^localByName = Process::GetProcessesByName( "notepad" );
   
   // Get all instances of Notepad running on the specific
   // computer.
   // 1. Using the computer alias (do not precede with "\\").
   array<Process^>^remoteByName = Process::GetProcessesByName( "notepad", "myComputer" );
   
   // 2. Using an IP address to specify the machineName parameter. 
   array<Process^>^ipByName = Process::GetProcessesByName( "notepad", "169.0.0.0" );
   
   // Get all processes running on the local computer.
   array<Process^>^localAll = Process::GetProcesses();
   
   // Get all processes running on the remote computer.
   array<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" );
}

.NET Framework Security

SecurityPermission for calling members of Process. Demand value: LinkDemand; Named Permission Sets: FullTrust.

Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

Reference

Process Class
Process Members
System.Diagnostics Namespace
Id
MachineName
GetProcessesByName
GetProcesses
GetCurrentProcess