DkmStandardRemoteTransportConnection Class

Definition

This represents a remote connection between the monitor and the IDE over the standard transport. This class derives from DkmTransportConnection, and defines options used to connect to the target computer.

public ref class DkmStandardRemoteTransportConnection : Microsoft::VisualStudio::Debugger::DefaultPort::DkmTransportConnection
[System.Runtime.InteropServices.Guid("97a0464d-a80e-ab40-233b-e55b49e3dfd9")]
public class DkmStandardRemoteTransportConnection : Microsoft.VisualStudio.Debugger.DefaultPort.DkmTransportConnection
[<System.Runtime.InteropServices.Guid("97a0464d-a80e-ab40-233b-e55b49e3dfd9")>]
type DkmStandardRemoteTransportConnection = class
    inherit DkmTransportConnection
Public Class DkmStandardRemoteTransportConnection
Inherits DkmTransportConnection
Inheritance
DkmStandardRemoteTransportConnection
Attributes

Properties

AuthenticationMode

Authentication mode to use when connecting over a standard remote connection.

Flags

Flags indicating traits of the underlying connection.

(Inherited from DkmTransportConnection)
IsUnloaded

Returns true if a 'unloaded' event has been raised for this object (example: DkmThread::Unload is called) or if the object has been closed. Note that care must be used when checking this status as, without synchronization, the returned status may no longer be accurate the instruction after it is read.

(Inherited from DkmDataContainer)
Kind

Indicates the type of transport being used to debug.

(Inherited from DkmTransportConnection)
ProtocolVersion

The version of the protocol used between Visual Studio and the target computer. This is the minimum of the protocol version that Visual Studio understands, and the protocol version that the remote debugger understands.

This API was introduced in Visual Studio 11 Update 1 (DkmApiVersion.VS11FeaturePack1).

(Inherited from DkmTransportConnection)
ProxyServer

[Optional] Proxy server used when connecting to this computer. This is null if the debugger is directly connected to the computer.

Qualifier

[Optional] String indicating the connection destination. This will be null for the local connection. For default remote debugging, this is computer name and port number that we are trying to connect to.

(Inherited from DkmTransportConnection)
UniqueId

Guid which uniquely identifies this connection. The local connection will use the value 'DkmTransportKind.Local'. The value for other connections will be randomly generated.

(Inherited from DkmTransportConnection)

Methods

Abort()

Silently aborts the transport connection in a similar way to what happens if the Visual Studio or the Remote Debugger is terminated. The underlying connection will be dropped, any in-flight operations will be aborted, and currently any debugged processes will be terminated.

This API was introduced in Visual Studio 11 Update 2 (DkmApiVersion.VS11Update2).

ActivateAppPackage(DkmWorkList, DkmPackagedAppPlatform, String, Boolean, DkmCompletionRoutine<DkmActivateAppPackageAsyncResult>)

Activates the specified packaged application. This will cause the application to start if it has not already started, and will bring it back as the active application if it is already running. When launching under the debugger, IDkmProcessLaunchNotifyListener.StartListener will be called before this API.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

(Inherited from DkmTransportConnection)
ActivateAppPackageExtended(DkmWorkList, DkmPackagedAppPlatform, String, Boolean, DkmActivateAppPackageFlags, DkmCompletionRoutine<DkmActivateAppPackageAsyncResult>)

Activates the specified packaged application. This will cause the application to start if it has not already started, and will bring it back as the active application if it is already running. When launching under the debugger, IDkmProcessLaunchNotifyListener.StartListener will be called before this API.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

This API was introduced in Visual Studio 14 Update 1 (DkmApiVersion.VS14Update1).

(Inherited from DkmTransportConnection)
ActivateAppPackageOnTargetMonitor(DkmWorkList, DkmPackagedAppPlatform, String, Boolean, UInt32, DkmCompletionRoutine<DkmActivateAppPackageAsyncResult>)

Activates a packaged application on the specified monitor. This will cause the application to start if it has not already started, and will bring it back as the active application if it is already running.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

This API was introduced in Visual Studio 12 Update 3 (DkmApiVersion.VS12Update3).

(Inherited from DkmTransportConnection)
ActivateAppPackageWithStartupTask(DkmWorkList, String, Boolean, DkmCompletionRoutine<DkmActivateAppPackageAsyncResult>)

Activates the specified packaged application. This will cause the application to start if it has not already started, and will bring it back as the active application if it is already running. When launching under the debugger, IDkmProcessLaunchNotifyListener.StartListener will be called before this API.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

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

