Skip to content

Commit

Permalink
Merge pull request #10273 from MicrosoftDocs/main638538122992780840sy…
Browse files Browse the repository at this point in the history
…nc_temp

Repo sync for protected branch
  • Loading branch information
Jak-MS committed Jun 12, 2024
2 parents 79500f0 + 59563f9 commit 6030e6a
Show file tree
Hide file tree
Showing 43 changed files with 371 additions and 241 deletions.
5 changes: 5 additions & 0 deletions .openpublishing.redirection.subscriptions.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
"source_path": "subscriptions/azure-ea-devtest.md",
"redirect_url": "/azure/devtest/offer/quickstart-create-enterprise-devtest-subscriptions",
"redirect_document_id": false
},
{
"source_path": "subscriptions/microsoft-dev-box.md",
"redirect_url": "/visualstudio/subscriptions",
"redirect_document_id": false
}
]
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: "Retrieves the relative virtual address (RVA) of the code for the frame."
description: Retrieves the relative virtual address (RVA) of the code for the frame.
title: "IDiaFrameData::get_relativeVirtualAddress"
ms.date: "11/04/2016"
ms.topic: "reference"
Expand All @@ -12,25 +12,29 @@ ms.author: "mikejo"
manager: mijacobs
ms.subservice: debug-diagnostics
---

# IDiaFrameData::get_relativeVirtualAddress

Retrieves the relative virtual address (RVA) of the code for the frame.

## Syntax

