Share via


DkmClrModuleInstance.DecompileDocument Method

Definition

Overloads

DecompileDocument(String, String, Int32)

Decompiles the code for a document into C# and updates the symbol file associated with the containing module with the necessary debugging information and embedded source. All modules that share this symbol file will begin using these updated symbols. Implementations should return S_OK on failure and return the actual HRESULT and any additional error information via the 'HR' and 'ErrorMessage' parameters.

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

This API was introduced in Visual Studio 17 Update 5 (DkmApiVersion.VS17Update5).

DecompileDocument(DkmWorkList, String, DkmCompletionRoutine<DkmDecompileAsyncResult173>)

Decompiles the code for a document into C# and updates the symbol file associated with the containing module with the necessary debugging information and embedded source. All modules that share this symbol file will begin using these updated symbols. Implementations should return S_OK on failure and return the actual HRESULT and any additional error information via the 'HR' and 'ErrorMessage' parameters.

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).

This API was introduced in Visual Studio 17 Update 5 (DkmApiVersion.VS17Update5).

DecompileDocument(String, String, Int32)

Decompiles the code for a document into C# and updates the symbol file associated with the containing module with the necessary debugging information and embedded source. All modules that share this symbol file will begin using these updated symbols. Implementations should return S_OK on failure and return the actual HRESULT and any additional error information via the 'HR' and 'ErrorMessage' parameters.

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

This API was introduced in Visual Studio 17 Update 5 (DkmApiVersion.VS17Update5).

public void DecompileDocument (string DocumentPath, out string? ErrorMessage, out int HR);
member this.DecompileDocument : string * string * int -> unit
Public Sub DecompileDocument (DocumentPath As String, ByRef ErrorMessage As String, ByRef HR As Integer)

Parameters

DocumentPath
String

[In] The module-specific path to the document that should be decompiled.

ErrorMessage
String

[Out,Optional] Details on errors that occurred during decompilation, if available.

HR
Int32

[Out] HResult to return to the caller.

Applies to

DecompileDocument(DkmWorkList, String, DkmCompletionRoutine<DkmDecompileAsyncResult173>)

Decompiles the code for a document into C# and updates the symbol file associated with the containing module with the necessary debugging information and embedded source. All modules that share this symbol file will begin using these updated symbols. Implementations should return S_OK on failure and return the actual HRESULT and any additional error information via the 'HR' and 'ErrorMessage' parameters.

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).

This API was introduced in Visual Studio 17 Update 5 (DkmApiVersion.VS17Update5).

public void DecompileDocument (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, string DocumentPath, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Decompilation.DkmDecompileAsyncResult173> CompletionRoutine);
member this.DecompileDocument : Microsoft.VisualStudio.Debugger.DkmWorkList * string * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Decompilation.DkmDecompileAsyncResult173> -> unit
Public Sub DecompileDocument (WorkList As DkmWorkList, DocumentPath As String, CompletionRoutine As DkmCompletionRoutine(Of DkmDecompileAsyncResult173))

Parameters

WorkList
DkmWorkList

WorkList to append the new work item to.

DocumentPath
String

[In] The module-specific path to the document that should be decompiled.

CompletionRoutine
DkmCompletionRoutine<DkmDecompileAsyncResult173>

Routine to fire when the request is complete. If the request is successfully appended to the work list, this will always fire (including when the operation is canceled). This will never fire if appending the work item fails.

Applies to