(Inherited from DkmTransportConnection)
ActivateBackgroundTask(DkmWorkList, DkmAppPackageId, Int32, Guid, DkmCompletionRoutine<DkmActivateBackgroundTaskAsyncResult>)

Activate an background task. This is used by developers to test their app's activate handler.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

(Inherited from DkmTransportConnection)
CreateCoreDumpParserTargetCompositionServices(String, Object) (Inherited from DkmTransportConnection)
CreateDirectory(String)

Creates a directory on the target computer. Note that directories are implicitly created when deploying files. So this API does not need to be used in that scenario.

(Inherited from DkmTransportConnection)
DeleteFile(String)

Delete a file on the target computer.

(Inherited from DkmTransportConnection)
DeployFile(String, String, Boolean)

Deploy a file to the target computer. Note that this will copy the file content and last write time, but not attributes.

Location constraint: API must be called from an IDE component (component level > 100,000).

(Inherited from DkmTransportConnection)
DownloadFile(DkmWorkList, String, String, Boolean, DkmCompletionRoutine<DkmDownloadFileAsyncResult>)

Download a file from the target computer. Note that this will copy the file content and last write time, but not attributes.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

Location constraint: API must be called from an IDE component (component level > 100,000).

(Inherited from DkmTransportConnection)
DownloadFile(String, String, Boolean)

Download a file from the target computer. Note that this will copy the file content and last write time, but not attributes.

Location constraint: API must be called from an IDE component (component level > 100,000).

(Inherited from DkmTransportConnection)
EnumerateBackgroundTasks(DkmWorkList, DkmAppPackageId, Int32, DkmCompletionRoutine<DkmEnumerateBackgroundTasksAsyncResult>)

Enumerates the existing background tasks. This is used by developers to test their app's enum handler.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

(Inherited from DkmTransportConnection)
EnumPackages()

Enumerates installed and launchable (App Packages with applications) App Packages.

Location constraint: API must be called from an IDE component (component level > 100,000).

(Inherited from DkmTransportConnection)
EnumRunningProcesses(Boolean, DkmRunningProcessInfoPropertyMask)

Provides a listing of all the processes running on the target computer (including processes not being debugged).

(Inherited from DkmTransportConnection)
FindLiveProcess(Int32)

Find a DkmProcess element within this DkmTransportConnection. If no element with the given input key is present, FindLiveProcess will fail. If an object is found, it will always contain the 'Live' Part.

(Inherited from DkmTransportConnection)
FindProcess(Guid)

Find a DkmProcess element within this DkmTransportConnection. If no element with the given input key is present, FindProcess will fail.

(Inherited from DkmTransportConnection)
FindProductionConnection(Guid)

Find a DkmProductionConnection element within this DkmTransportConnection. If no element with the given input key is present, FindProductionConnection will fail.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).

(Inherited from DkmTransportConnection)
FindRecordedProcessInfo(String)

Find a DkmRecordedProcessInfo element within this DkmTransportConnection. If no element with the given input key is present, FindRecordedProcessInfo will fail.

This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTM).

(Inherited from DkmTransportConnection)
FindSerializedProcessInfo(String) (Inherited from DkmTransportConnection)
FlushClosedObjectQueue()

This function is used to force all object close notifications to be immediately exchanged with the monitor process. Like 'GC.Collect' in managed code, this function is normally unnecessary, as the system automatically flushes the queue. However, this method can be used if it is important that all updates are immediately exchanged.

An object close notification is created (and queued) when a component calls 'Close' on a given object. Both the monitor process and the engine process maintain a queue of closed objects. This method may only be called from the engine process, but it is used to flush both queues.

Location constraint: API must be called from an IDE component (component level > 100,000).

(Inherited from DkmTransportConnection)
GetAppPackageExecutionState(DkmAppPackageId, Int32)

Get the execution state of the Windows Store app. The values in this field are specified in PACKAGE_EXECUTION_STATE.

(Inherited from DkmTransportConnection)
GetClrVersionOfExecutable(String)

Provides the version string for the CLR that the debugger expects a given executable to load. The return value is based on the content of the executable's PE header (if the exe is managed), the executable's config file, CLR environment variables, and loader policy in the registry. The return value may be incorrect, especially in the case of a native executable.

(Inherited from DkmTransportConnection)
GetDataItem<T>()

Gets the instance of 'T' which has been added to this container instance. If this container does not contain a 'T', this function will return null.

(Inherited from DkmDataContainer)
GetDefaultClrVersion()

Returns the version of the CLR which is loaded in the monitor process.

(Inherited from DkmTransportConnection)
GetDNSName()

Provides the physical DNS host name that the target computer uses.

