Process::GetProcessById Method (Int32)

Returns a new Process component, given the identifier of a process on the local computer.

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

public:
static Process^ GetProcessById(
	int processId
)

Parameters

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

Return Value

Type: System.Diagnostics::Process
A Process component that is associated with the local process resource identified by the processId parameter.

ExceptionCondition
ArgumentException

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

InvalidOperationException

The process was not started by this object.

Use this method to create a new Process component and associate it with a process resource on the local computer. The process resource must already exist on the computer, because GetProcessById(Int32) 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(Int32) throws an exception if you pass it an expired identifier.

On any particular computer, the identifier of a process is unique. GetProcessById(Int32) returns one process at most. If you want to get all the processes running a particular application, use GetProcessesByName(String). If multiple processes exist on the computer running the specified application, GetProcessesByName(String) 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.

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.


#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

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

  • LinkDemand 

    for full trust for the immediate caller. This member cannot be used by partially trusted code.

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft