IDebugClient4::StartProcessServer method (dbgeng.h)

Article
02/22/2024

The StartProcessServer method starts a process server.

Syntax

HRESULT StartProcessServer(
  [in]           ULONG Flags,
  [in]           PCSTR Options,
  [in, optional] PVOID Reserved
);

Parameters

[in] Flags

Specifies the class of the targets that will be available through the process server. This must be set to DEBUG_CLASS_USER_WINDOWS.

[in] Options

Specifies the connections options for this process server. These are the same options given to the -t option of the DbgSrv command line. For details on the syntax of this string, see Activating a Process Server.

[in, optional] Reserved

Set to NULL.

Return value

This method may also return error values. See Return Values for more details.

Return code	Description
S_OK	The method was successful.

Remarks

The process server that is started will be accessible by remote clients through the transport specified in the Options parameter.

To stop the process server from the smart client, use the EndProcessServer method. To shut down the process server from the computer that it is running on, use Task Manager to end the process. If the instance of the debugger engine that used StartProcessServer is still running, it can use Execute to issue the debugger command .endsrv 0, which will end the process server (this is an exception to the usual behavior of .endsrv, which generally does not affect process servers).

For more information about process servers and remote debugging, see Process Servers, Kernel Connection Servers, and Smart Clients.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)