```C++
HRESULT get_relativeVirtualAddress ( 
```c++
HRESULT get_relativeVirtualAddress (
DWORD* pRetVal
);
```

#### Parameters

`pRetVal`

[out] Returns the relative virtual address of the code for the frame.

## Return Value
If successful, returns `S_OK`. Returns `S_FALSE` if this property is not supported. Otherwise, returns an error code.

If successful, returns `S_OK`. Returns `S_FALSE` if this property is not supported. Otherwise, returns an error code.

## See also

- [IDiaFrameData](../../debugger/debug-interface-access/idiaframedata.md)
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,36 @@ ms.author: "mikejo"
manager: mijacobs
ms.subservice: debug-diagnostics
---

# IDiaFrameData::get_systemExceptionHandling

Retrieves a flag that indicates whether system exception handling is in effect.

## Syntax

```C++
HRESULT get_systemExceptionHandling ( 
```c++
HRESULT get_systemExceptionHandling (
BOOL* pRetVal
);
```

#### Parameters
pRetVal

pRetVal

[out] Returns `TRUE` if system exception handling is in effect; otherwise, returns `FALSE`.

## Return Value
If successful, returns `S_OK`. Returns `S_FALSE` if this property is not supported. Otherwise, returns an error code.

If successful, returns `S_OK`. Returns `S_FALSE` if this property is not supported. Otherwise, returns an error code.

## Remarks
System exception handling is more commonly known as structured exception handling.

To determine if C++ exception handling is in effect, call the [IDiaFrameData::get_cplusplusExceptionHandling](../../debugger/debug-interface-access/idiaframedata-get-cplusplusexceptionhandling.md) method.
System exception handling is more commonly known as structured exception handling.

To determine whether C++ exception handling is in effect, call the [IDiaFrameData::get_cplusplusExceptionHandling](../../debugger/debug-interface-access/idiaframedata-get-cplusplusexceptionhandling.md) method.

## See also

- [IDiaFrameData](../../debugger/debug-interface-access/idiaframedata.md)
- [IDiaFrameData::get_cplusplusExceptionHandling](../../debugger/debug-interface-access/idiaframedata-get-cplusplusexceptionhandling.md)
12 changes: 8 additions & 4 deletions docs/debugger/debug-interface-access/idiaframedata-get-type.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: "Retrieves the compiler-specific frame type."
description: Retrieves the compiler-specific frame type.
title: "IDiaFrameData::get_type"
ms.date: "11/04/2016"
ms.topic: "reference"
Expand All @@ -12,26 +12,30 @@ ms.author: "mikejo"
manager: mijacobs
ms.subservice: debug-diagnostics
---

# IDiaFrameData::get_type

Retrieves the compiler-specific frame type.

## Syntax

```C++
HRESULT get_type ( 
```c++
HRESULT get_type (
DWORD* pRetVal
);
```

#### Parameters

`pRetVal`

[out] Returns a value from the [StackFrameTypeEnum Enumeration](../../debugger/debug-interface-access/stackframetypeenum.md) enumeration that indicates the compiler-specific frame type.

## Return Value
If successful, returns `S_OK`. Returns `S_FALSE` if this property is not supported. Otherwise, returns an error code.

If successful, returns `S_OK`. Returns `S_FALSE` if this property is not supported. Otherwise, returns an error code.

## See also

- [IDiaFrameData](../../debugger/debug-interface-access/idiaframedata.md)
- [StackFrameTypeEnum Enumeration](../../debugger/debug-interface-access/stackframetypeenum.md)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: "Retrieves the virtual address (VA) of the code for the frame."
description: Retrieves the virtual address (VA) of the code for the frame.
title: "IDiaFrameData::get_virtualAddress"
ms.date: "11/04/2016"
ms.topic: "reference"
Expand All @@ -12,25 +12,29 @@ ms.author: "mikejo"
manager: mijacobs
ms.subservice: debug-diagnostics
---

# IDiaFrameData::get_virtualAddress

Retrieves the virtual address (VA) of the code for the frame.

## Syntax

```C++
HRESULT get_virtualAddress ( 
```c++
HRESULT get_virtualAddress (
ULONGLONG* pRetVal
);
```

#### Parameters

`pRetVal`

[out] Returns the virtual address of the code for the frame.

## Return Value
If successful, returns `S_OK`. Returns `S_FALSE` if this property is not supported. Otherwise, returns an error code.

If successful, returns `S_OK`. Returns `S_FALSE` if this property is not supported. Otherwise, returns an error code.

## See also

- [IDiaFrameData](../../debugger/debug-interface-access/idiaframedata.md)
23 changes: 14 additions & 9 deletions docs/debugger/debug-interface-access/idiaframedata.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: "Exposes the details of a stack frame."
title: "IDiaFrameData"
description: Exposes the details of a stack frame.
title: IDiaFrameData
ms.date: "11/04/2016"
ms.topic: "reference"
dev_langs:
Expand All @@ -12,17 +12,17 @@ ms.author: "mikejo"
manager: mijacobs
ms.subservice: debug-diagnostics
---

# IDiaFrameData

Exposes the details of a stack frame.

## Syntax

```
IDiaFrameData : IUnknown
```
`IDiaFrameData : IUnknown`

## Methods in Vtable Order

The following table shows the methods of `IDiaFrameData`.

|Method|Description|
Expand All @@ -47,15 +47,18 @@ The following table shows the methods of `IDiaFrameData`.
|[IDiaFrameData::execute](../../debugger/debug-interface-access/idiaframedata-execute.md)|Performs stack unwinding and returns the current state of registers in a stack walk frame interface.|

## Remarks
The details available for a frame are for execution points within the address range indicated by the address and block length.

The details available for a frame are for execution points within the address range indicated by the address and block length.

## Notes for Callers
Obtain this interface by calling the [IDiaEnumFrameData::Next](../../debugger/debug-interface-access/idiaenumframedata-next.md) or [IDiaEnumFrameData::Item](../../debugger/debug-interface-access/idiaenumframedata-item.md) methods. See the [IDiaEnumFrameData](../../debugger/debug-interface-access/idiaenumframedata.md) interface for details.

Obtain this interface by calling the [IDiaEnumFrameData::Next](../../debugger/debug-interface-access/idiaenumframedata-next.md) or [IDiaEnumFrameData::Item](../../debugger/debug-interface-access/idiaenumframedata-item.md) methods. See the [IDiaEnumFrameData](../../debugger/debug-interface-access/idiaenumframedata.md) interface for details.

## Example
This example prints out the properties of an `IDiaFrameData` object. See the [IDiaEnumFrameData](../../debugger/debug-interface-access/idiaenumframedata.md) interface for an example of how the `IDiaFrameData` interface is obtained.

```C++
This example prints out the properties of an `IDiaFrameData` object. See the [IDiaEnumFrameData](../../debugger/debug-interface-access/idiaenumframedata.md) interface for an example of how the `IDiaFrameData` interface is obtained.

```c++
void PrintFrameData(IDiaFrameData* pFrameData){
DWORD dwSect;
DWORD dwOffset;
Expand Down Expand Up @@ -107,13 +110,15 @@ void PrintFrameData(IDiaFrameData* pFrameData){
```
## Requirements
Header: Dia2.h
Library: diaguids.lib
DLL: msdia80.dll
## See also
- [Interfaces (Debug Interface Access SDK)](../../debugger/debug-interface-access/interfaces-debug-interface-access-sdk.md)
- [IDiaEnumFrameData](../../debugger/debug-interface-access/idiaenumframedata.md)
- [IDiaEnumFrameData::Item](../../debugger/debug-interface-access/idiaenumframedata-item.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: "Retrieves the memory location where the image should be based."
description: Retrieves the memory location where the image should be based.
title: "IDiaImageData::get_imageBase"
ms.date: "11/04/2016"
ms.topic: "reference"
Expand All @@ -12,28 +12,33 @@ ms.author: "mikejo"
manager: mijacobs
ms.subservice: debug-diagnostics
---

# IDiaImageData::get_imageBase

Retrieves the memory location where the image should be based.

## Syntax

```C++
HRESULT get_imageBase ( 
```c++
HRESULT get_imageBase (
ULONGLONG* pRetVal
);
```

#### Parameters

`pRetVal`

[out] Returns the suggested image base value.

## Return Value
If successful, returns `S_OK`; otherwise, returns an error code.

If successful, returns `S_OK`; otherwise, returns an error code.

## Remarks
Due to image base conflicts, an image may be rebased automatically to an unused memory location when it is loaded. This method returns the base hint (suggested memory location) that was stored in the module at compile time.

Due to image base conflicts, an image might be rebased automatically to an unused memory location when it is loaded. This method returns the base hint (suggested memory location) that was stored in the module at compile time.

## See also

- [IDiaImageData](../../debugger/debug-interface-access/idiaimagedata.md)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: "Retrieves the location in virtual memory of the module relative to the application."
description: Retrieves the location in virtual memory of the module relative to the application.
title: "IDiaImageData::get_relativeVirtualAddress"
ms.date: "11/04/2016"
ms.topic: "reference"
Expand All @@ -12,25 +12,29 @@ ms.author: "mikejo"
manager: mijacobs
ms.subservice: debug-diagnostics
---

# IDiaImageData::get_relativeVirtualAddress

Retrieves the location in virtual memory of the module relative to the application.

## Syntax

```C++
HRESULT get_relativeVirtualAddress ( 
```c++
HRESULT get_relativeVirtualAddress (
DWORD* pRetVal
);
```

#### Parameters

`pRetVal`

[out] Returns the relative virtual memory offset of the module.

## Return Value
If successful, returns `S_OK`; otherwise, returns an error code.

If successful, returns `S_OK`; otherwise, returns an error code.

## See also

- [IDiaImageData](../../debugger/debug-interface-access/idiaimagedata.md)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: "Retrieves the location in virtual memory of the image."
description: Retrieves the location in virtual memory of the image.
title: "IDiaImageData::get_virtualAddress"
ms.date: "11/04/2016"
ms.topic: "reference"
Expand All @@ -12,25 +12,29 @@ ms.author: "mikejo"
manager: mijacobs
ms.subservice: debug-diagnostics
---

# IDiaImageData::get_virtualAddress

Retrieves the location in virtual memory of the image.

## Syntax

```C++
HRESULT get_virtualAddress ( 
```c++
HRESULT get_virtualAddress (
ULONGLONG* pRetVal
);
```

#### Parameters

`pRetVal`

[out] Returns the virtual address of the image.

## Return Value
If successful, returns `S_OK`; otherwise, returns an error code.

If successful, returns `S_OK`; otherwise, returns an error code.

## See also

- [IDiaImageData](../../debugger/debug-interface-access/idiaimagedata.md)
Loading

0 comments on commit 6030e6a

Please sign in to comment.