IDebugClient5 interface (dbgeng.h)

Inheritance

The IDebugClient5 interface inherits from IDebugClient4. IDebugClient5 also has these types of members:

Methods

The IDebugClient5 interface has these methods.

 
IDebugClient5::AbandonCurrentProcess

The IDebugClient5::AbandonCurrentProcess method removes the current process from the engine's process list without detaching or terminating the process.
IDebugClient5::AddDumpInformationFile

The IDebugClient5::AddDumpInformationFile method registers additional files containing supporting information that will be used when opening a dump file.
IDebugClient5::AddDumpInformationFileWide

The IDebugClient5::AddDumpInformationFileWide method registers additional files containing supporting information that will be used when opening a dump file.
IDebugClient5::AddProcessOptions

The AddProcessOptions method adds the process options to those options that affect the current process. This method belongs to the IDebugClient5 interface.
IDebugClient5::AttachKernel

The AttachKernel methods connect the debugger engine to a kernel target. This method belongs to the IDebugClient5 interface.
IDebugClient5::AttachKernelWide

The AttachKernelWide method connects the debugger engine to a kernel target.
IDebugClient5::AttachProcess

The AttachProcess method connects the debugger engine to a user-modeprocess. This method belongs to the IDebugClient5 interface.
IDebugClient5::ConnectProcessServer

The ConnectProcessServer methods connect to a process server. This method belongs to the IDebugClient5 interface.
IDebugClient5::ConnectProcessServerWide

The ConnectProcessServerWide method connects to a process server.
IDebugClient5::ConnectSession

The ConnectSession method joins the client to an existing debugger session. This method belongs to the IDebugClient5 interface.
IDebugClient5::CreateClient

The CreateClient method creates a new client object for the current thread. This method belongs to the IDebugClient5 interface.
IDebugClient5::CreateProcess

The CreateProcess method creates a process from the specified command line. This method belongs to the IDebugClient5 interface.
IDebugClient5::CreateProcess2

The CreateProcess2 method executes the given command to create a new process.
IDebugClient5::CreateProcess2Wide

The CreateProcess2Wide method executes the specified command to create a new process.
IDebugClient5::CreateProcessAndAttach

The IDebugClient5::CreateProcessAndAttach method creates a process from a specified command line, then attach to another user-mode process.
IDebugClient5::CreateProcessAndAttach2

The CreateProcessAndAttach2 method creates a process from a specified command line, then attaches to that process or another user-mode process.
IDebugClient5::CreateProcessAndAttach2Wide

The CreateProcessAndAttach2Wide method creates a process from a specified command line, then attach to that process or another user-mode process.
IDebugClient5::CreateProcessAndAttachWide

The IDebugClient5::CreateProcessAndAttachWide method creates a process from a specified command line, then attach to another user-mode process.
IDebugClient5::CreateProcessWide

The CreateProcessWide method creates a process from the specified command line. This method belongs to the IDebugClient5 interface.
IDebugClient5::DetachCurrentProcess

The DetachCurrentProcess method detaches the debugger engine from the current process, resuming all its threads. This method belongs to IDebugClient5.
IDebugClient5::DetachProcesses

The IDebugClient5::DetachProcesses method detaches the debugger engine from all processes in all targets, resuming all their threads.
IDebugClient5::DisconnectProcessServer

The DisconnectProcessServer method disconnects the debugger engine from a process server. This method belongs to the IDebugClient5 interface.
IDebugClient5::DispatchCallbacks

The DispatchCallbacks method lets the debugger engine use the current thread for callbacks. This method belongs to the IDebugClient5 interface.
IDebugClient5::EndProcessServer

The EndProcessServer method requests that a process server be shut down. This method belongs to the IDebugClient5 interface.
IDebugClient5::EndSession

The EndSession method ends the current debugger session. This method belongs to the IDebugClient5 interface.
IDebugClient5::ExitDispatch

The ExitDispatch method causes the DispatchCallbacks method to return. This method belongs to the IDebugClient5 interface.
IDebugClient5::FlushCallbacks

The IDebugClient5::FlushCallbacks method forces any remaining buffered output to be delivered to the IDebugOutputCallbacks object registered with this client.
IDebugClient5::GetDumpFile

