DkmProcessLaunchRequest.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Start

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

Create(String, String, String, String, DkmProcessStartupInfo, DkmProcessLaunchModeFlags, Int32, DkmTransportConnection, DkmEngineSettings, DkmDebugLaunchSettings, DkmDataItem)	Create a new DkmProcessLaunchRequest object instance. The caller is responsible for closing the created object after they are done.
Create(String, String, String, String, DkmProcessStartupInfo, DkmProcessLaunchModeFlags, Int32, DkmTransportConnection, DkmEngineSettings, DkmDebugLaunchSettings, DkmProcessLaunchFlags, DkmDataItem)	Create a new DkmProcessLaunchRequest object instance. The caller is responsible for closing the created object after they are done. This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

Create(String, String, String, String, DkmProcessStartupInfo, DkmProcessLaunchModeFlags, Int32, DkmTransportConnection, DkmEngineSettings, DkmDebugLaunchSettings, DkmDataItem)

Create a new DkmProcessLaunchRequest object instance. The caller is responsible for closing the created object after they are done.

public:
 static Microsoft::VisualStudio::Debugger::Start::DkmProcessLaunchRequest ^ Create(System::String ^ FileName, System::String ^ Arguments, System::String ^ WorkingDirectory, System::String ^ Environment, Microsoft::VisualStudio::Debugger::Start::DkmProcessStartupInfo ^ StartupInfo, Microsoft::VisualStudio::Debugger::Start::DkmProcessLaunchModeFlags ModeFlags, int Win32Flags, Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DkmEngineSettings ^ EngineSettings, Microsoft::VisualStudio::Debugger::Start::DkmDebugLaunchSettings ^ DebugLaunchSettings, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchRequest Create (string FileName, string? Arguments, string WorkingDirectory, string? Environment, Microsoft.VisualStudio.Debugger.Start.DkmProcessStartupInfo? StartupInfo, Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchModeFlags ModeFlags, int Win32Flags, Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection Connection, Microsoft.VisualStudio.Debugger.DkmEngineSettings? EngineSettings, Microsoft.VisualStudio.Debugger.Start.DkmDebugLaunchSettings DebugLaunchSettings, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : string * string * string * string * Microsoft.VisualStudio.Debugger.Start.DkmProcessStartupInfo * Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchModeFlags * int * Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DkmEngineSettings * Microsoft.VisualStudio.Debugger.Start.DkmDebugLaunchSettings * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchRequest

Public Shared Function Create (FileName As String, Arguments As String, WorkingDirectory As String, Environment As String, StartupInfo As DkmProcessStartupInfo, ModeFlags As DkmProcessLaunchModeFlags, Win32Flags As Integer, Connection As DkmTransportConnection, EngineSettings As DkmEngineSettings, DebugLaunchSettings As DkmDebugLaunchSettings, DataItem As DkmDataItem) As DkmProcessLaunchRequest

Parameters

FileName

String

[In] Path to the executable file to launch.

Arguments

String

[In,Optional] Arguments to pass to the executable file on the command line.

WorkingDirectory

String

[In] The full path to the current directory for the process. The string can also specify a UNC path.

Environment

String

[In,Optional] A pointer to the environment block for the new process. If this parameter is NULL, the new process uses the environment of the calling process.

An environment block consists of a null-terminated block of null-terminated strings. Each string is in the following form: 'name=value\0'. Because the equal sign is used as a separator, it must not be used in the name of an environment variable.

StartupInfo

DkmProcessStartupInfo

[In,Optional] Additional information used to launch a new process. This information is contained within the 'STARTUPINFO' structure in Win32.

ModeFlags

DkmProcessLaunchModeFlags

[In] Flag traits of a DkmProcessLaunchRequest.

Win32Flags

Int32

[In] Win32 process creation flags used when launching the process. For example, CREATE_NO_WINDOW (0x08000000) could be passed to disable the creation of the console window. The following flags should never be passed, and the behavior is undefined if they are present: DEBUG_PROCESS, DEBUG_ONLY_THIS_PROCESS, CREATE_SUSPENDED, EXTENDED_STARTUPINFO_PRESENT, CREATE_SEPARATE_WOW_VDM, CREATE_SHARED_WOW_VDM, and CREATE_UNICODE_ENVIRONMENT.

Connection

DkmTransportConnection

[In] This represents a connection between the monitor and the IDE. It can either be a local connection if the monitor is running in the same process as the IDE, or it can be a remote connection. In the monitor process, there is only one connection.

EngineSettings

DkmEngineSettings

[In,Optional] Settings to use when launching this executable under the debugger. This may be omitted if the process is not being launched under the debugger (ex: Ctrl-F5).

DebugLaunchSettings

DkmDebugLaunchSettings

[In] Settings supplied during a start debugging operation from a project system or other caller of LaunchDebugTargets (or various other start debugging APIs).

DataItem

DkmDataItem

[In,Optional] Data object to add to the new DkmProcessLaunchRequest instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmProcessLaunchRequest

[Out] Result of this method call.

Create(String, String, String, String, DkmProcessStartupInfo, DkmProcessLaunchModeFlags, Int32, DkmTransportConnection, DkmEngineSettings, DkmDebugLaunchSettings, DkmProcessLaunchFlags, DkmDataItem)

Create a new DkmProcessLaunchRequest object instance. The caller is responsible for closing the created object after they are done.

This API was introduced in Visual Studio 14 RTM (DkmApiVersion.VS14RTM).

public:
 static Microsoft::VisualStudio::Debugger::Start::DkmProcessLaunchRequest ^ Create(System::String ^ FileName, System::String ^ Arguments, System::String ^ WorkingDirectory, System::String ^ Environment, Microsoft::VisualStudio::Debugger::Start::DkmProcessStartupInfo ^ StartupInfo, Microsoft::VisualStudio::Debugger::Start::DkmProcessLaunchModeFlags ModeFlags, int Win32Flags, Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Microsoft::VisualStudio::Debugger::DkmEngineSettings ^ EngineSettings, Microsoft::VisualStudio::Debugger::Start::DkmDebugLaunchSettings ^ DebugLaunchSettings, Microsoft::VisualStudio::Debugger::Start::DkmProcessLaunchFlags LaunchFlags, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchRequest Create (string FileName, string? Arguments, string WorkingDirectory, string? Environment, Microsoft.VisualStudio.Debugger.Start.DkmProcessStartupInfo? StartupInfo, Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchModeFlags ModeFlags, int Win32Flags, Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection Connection, Microsoft.VisualStudio.Debugger.DkmEngineSettings? EngineSettings, Microsoft.VisualStudio.Debugger.Start.DkmDebugLaunchSettings DebugLaunchSettings, Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchFlags LaunchFlags, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : string * string * string * string * Microsoft.VisualStudio.Debugger.Start.DkmProcessStartupInfo * Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchModeFlags * int * Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Microsoft.VisualStudio.Debugger.DkmEngineSettings * Microsoft.VisualStudio.Debugger.Start.DkmDebugLaunchSettings * Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchFlags * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchRequest

Public Shared Function Create (FileName As String, Arguments As String, WorkingDirectory As String, Environment As String, StartupInfo As DkmProcessStartupInfo, ModeFlags As DkmProcessLaunchModeFlags, Win32Flags As Integer, Connection As DkmTransportConnection, EngineSettings As DkmEngineSettings, DebugLaunchSettings As DkmDebugLaunchSettings, LaunchFlags As DkmProcessLaunchFlags, DataItem As DkmDataItem) As DkmProcessLaunchRequest

Parameters

FileName

String

[In] Path to the executable file to launch.

Arguments

String

[In,Optional] Arguments to pass to the executable file on the command line.

WorkingDirectory

String

[In] The full path to the current directory for the process. The string can also specify a UNC path.

Environment

String

[In,Optional] A pointer to the environment block for the new process. If this parameter is NULL, the new process uses the environment of the calling process.

An environment block consists of a null-terminated block of null-terminated strings. Each string is in the following form: 'name=value\0'. Because the equal sign is used as a separator, it must not be used in the name of an environment variable.

StartupInfo

DkmProcessStartupInfo

[In,Optional] Additional information used to launch a new process. This information is contained within the 'STARTUPINFO' structure in Win32.

ModeFlags

DkmProcessLaunchModeFlags

[In] Flag traits of a DkmProcessLaunchRequest.

Win32Flags

Int32

[In] Win32 process creation flags used when launching the process. For example, CREATE_NO_WINDOW (0x08000000) could be passed to disable the creation of the console window. The following flags should never be passed, and the behavior is undefined if they are present: DEBUG_PROCESS, DEBUG_ONLY_THIS_PROCESS, CREATE_SUSPENDED, EXTENDED_STARTUPINFO_PRESENT, CREATE_SEPARATE_WOW_VDM, CREATE_SHARED_WOW_VDM, and CREATE_UNICODE_ENVIRONMENT.

Connection

DkmTransportConnection

[In] This represents a connection between the monitor and the IDE. It can either be a local connection if the monitor is running in the same process as the IDE, or it can be a remote connection. In the monitor process, there is only one connection.

EngineSettings

DkmEngineSettings

[In,Optional] Settings to use when launching this executable under the debugger. This may be omitted if the process is not being launched under the debugger (ex: Ctrl-F5).

DebugLaunchSettings

DkmDebugLaunchSettings

[In] Settings supplied during a start debugging operation from a project system or other caller of LaunchDebugTargets (or various other start debugging APIs).

LaunchFlags

DkmProcessLaunchFlags

[In] Flags associated with a request to launch a process.

DataItem

DkmDataItem

[In,Optional] Data object to add to the new DkmProcessLaunchRequest instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmProcessLaunchRequest

[Out] Result of this method call.