DkmProductionAgent Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Debugger.DefaultPort

Assembly:: Microsoft.VisualStudio.Debugger.Engine.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

DkmProductionAgent represents an agent process launched using the StartAgent method of DkmProductionConnection.

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

public ref class DkmProductionAgent : Microsoft::VisualStudio::Debugger::DkmDataContainer, IDisposable

[System.Runtime.InteropServices.Guid("ebfc36fd-443b-40ed-3060-ccf3335f1025")]
public class DkmProductionAgent : Microsoft.VisualStudio.Debugger.DkmDataContainer, IDisposable

[<System.Runtime.InteropServices.Guid("ebfc36fd-443b-40ed-3060-ccf3335f1025")>]
type DkmProductionAgent = class
    inherit DkmDataContainer
    interface IDisposable

Public Class DkmProductionAgent
Inherits DkmDataContainer
Implements IDisposable

Inheritance: MarshalByRefObject

DkmDataContainer
DkmProductionAgent

Attributes: GuidAttribute

Implements: IDisposable

Properties

AgentCommand	The command that was used to launch this agent. This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
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)
ProductionConnection	The DkmProductionConnection object this agent was created using. This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
UniqueId	Guid which uniquely identifies this UniqueId object. This will be passed as the source id when an event calls SendToVsService. This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
VsService	The Guid of the VS service to send the contents of writes to stdout to. This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).

Methods

Close()	This method is called to close the object. DkmProductionAgent objects are automatically closed when their associated DkmProductionConnection object is closed. This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
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)
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)
SendMessage(Byte[])	Send a message to a production agent. This API was introduced in Visual Studio 15 Update 2 (DkmApiVersion.VS15Update2).
SetDataItem<T>(DkmDataCreationDisposition, T)	Place a new item in the data container. (Inherited from DkmDataContainer)

Explicit Interface Implementations

IDisposable.Dispose()

To be added.

Applies to