The IDebugClient5::GetDumpFile method describes the files containing supporting information that were used when opening the current dump target.
IDebugClient5::GetDumpFileWide

The IDebugClient5::GetDumpFileWide method describes the files containing supporting information that were used when opening the current dump target.
IDebugClient5::GetEventCallbacks

The GetEventCallbacks method returns the event callbacks object registered with this client. This method belongs to the IDebugClient5 interface.
IDebugClient5::GetEventCallbacksWide

The GetEventCallbacksWide method returns the event callbacks object registered with this client.
IDebugClient5::GetExitCode

The IDebugClient5::GetExitCode method returns the exit code of the current process if that process has already run through to completion.
IDebugClient5::GetIdentity

The GetIdentity method returns a string describing the computer and user this client represents. This method belongs to the IDebugClient5 interface.
IDebugClient5::GetIdentityWide

The GetIdentityWide method returns a string describing the computer and user this client represents.
IDebugClient5::GetInputCallbacks

The GetInputCallbacks method returns the input callbacks object registered with this client. This method belongs to the IDebugClient5 interface.
IDebugClient5::GetKernelConnectionOptions

The GetKernelConnectionOptions method returns the connection options for the current kernel target. This method belongs to the IDebugClient5 interface.
IDebugClient5::GetKernelConnectionOptionsWide

The GetKernelConnectionOptionsWide method returns the connection options for the current kernel target.
IDebugClient5::GetNumberDumpFiles

The IDebugClient5::GetNumberDumpFiles method returns the number of files containing supporting information that were used when opening the current dump target.
IDebugClient5::GetNumberEventCallbacks

The GetNumberEventCallbacks method returns the number of event callbacks that are interested in the given events.
IDebugClient5::GetNumberInputCallbacks

The GetNumberInputCallbacks method returns the number of input callbacks registered over all clients.
IDebugClient5::GetNumberOutputCallbacks

The GetNumberOutputCallbacks method returns the number of output callbacks registered over all clients.
IDebugClient5::GetOtherOutputMask

The GetOtherOutputMask method returns the output mask for another client. This method belongs to the IDebugClient5 interface.
IDebugClient5::GetOutputCallbacks

The GetOutputCallbacks method returns the output callbacks object registered with the client. This method belongs to the IDebugClient5 interface.
IDebugClient5::GetOutputCallbacksWide

The GetOutputCallbacksWide method returns the output callbacks object registered with the client.
IDebugClient5::GetOutputLinePrefixWide

Gets a Unicode character string prefix for output lines.
IDebugClient5::GetOutputMask

The GetOutputMask method returns the output mask currently set for the client. This method belongs to the IDebugClient5 interface.
IDebugClient5::GetProcessOptions

The GetProcessOptions method retrieves the process options affecting the current process. This method belongs to the IDebugClient5 interface.
IDebugClient5::GetQuitLockString

Gets a quit lock string.
IDebugClient5::GetQuitLockStringWide

Gets a Unicode character quit lock string.
IDebugClient5::GetRunningProcessDescription

The IDebugClient5::GetRunningProcessDescription method returns a description of the process that includes several elements.
IDebugClient5::GetRunningProcessDescriptionWide

The IDebugClient5::GetRunningProcessDescriptionWide method returns a description of the process that includes several elements.
IDebugClient5::GetRunningProcessSystemIdByExecutableName

The IDebugClient5::GetRunningProcessSystemIdByExecutableName method searches for a process with a given executable file name and return its process ID.
IDebugClient5::GetRunningProcessSystemIdByExecutableNameWide

The IDebugClient5::GetRunningProcessSystemIdByExecutableNameWide method searches for a process with a given executable file name and return its process ID.
IDebugClient5::GetRunningProcessSystemIds

The GetRunningProcessSystemIds method returns the process IDs for each running process. This method belongs to the IDebugClient5 interface.
IDebugClient5::IsKernelDebuggerEnabled

The IsKernelDebuggerEnabled method checks whether kernel debugging is enabled for the local kernel. This method belongs to the IDebugClient5 interface.
IDebugClient5::OpenDumpFile

The OpenDumpFile method opens a dump file as a debugger target. This method belongs to the IDebugClient5 interface.
IDebugClient5::OpenDumpFileWide

