Share via

IDebugProgramEx2::Attach

  • Article

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Attach a session to a program.

Syntax

HRESULT Attach(   
   IDebugEventCallback2* pCallback,  
   DWORD                 dwReason,  
   IDebugSession2*       pSession  
);  

[C#]  
int Attach(   
   IDebugEventCallback2 pCallback,  
   uint                 dwReason,  
   IDebugSession2       pSession  
);

Parameters

pCallback
[in] An IDebugEventCallback2 object that represents the callback function that the attached debug engine sends events to.

dwReason
[in] A value from the ATTACH_REASON enumeration that describes the reason for the attach operation.

pSession
[in] A value that uniquely identifies the session that is attaching to the program.

Return Value

If successful, returns S_OK; otherwise returns an error code. This method should return E_ATTACH_DEBUGGER_ALREADY_ATTACHED if the program is already attached.

Remarks

The port that contains the program can use the value in pSession to determine which session is attempting to attach to the program. For example, if a port allows only one debug session to attach to a process at a time, the port can determine if the same session is already attached to other programs in the process.

Note

The interface passed in pSession is to be treated only as a cookie, a value that uniquely identifies the session debug manager attaching to this program; none of the methods on the supplied interface are functional.

See Also

IDebugProgramEx2