(Inherited from DkmTransportConnection)
GetFileListing(String, String, Boolean)

Obtains a listing of files and subdirectories that exist on the target computer.

(Inherited from DkmTransportConnection)
GetIsolatedStorageRootForApplication(DkmAppPackageId)

Obtain the full path to the isolated storage root directory for the specified application.

This API is not yet implemented for Windows Store apps, but is reserved for future use.

(Inherited from DkmTransportConnection)
GetLiveProcesses()

GetLiveProcesses enumerates the DkmProcess elements of this DkmTransportConnectionobject. All objects contain the 'Live' Part.

(Inherited from DkmTransportConnection)
GetProcesses()

GetProcesses enumerates the DkmProcess elements of this DkmTransportConnection object.

(Inherited from DkmTransportConnection)
GetProductionConnections()

GetProductionConnections enumerates the DkmProductionConnection elements of this DkmTransportConnection object.

This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).

(Inherited from DkmTransportConnection)
GetRecordedProcesses()

GetRecordedProcesses enumerates the DkmRecordedProcessInfo elements of this DkmTransportConnection object.

This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTM).

(Inherited from DkmTransportConnection)
GetRecordedProcessInfo(String)

Obtain information about a recorded file.

This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTM).

(Inherited from DkmTransportConnection)
GetRequests()

GetRequests enumerates the DkmProcessLaunchRequest elements of this DkmTransportConnection object.

(Inherited from DkmTransportConnection)
GetRunningProcessInfo(Int32, Int64, Boolean, DkmRunningProcessInfoPropertyMask)

Obtain information about a process running on the target computer.

(Inherited from DkmTransportConnection)
GetSerializedProcessInfo(String) (Inherited from DkmTransportConnection)
GetSerializedProcessInformation() (Inherited from DkmTransportConnection)
GetSystemInformation(Boolean)

Provides information about the computer where the debug monitor is running.

(Inherited from DkmTransportConnection)
QueryExecutableArchitecture(String)

Gets the architecture of the executable.

This API was introduced in Visual Studio 16 RTM (DkmApiVersion.VS16RTMPreview).

(Inherited from DkmTransportConnection)
QueryIsWOW64Executable(String)

Deprecated. Use QueryExecutableArchitecture. Determines if the given executable file will execute within WOW64 (Windows On Windows), which is used to execute 32-bit processes on a 64-bit OS.

(Inherited from DkmTransportConnection)
RemoveAppPackageFromTaskbar(DkmAppPackageId, UInt32)

Removes an immersive app icon from the taskbar by closing it.

This API was introduced in Visual Studio 12 Update 3 (DkmApiVersion.VS12Update3).

(Inherited from DkmTransportConnection)
RemoveDataItem<T>()

Remove the instance of 'T' from this container. It is usually unnecessary to call this method as a data container will automatically be emptied when the object is closed.

(Inherited from DkmDataContainer)
RemoveDirectory(String, Boolean)

Removes a directory on the target computer.

(Inherited from DkmTransportConnection)
ResumeAppPackage(DkmAppPackageId, Int32)

Performs a simulated process lifetime management-based resume on the specified application. This is used by developers to test their app's resume handler.

(Inherited from DkmTransportConnection)
SetDataItem<T>(DkmDataCreationDisposition, T)

Place a new item in the data container.

(Inherited from DkmDataContainer)
ShutDownAppPackage(DkmWorkList, DkmAppPackageId, Int32, DkmCompletionRoutine<DkmShutDownAppPackageAsyncResult>)

Suspend and then shut down the specified application using the process lifetime management services. Using this followed by a second app launch, developers can test their app's ability to restart from suspended state.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

(Inherited from DkmTransportConnection)
SuspendAppPackage(DkmWorkList, DkmAppPackageId, Int32, DkmCompletionRoutine<DkmSuspendAppPackageAsyncResult>)

Performs a simulated process lifetime management-based suspend on the specified application. This is used by developers to test their app's suspend handler.

This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.

(Inherited from DkmTransportConnection)
TerminateAppPackage(DkmWorkList, DkmAppPackageId, Int32, DkmCompletionRoutine<DkmTerminateAppPackageAsyncResult>) (Inherited from DkmTransportConnection)
TerminateRunningProcess(Int32, Int64, Int32)

Terminates a process running on target computer which is not being debugged.

(Inherited from DkmTransportConnection)
TriggerPrefetch(String, DkmPackagedAppPlatform)

Triggers application content prefetch.

This API was introduced in Visual Studio 12 Update 2 (DkmApiVersion.VS12Update2).

(Inherited from DkmTransportConnection)

Applies to