Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3,215 changes: 3,215 additions & 0 deletions .openpublishing.redirection.framework.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6
---
# CreateDebuggingInterfaceFromVersion function

Accepts a common language runtime (CLR) version string that is returned from the [CreateVersionStringFromModule function](createversionstringfrommodule-function.md), and returns a corresponding debugger interface (typically, [ICorDebug](../../../framework/unmanaged-api/debugging/icordebug-interface.md)).
Accepts a common language runtime (CLR) version string that is returned from the [CreateVersionStringFromModule function](createversionstringfrommodule-function.md), and returns a corresponding debugger interface (typically, [ICorDebug](./icordebug/icordebug-interface.md)).

## Syntax

Expand All @@ -33,12 +33,12 @@ HRESULT CreateDebuggingInterfaceFromVersion (
[in] Version string of the CLR in the target debuggee, which is returned by the [CreateVersionStringFromModule function](createversionstringfrommodule-function.md).

`ppCordb`\
[out] Pointer to a pointer to a COM object (`IUnknown`). This object will be cast to an [ICorDebug](../../../framework/unmanaged-api/debugging/icordebug-interface.md) object before it is returned.
[out] Pointer to a pointer to a COM object (`IUnknown`). This object will be cast to an [ICorDebug](./icordebug/icordebug-interface.md) object before it is returned.

## Return value

`S_OK`\
`ppCordb` references a valid object that implements the [ICorDebug interface](../../../framework/unmanaged-api/debugging/icordebug-interface.md) interface.
`ppCordb` references a valid object that implements the [ICorDebug interface](./icordebug/icordebug-interface.md) interface.

`E_INVALIDARG`\
Either `szDebuggeeVersion` or `ppCordb` is null.
Expand All @@ -50,7 +50,7 @@ HRESULT CreateDebuggingInterfaceFromVersion (
Either mscordbi.dll or mscordaccore.dll is not the same version as the target CoreCLR.dll.

`E_FAIL` (or other `E_` return codes)\
Unable to return an [ICorDebug interface](../../../framework/unmanaged-api/debugging/icordebug-interface.md).
Unable to return an [ICorDebug interface](./icordebug/icordebug-interface.md).

## Remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6
---
# CreateDebuggingInterfaceFromVersion2 function

Accepts a common language runtime (CLR) version string that is returned from the [CreateVersionStringFromModule](createversionstringfrommodule-function.md) function, and returns a corresponding debugger interface (typically, [ICorDebug](../../../framework/unmanaged-api/debugging/icordebug-interface.md)).
Accepts a common language runtime (CLR) version string that is returned from the [CreateVersionStringFromModule](createversionstringfrommodule-function.md) function, and returns a corresponding debugger interface (typically, [ICorDebug](./icordebug/icordebug-interface.md)).

## Syntax

Expand All @@ -41,12 +41,12 @@ HRESULT CreateDebuggingInterfaceFromVersion2 (
[in] A string representing the application group ID of a sandboxed process running in macOS. Pass NULL if the process is not running in a sandbox on macOS or on other platforms.

`ppCordb`\
[out] Pointer to a pointer to a COM object (`IUnknown`). This object will be cast to an [ICorDebug](../../../framework/unmanaged-api/debugging/icordebug-interface.md) object before it is returned.
[out] Pointer to a pointer to a COM object (`IUnknown`). This object will be cast to an [ICorDebug](./icordebug/icordebug-interface.md) object before it is returned.

## Return value

`S_OK`\
`ppCordb` references a valid object that implements the [ICorDebug interface](../../../framework/unmanaged-api/debugging/icordebug-interface.md) interface.
`ppCordb` references a valid object that implements the [ICorDebug interface](./icordebug/icordebug-interface.md) interface.

`E_INVALIDARG`\
Either `szDebuggeeVersion` or `ppCordb` is null.
Expand All @@ -58,7 +58,7 @@ HRESULT CreateDebuggingInterfaceFromVersion2 (
Either mscordbi.dll or mscordaccore.dll is not the same version as the target CoreCLR.dll.

`E_FAIL` (or other `E_` return codes)\
Unable to return an [ICorDebug interface](../../../framework/unmanaged-api/debugging/icordebug-interface.md).
Unable to return an [ICorDebug interface](./icordebug/icordebug-interface.md).

## Remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6
---
# CreateDebuggingInterfaceFromVersion3 function

Accepts a common language runtime (CLR) version string that is returned from the [CreateVersionStringFromModule](createversionstringfrommodule-function.md) function, and returns a corresponding debugger interface (typically, [ICorDebug](../../../framework/unmanaged-api/debugging/icordebug-interface.md)).
Accepts a common language runtime (CLR) version string that is returned from the [CreateVersionStringFromModule](createversionstringfrommodule-function.md) function, and returns a corresponding debugger interface (typically, [ICorDebug](./icordebug/icordebug-interface.md)).

## Syntax

Expand Down Expand Up @@ -45,12 +45,12 @@ HRESULT CreateDebuggingInterfaceFromVersion3 (
[in] A callback interface instance for locating DBI and DAC. See [ICLRDebuggingLibraryProvider3](iclrdebugginglibraryprovider3-interface.md) interface.

`ppCordb`\
[out] Pointer to a pointer to a COM object (`IUnknown`). This object will be cast to an [ICorDebug](../../../framework/unmanaged-api/debugging/icordebug-interface.md) object before it is returned.
[out] Pointer to a pointer to a COM object (`IUnknown`). This object will be cast to an [ICorDebug](./icordebug/icordebug-interface.md) object before it is returned.

## Return value

`S_OK`\
`ppCordb` references a valid object that implements the [ICorDebug interface](../../../framework/unmanaged-api/debugging/icordebug-interface.md) interface.
`ppCordb` references a valid object that implements the [ICorDebug interface](./icordebug/icordebug-interface.md) interface.

`E_INVALIDARG`\
Either `szDebuggeeVersion` or `ppCordb` is null.
Expand All @@ -62,7 +62,7 @@ HRESULT CreateDebuggingInterfaceFromVersion3 (
Either mscordbi.dll or mscordaccore.dll is not the same version as the target CoreCLR.dll.

`E_FAIL` (or other `E_` return codes)\
Unable to return an [ICorDebug interface](../../../framework/unmanaged-api/debugging/icordebug-interface.md).
Unable to return an [ICorDebug interface](./icordebug/icordebug-interface.md).

## Remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ms.assetid: 35c7a18f-133a-4584-bd25-bb338568b0c6
---
# CreateDebuggingInterfaceFromVersionEx function

Accepts a common language runtime (CLR) version string that is returned from the [CreateVersionStringFromModule](createversionstringfrommodule-function.md) function, and returns a corresponding debugger interface (typically, [ICorDebug](../../../framework/unmanaged-api/debugging/icordebug-interface.md)).
Accepts a common language runtime (CLR) version string that is returned from the [CreateVersionStringFromModule](createversionstringfrommodule-function.md) function, and returns a corresponding debugger interface (typically, [ICorDebug](./icordebug/icordebug-interface.md)).

## Syntax

Expand All @@ -37,12 +37,12 @@ HRESULT CreateDebuggingInterfaceFromVersionEx (
[in] Version string of the CLR in the target debuggee, which is returned by the [CreateVersionStringFromModule](createversionstringfrommodule-function.md) function.

`ppCordb`\
[out] Pointer to a pointer to a COM object (`IUnknown`). This object will be cast to an [ICorDebug](../../../framework/unmanaged-api/debugging/icordebug-interface.md) object before it is returned.
[out] Pointer to a pointer to a COM object (`IUnknown`). This object will be cast to an [ICorDebug](./icordebug/icordebug-interface.md) object before it is returned.

## Return value

`S_OK`\
`ppCordb` references a valid object that implements the [ICorDebug interface](../../../framework/unmanaged-api/debugging/icordebug-interface.md) interface.
`ppCordb` references a valid object that implements the [ICorDebug interface](./icordebug/icordebug-interface.md) interface.

`E_INVALIDARG`\
Either `szDebuggeeVersion` or `ppCordb` is null.
Expand All @@ -54,7 +54,7 @@ HRESULT CreateDebuggingInterfaceFromVersionEx (
Either mscordbi.dll or mscordaccore.dll is not the same version as the target CoreCLR.dll.

`E_FAIL` (or other `E_` return codes)\
Unable to return an [ICorDebug interface](../../../framework/unmanaged-api/debugging/icordebug-interface.md).
Unable to return an [ICorDebug interface](./icordebug/icordebug-interface.md).

## Remarks

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
description: "Learn more about: CodeChunkInfo Structure"
title: "CodeChunkInfo Structure"
ms.date: "03/30/2017"
api_name:
- "CodeChunkInfo"
api_location:
- "mscordbi.dll"
api_type:
- "COM"
f1_keywords:
- "CodeChunkInfo"
helpviewer_keywords:
- "CodeChunkInfo structure [.NET debugging]"
topic_type:
- "apiref"
---
# CodeChunkInfo Structure

Represents a single chunk of code in memory.

## Syntax

```cpp
typedef struct _CodeChunkInfo {
CORDB_ADDRESS startAddr;
ULONG32 length;
} CodeChunkInfo;
```

## Members

| Member | Description |
|-------------|---------------------------------------------------------------------------|
| `startAddr` | A `CORDB_ADDRESS` value that specifies the starting address of the chunk. |
| `length` | The size, in bytes, of the chunk. |

## Remarks

The single chunk of code is a region of native code that is part of a code object such as a function.

## Requirements

**Platforms:** See [.NET supported operating systems](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md).

**Header:** CorDebug.idl

**Library:** CorGuids.lib

**.NET versions:** Available since .NET Framework 2.0

## See also

- [GetCodeChunks Method](icordebugcode2-getcodechunks-method.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
description: "Learn more about: COR_ACTIVE_FUNCTION Structure"
title: "COR_ACTIVE_FUNCTION Structure"
ms.date: "03/30/2017"
api_name:
- "COR_ACTIVE_FUNCTION"
api_location:
- "mscordbi.dll"
api_type:
- "COM"
f1_keywords:
- "COR_ACTIVE_FUNCTION"
helpviewer_keywords:
- "COR_ACTIVE_FUNCTION structure [.NET debugging]"
topic_type:
- "apiref"
---
# COR_ACTIVE_FUNCTION Structure

Contains information about the functions that are currently active in a thread's frames. This structure is used by the [ICorDebugThread2::GetActiveFunctions](icordebugthread2-getactivefunctions-method.md) method.

## Syntax

```cpp
typedef struct _COR_ACTIVE_FUNCTION {
ICorDebugAppDomain *pAppDomain;
ICorDebugModule *pModule;
ICorDebugFunction2 *pFunction;
ULONG32 ilOffset;
ULONG32 flags;
} COR_ACTIVE_FUNCTION;
```

## Members

| Member | Description |
|--------------|------------------------------------------------------------------|
| `pAppDomain` | Pointer to the application domain owner of the `ilOffset` field. |
| `pModule` | Pointer to the module owner of the `ilOffset` field. |
| `pFunction` | Pointer to the function owner of the `ilOffset` field. |
| `ilOffset` | The common intermediate language (CIL) offset of the frame. |
| `flags` | Reserved for future extensibility. |

## Requirements

**Platforms:** See [.NET supported operating systems](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md).

**Header:** CorDebug.idl

**Library:** CorGuids.lib

**.NET versions:** Available since .NET Framework 2.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
description: "Learn more about: COR_ARRAY_LAYOUT Structure"
title: "COR_ARRAY_LAYOUT Structure"
ms.date: "03/30/2017"
api_name:
- "COR_ARRAY_LAYOUT"
api_location:
- "mscordbi.dll"
api_type:
- "COM"
f1_keywords:
- "COR_ARRAY_LAYOUT"
helpviewer_keywords:
- "COR_DEBUG_IL_TO_NATIVE_MAP structure [.NET debugging]"
topic_type:
- "apiref"
---
# COR_ARRAY_LAYOUT Structure

Provides information about the layout of an array object in memory.

## Syntax

```cpp
typedef struct COR_ARRAY_LAYOUT {
COR_TYPEID componentID;
CorElementType componentType;
ULONG32 firstElementOffset;
ULONG32 elementSize;
ULONG32 countOffset;
ULONG32 rankSize;
ULONG32 numRanks;
ULONG32 rankOffset;
} COR_ARRAY_LAYOUT;
```

## Members

| Member | Description |
|----------------------|----------------------------------------------------------------|
| `componentID` | The identifier of the type of objects that the array contains. |
| `componentType` | A CorElementType enumeration value that indicates whether the component is a garbage collection reference, a value class, or a primitive. |
| `firstElementOffset` | The offset to the first element in the array. |
| `elementSize` | The size of each element. |
| `countOffset` | The offset to the number of elements in the array. |
| `rankSize` | The size of the rank, in bytes. |
| `numRanks` | The number of ranks in the array. |
| `rankOffset` | The offset at which the ranks start. |

## Remarks

The `rankSize` field specifies the size of a rank in a multi-dimensional array. It is accurate for single-dimensional arrays as well.

The value of `numRanks` is 1 for a single-dimensional array and `N` for a multi-dimensional array of `N` dimensions.

## Requirements

**Platforms:** See [.NET supported operating systems](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md).

**Header:** CorDebug.idl, CorDebug.h

**Library:** CorGuids.lib

**.NET versions:** Available since .NET Framework 4.5
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
description: "Learn more about: COR_DEBUG_IL_TO_NATIVE_MAP Structure"
title: "COR_DEBUG_IL_TO_NATIVE_MAP Structure"
ms.date: "03/30/2017"
api_name:
- "COR_DEBUG_IL_TO_NATIVE_MAP"
api_location:
- "mscordbi.dll"
api_type:
- "COM"
f1_keywords:
- "COR_DEBUG_IL_TO_NATIVE_MAP"
helpviewer_keywords:
- "COR_DEBUG_IL_TO_NATIVE_MAP structure [.NET debugging]"
topic_type:
- "apiref"
---
# COR_DEBUG_IL_TO_NATIVE_MAP Structure

Contains the offsets that are used to map common intermediate language (CIL) code to native code.

## Syntax

```cpp
typedef struct COR_DEBUG_IL_TO_NATIVE_MAP {
ULONG32 ilOffset;
ULONG32 nativeStartOffset;
ULONG32 nativeEndOffset;
} COR_DEBUG_IL_TO_NATIVE_MAP;
```

## Members

| Member | Description |
|---------------------|---------------------------------------------|
| `ilOffset` | The offset of the CIL code. |
| `nativeStartOffset` | The offset of the start of the native code. |
| `nativeEndOffset` | The offset of the end of the native code. |

## Requirements

**Platforms:** See [.NET supported operating systems](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md).

**Header:** CorProf.idl, CorDebug.idl

**Library:** CorGuids.lib

**.NET versions:** Available since .NET Framework 1.0

## See also

- [GetILToNativeMapping Method](icordebugcode-getiltonativemapping-method.md)
Loading