DkmProcessLaunchEnvironmentFilterList140.GetAdditionalEnvironmentVariables Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Start

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Obtains any environment variables which the extension would like to add.

Location constraint: API must be called from a Monitor component (component level < 100,000).

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

public:
 System::String ^ GetAdditionalEnvironmentVariables(int ImplementationIndex, Microsoft::VisualStudio::Debugger::Start::DkmProcessLaunchEnvironmentFilterInputData ^ InputData);

public:
 Platform::String ^ GetAdditionalEnvironmentVariables(int ImplementationIndex, Microsoft::VisualStudio::Debugger::Start::DkmProcessLaunchEnvironmentFilterInputData ^ InputData);

std::wstring GetAdditionalEnvironmentVariables(int ImplementationIndex, Microsoft::VisualStudio::Debugger::Start::DkmProcessLaunchEnvironmentFilterInputData const & InputData);

public string? GetAdditionalEnvironmentVariables (int ImplementationIndex, Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchEnvironmentFilterInputData InputData);

member this.GetAdditionalEnvironmentVariables : int * Microsoft.VisualStudio.Debugger.Start.DkmProcessLaunchEnvironmentFilterInputData -> string

Public Function GetAdditionalEnvironmentVariables (ImplementationIndex As Integer, InputData As DkmProcessLaunchEnvironmentFilterInputData) As String

Parameters

ImplementationIndex

Int32

[In] Zero-based index into the collection of {0} implementations that the caller wishes to be invoked. This should be less than the 'Count' property.

InputData

DkmProcessLaunchEnvironmentFilterInputData

[In] DkmProcessLaunchEnvironmentFilterInputData is used to provide input to a IDkmProcessLaunchEnvironmentFilter140 implementation. It describes the process which is about to be started.

Returns

String

[Out,Optional] One or more environment variables which should be passed to the target process. Multiple variables are separated with an embedded null ('\0'). For example: "MyVariable1=1\0MyVariable2=12".

Null or empty string are returned if the caller doesn't want to customize the environment block for this launch.