DkmDeploymentCommand.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.DefaultPort

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Creates a new DkmDeploymentCommand object. The command will not begin executing until Start is called. The caller is responsible for closing the created object after they are done.

public:
 static Microsoft::VisualStudio::Debugger::DefaultPort::DkmDeploymentCommand ^ Create(Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection ^ Connection, Guid SourceId, System::String ^ RemoteExecutable, System::String ^ Arguments, System::String ^ CurrentDirectory, Microsoft::VisualStudio::Debugger::DefaultPort::DkmDeploymentCommandFlags Flags, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.DefaultPort.DkmDeploymentCommand Create (Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection Connection, Guid SourceId, string RemoteExecutable, string Arguments, string CurrentDirectory, Microsoft.VisualStudio.Debugger.DefaultPort.DkmDeploymentCommandFlags Flags, Microsoft.VisualStudio.Debugger.DkmDataItem DataItem);

static member Create : Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection * Guid * string * string * string * Microsoft.VisualStudio.Debugger.DefaultPort.DkmDeploymentCommandFlags * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.DefaultPort.DkmDeploymentCommand

Public Shared Function Create (Connection As DkmTransportConnection, SourceId As Guid, RemoteExecutable As String, Arguments As String, CurrentDirectory As String, Flags As DkmDeploymentCommandFlags, DataItem As DkmDataItem) As DkmDeploymentCommand

Parameters

Connection

DkmTransportConnection

[In] Transport connection to the target where the command should execute.

SourceId

Guid

[In] Identifies the source of an object. SourceIds are used to enable filtering in scenarios when multiple components may be creating instances of a class. For example, source ids can be used to determine if a breakpoint comes from the AD7 AL (ex: user breakpoint, or other breakpoint visible at the SDM level) instead of a breakpoint which may be created by another component (for example an internal breakpoint used for stepping).

RemoteExecutable

String

[In] Path to the remote executable. Environment variables will be expanded (ex: %TMP%\mycommand.exe). If this is not a full path, the remote debugger will look next to itself, and then search the PATH environment variable.

Arguments

String

[In,Optional] Arguments to pass to the remote command. This value may be null to pass no arguments.

CurrentDirectory

String

[In,Optional] Initial current directory for the target process. This value may be null to use the directory of the remote debugger.

Flags

DkmDeploymentCommandFlags

[In] Flags effecting the processing of deployment commands.

DataItem

DkmDataItem

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

Returns

DkmDeploymentCommand

[Out] Result of this method call.