diff options
| author | Andrew Au <andrewau@microsoft.com> | 2018-08-09 10:27:23 -0700 |
|---|---|---|
| committer | Andrew Au <cshung@gmail.com> | 2018-11-06 18:34:47 -0800 |
| commit | e66652e308426cc823b24e8f28dc6f775d49544a (patch) | |
| tree | 831d9e82c68647a4b19f8bda2b48764eca02cf2d /src/inc | |
| parent | 4143a9c607a387d16ffa724e37596501bb7e22f2 (diff) | |
| download | coreclr-e66652e308426cc823b24e8f28dc6f775d49544a.tar.gz coreclr-e66652e308426cc823b24e8f28dc6f775d49544a.tar.bz2 coreclr-e66652e308426cc823b24e8f28dc6f775d49544a.zip | |
ICorDebug API documentation
Diffstat (limited to 'src/inc')
| -rw-r--r-- | src/inc/cordebug.idl | 56 |
1 files changed, 53 insertions, 3 deletions
diff --git a/src/inc/cordebug.idl b/src/inc/cordebug.idl index 32ec5039ce..961a03c231 100644 --- a/src/inc/cordebug.idl +++ b/src/inc/cordebug.idl @@ -1359,14 +1359,41 @@ interface ICorDebugManagedCallback3 : IUnknown interface ICorDebugManagedCallback4 : IUnknown { - // TODO, databp, these public APIs need to be commented. - // TODO, databp, measure performance to see if these events need to be switched. + // + // Callback indicating a garbage collection is about to start. + // + // Parameters + // pProcess - the process that is going to perform garbage collection. + // + // Returns + // S_OK - on success + // HRESULT BeforeGarbageCollection([in] ICorDebugProcess* pProcess); + + // + // Callback indicating a garbage collection is about to complete. + // + // Parameters + // pProcess - the process that is going to complete garbage collection. + // + // Returns + // S_OK - on success + // HRESULT AfterGarbageCollection([in] ICorDebugProcess* pProcess); + + // + // Callback indicating a data breakpoint is hit + // + // Parameters + // pProcess - the process that hits the data breakpoint + // pThread - the thread that hits the data breakpoint + // + // Returns + // S_OK - on success + // HRESULT DataBreakpoint([in] ICorDebugProcess* pProcess, [in] ICorDebugThread* pThread); } - #pragma warning(disable:28718) /* disable warning 28718 for interface ICorDebugManagedCallback2 */ /* @@ -3270,7 +3297,30 @@ interface ICorDebugProcess8 : IUnknown ] interface ICorDebugProcess10 : IUnknown { + // + // Given a pointer that is pointing to the interior of an object (for example, a field on an object), + // returns the containing object. + // + // Parameters + // interiorPointer - the pointer pointing to the interior of an object. + // ppContainingObject - [out] An ICorDebugObjectValue that represents the containing object. + // + // Returns + // S_OK - on success + // + // TODO: What if the pointer is not an interior pointer? + // TODO: What are all the possible error exit codes? + // HRESULT GetContainingObject([in] CORDB_ADDRESS interiorPointer, [out] ICorDebugObjectValue** ppContainingObject); + + // Enable or disable the GC notification events. The GC notification events are turned off by default + // They will be delivered through ICorDebugManagedCallback4 + // + // Parameters + // fEnable - true to enable the events, false to disable + // + // Returns + // S_OK - on success HRESULT EnableGCNotificationEvents(BOOL fEnable); } |