The OpenDumpFileWide method opens a dump file as a debugger target. This method belongs to the IDebugClient5 interface.
IDebugClient5::OutputIdentity

The IDebugClient5::OutputIdentity method formats and outputs a string describing the computer and user this client represents.
IDebugClient5::OutputIdentityWide

The OutputIdentityWide method formats and outputs a string describing the computer and user this client represents.
IDebugClient5::OutputServers

The OutputServers method lists the servers running on a given computer. This method belongs to the IDebugClient5 interface.
IDebugClient5::OutputServersWide

The OutputServersWide method lists the servers running on a given computer.
IDebugClient5::PopOutputLinePrefix

Restores a previously saved output line prefix.
IDebugClient5::PushOutputLinePrefix

Saves an output line prefix.
IDebugClient5::PushOutputLinePrefixWide

Saves a wide string output line prefix.
IDebugClient5::RemoveProcessOptions

The RemoveProcessOptions method removes process options from those options that affect the current process. This method belongs to the IDebugClient5 interface.
IDebugClient5::SetEventCallbacks

The SetEventCallbacks method registers an event callbacks object with this client. This method belongs to the IDebugClient5 interface.
IDebugClient5::SetEventCallbacksWide

The SetEventCallbacksWide method registers an event callbacks object with this client.
IDebugClient5::SetInputCallbacks

The SetInputCallbacks method registers an input callbacks object with the client. This method belongs to the IDebugClient5 interface.
IDebugClient5::SetKernelConnectionOptions

The SetKernelConnectionOptions method updates some of the connection options for a live kernel target. This method belongs to the IDebugClient5 interface.
IDebugClient5::SetKernelConnectionOptionsWide

The SetKernelConnectionOptionsWide method updates some of the connection options for a live kernel target.
IDebugClient5::SetOtherOutputMask

The SetOtherOutputMask method sets the output mask for another client. This method belongs to the IDebugClient5 interface.
IDebugClient5::SetOutputCallbacks

The SetOutputCallbacks method registers an output callbacks object with this client. This method belongs to the IDebugClient5 interface.
IDebugClient5::SetOutputCallbacksWide

The SetOutputCallbacksWide method registers an output callbacks object with this client.
IDebugClient5::SetOutputLinePrefixWide

Sets a wide string prefix for output lines.
IDebugClient5::SetOutputMask

The SetOutputMask method sets the output mask for the client. This method belongs to the IDebugClient5 interface.
IDebugClient5::SetProcessOptions

The SetProcessOptions method sets the process options affecting the current process. This method belongs to the IDebugClient5 interface.
IDebugClient5::SetQuitLockString

Sets a quit lock string.
IDebugClient5::SetQuitLockStringWide

Sets a quit lock Unicode character string.
IDebugClient5::StartProcessServer

The StartProcessServer method starts a process server.
IDebugClient5::StartProcessServerWide

The StartProcessServerWide method starts a process server.
IDebugClient5::StartServer

The StartServer method starts a debugging server. This method belongs to the IDebugClient5 interface.
IDebugClient5::StartServerWide

The StartServerWide method starts a debugging server.
IDebugClient5::TerminateCurrentProcess

The TerminateCurrentProcess method attempts to terminate the current process. This method belongs to the IDebugClient5 interface.
IDebugClient5::TerminateProcesses

The TerminateProcesses method attempts to terminate all processes in all targets. This method belongs to the IDebugClient5 interface.
IDebugClient5::WaitForProcessServerEnd

The WaitForProcessServerEnd method waits for a local process server to exit. This method belongs to the IDebugClient5 interface.
IDebugClient5::WriteDumpFile

The WriteDumpFile method creates a user-mode or kernel-modecrash dump file. This method belongs to the IDebugClient5 interface.
IDebugClient5::WriteDumpFile2

The WriteDumpFile2 method creates a user-mode or kernel-modecrash dump file. This method belongs to the IDebugClient5 interface.
IDebugClient5::WriteDumpFileWide

The WriteDumpFileWide method creates a user-mode or kernel-modecrash dump file. This method belongs to the IDebugClient5 interface.

Requirements

Requirement Value
Target Platform Windows
Header dbgeng.h (include Dbgeng.h)

See also

IDebugClient4