UID

title

description

old-location

tech.root

ms.date

keywords

ms.keywords

req.header

req.include-header

req.target-type

req.target-min-winverclnt

req.target-min-winversvr

req.kmdf-ver

req.umdf-ver

req.ddi-compliance

req.unicode-ansi

req.idl

req.max-support

req.namespace

req.assembly

req.type-library

req.lib

req.dll

req.irql

targetos

req.typenames

f1_keywords

topic_type

api_type

api_location

api_name

NF:dbgeng.IDebugClient2.ConnectSession

IDebugClient2::ConnectSession (dbgeng.h)

The ConnectSession method joins the client to an existing debugger session. This method belongs to the IDebugClient2 interface.

debugger\connectsession.htm

debugger

05/03/2018

IDebugClient2::ConnectSession

ConnectSession, ConnectSession method [Windows Debugging], ConnectSession method [Windows Debugging],IDebugClient interface, ConnectSession method [Windows Debugging],IDebugClient2 interface, ConnectSession method [Windows Debugging],IDebugClient3 interface, ConnectSession method [Windows Debugging],IDebugClient4 interface, ConnectSession method [Windows Debugging],IDebugClient5 interface, IDebugClient interface [Windows Debugging],ConnectSession method, IDebugClient2 interface [Windows Debugging],ConnectSession method, IDebugClient2.ConnectSession, IDebugClient2::ConnectSession, IDebugClient3 interface [Windows Debugging],ConnectSession method, IDebugClient3::ConnectSession, IDebugClient4 interface [Windows Debugging],ConnectSession method, IDebugClient4::ConnectSession, IDebugClient5 interface [Windows Debugging],ConnectSession method, IDebugClient5::ConnectSession, IDebugClient::ConnectSession, IDebugClient_b6ec9f48-f400-4a91-bf23-dc40dd702a15.xml, dbgeng/IDebugClient2::ConnectSession, dbgeng/IDebugClient3::ConnectSession, dbgeng/IDebugClient4::ConnectSession, dbgeng/IDebugClient5::ConnectSession, dbgeng/IDebugClient::ConnectSession, debugger.connectsession

dbgeng.h

Dbgeng.h

Desktop

Windows

IDebugClient2::ConnectSession

dbgeng/IDebugClient2::ConnectSession

APIRef

kbSyntax

COM

dbgeng.h

IDebugClient2::ConnectSession

-description

The ConnectSession method joins the client to an existing debugger session.

-parameters

-param Flags [in]

Specifies a bit-set of option flags for connecting to the session. The possible values of these flags are:

Flag	Description
DEBUG_CONNECT_SESSION_NO_VERSION	Do not output the debugger engine's version to this client.
DEBUG_CONNECT_SESSION_NO_ANNOUNCE	Do not output a message notifying other clients that this client has connected.

-param HistoryLimit [in]

Specifies the maximum number of characters from the session's history to send to this client's output upon connection.

-returns

This method may also return error values. See Return Values for more details.

Return code	Description
S_OK	The method was successful.

-remarks

When the client object connects to a session, the most recent output from the session is sent to the client. If the session is currently waiting on input, the client object is given the opportunity to provide input. Thus, the client object synchronizes with the session's input and output.

The client becomes a primary client and will appear among the list of clients in the output of the .clients debugger command.

For more information about debugging clients, see Debugging Server and Debugging Client. For more information about debugger sessions, see Debugging Session and Execution Model.