Skip to content

Commit 3b13b8e

Browse files
Merge pull request #10337 from MicrosoftDocs/main638585894766039412sync_temp
For protected branch, push strategy should use PR and merge to target branch method to work around git push error
2 parents 74557c4 + 25f0b64 commit 3b13b8e

File tree

192 files changed

+9643
-561
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

192 files changed

+9643
-561
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Common HRESULT Values (Debug Interface Access SDK)
3+
description: See a list of common HRESULT values returned by various APIs in the debug interface access (DIA) SDK.
4+
ms.date: "7/2/2024"
5+
ms.topic: "reference"
6+
dev_langs:
7+
- "C++"
8+
helpviewer_keywords:
9+
- "constants, HRESULT, DIA SDK"
10+
- "DIA SDK, HRESULT, constants"
11+
author: "grantri"
12+
ms.author: "grantri"
13+
manager: mijacobs
14+
ms.subservice: debug-diagnostics
15+
---
16+
17+
# Common HRESULT values (Debug Interface Access SDK)
18+
19+
The following `HRESULT` values are most commonly returned by APIs within the DIA SDK.
20+
21+
Here are the values listed in numeric order by value
22+
23+
|Value|Name|Description|
24+
|-----------|-----------|-----------|
25+
|0x806d0002|`E_PDB_USAGE`|invalid parameter or call order|
26+
|0x806d0004|`E_PDB_FILE_SYSTEM`|Can't read or write file, out of disk space, etc.|
27+
|0x806d0005|`E_PDB_NOT_FOUND`|PDB file not found|
28+
|0x806d0006|`E_PDB_INVALID_SIG`|PDB signature does not match|
29+
|0x806d0007|`E_PDB_INVALID_AGE`|PDB age mismatch|
30+
|0x806d0008|`E_PDB_PRECOMP_REQUIRED`|Precompiled type information not found|
31+
|0x806d0009|`E_PDB_OUT_OF_TI`|Out of debugger types|
32+
|0x806d000c|`E_PDB_FORMAT`|Attempt to load or use a PDB with an incompatible or unsupported format|
33+
|0x806d000d|`E_PDB_LIMIT`|Internal limit of PDB exceeded|
34+
|0x806d000e|`E_PDB_CORRUPT`|PDB records or structure are corrupt|
35+
|0x806d0011|`E_PDB_ILLEGAL_TYPE_EDIT`|Trying to edit types in read-only mode|
36+
|0x806d0012|`E_PDB_INVALID_EXECUTABLE`|File is not recognized as a valid executable|
37+
|0x806d0013|`E_PDB_DBG_NOT_FOUND`|.DBG file not found|
38+
|0x806d0014|`E_PDB_NO_DEBUG_INFO`|No recognized debug information found|
39+
|0x806d0015|`E_PDB_INVALID_EXE_TIMESTAMP`|Invalid timestamp of executable|
40+
|0x806d0016|`E_PDB_RESERVED`|Undocumented error|
41+
|0x806d0017|`E_PDB_DEBUG_INFO_NOT_IN_PDB`|Debug information is not in the PDB|
42+
|0x806d0018|`E_PDB_SYMSRV_BAD_CACHE_PATH`|Bad cache location specified with symsrv|
43+
|0x806d0019|`E_PDB_SYMSRV_CACHE_FULL`|symsrv cache is full|
44+
|0x806d0064|`E_DIA_INPROLOG`|Cannot execute stack frame when in prolog|
45+
|0x806d0065|`E_DIA_SYNTAX`|Error parsing frame program|
46+
|0x806d0066|`E_DIA_FRAME_ACCESS`|Error accessing registers or memory|
47+
|0x806d0067|`E_DIA_VALUE`|Error in computed value (e.g. divide by zero)|
48+
|0x806d00C8|`E_DIA_COFF_ACCESS`|Error accessing OBJ, LIB or compiler generated PDB when querying a PDB produced by the linker with `/DEBUG:fastlink`|
49+
|0x806d00C9|`E_DIA_COMP_PDB_ACCESS`|Error accessing compiler generated PDB|
50+
51+
52+
## Requirements
53+
54+
Header: dia2.h
55+
56+
## See also
57+
58+
- [Reference](../../debugger/debug-interface-access/debug-interface-access-sdk-reference.md)
59+
- [Enumerations and Structures](../../debugger/debug-interface-access/enumerations-and-structures.md)
60+
- [Interfaces (Debug Interface Access SDK)](../../debugger/debug-interface-access/interfaces-debug-interface-access-sdk.md)
61+

docs/debugger/debug-interface-access/constants-debug-interface-access-sdk.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Constants (Debug Interface Access SDK)
33
description: See a list of string constants that can be used to identify various sections of a program debug database (PDB) file through the Debug Interface Access (DIA) SDK.
4-
ms.date: "11/04/2016"
4+
ms.date: "07/22/2024"
55
ms.topic: "reference"
66
dev_langs:
77
- "C++"
@@ -32,6 +32,7 @@ The following are declared as C/C++ macros.
3232
|`DiaTable_Dbg`|L"Dbg"|
3333
|`DiaTable_InjSrc`|L"InjectedSource"|
3434
|`DiaTable_FrameData`|L"FrameData"|
35+
|`DiaTable_InputAssemblyFiles`|L"InputAssemblyFiles"|
3536

3637
## Example
3738

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: CV_AssociationKind_e
3+
description: Specifies the kind of association between two symbols.
4+
ms.date: "07/15/2024"
5+
ms.topic: "reference"
6+
dev_langs:
7+
- "C++"
8+
helpviewer_keywords:
9+
- "CV_AssociationKind_e enumeration"
10+
author: "grantri"
11+
ms.author: "grantri"
12+
manager: twhitney
13+
ms.subservice: debug-diagnostics
14+
---
15+
16+
# `CV_AssociationKind_e`
17+
18+
Specifies the kind of association between two symbols.
19+
20+
## Syntax
21+
22+
```c++
23+
typedef enum CV_AssociationKind_e
24+
{
25+
CV_ASSOCIATIONKIND_NONE,
26+
CV_ASSOCIATIONKIND_COROUTINE
27+
} CV_AssociationKind_e;
28+
```
29+
30+
## Elements
31+
32+
| Element | Description |
33+
| ------------ | ---------------------------- |
34+
| `CV_ASSOCIATIONKIND_NONE`| No associated symbol. |
35+
| `CV_ASSOCIATIONKIND_COROUTINE`| Associated symbol is the primary coroutine function. |
36+
37+
## Remarks
38+
39+
Use the [`IDiaSymbol8::get_associatedSymbolKind`](../../debugger/debug-interface-access/idiasymbol8-get-associatedSymbolkind.md) method to retrieve the kind of associated between two symbols.
40+
41+
## Requirements
42+
43+
Header: cvconst.h
44+
45+
## See also
46+
47+
- [Enumerations and Structures](../../debugger/debug-interface-access/enumerations-and-structures.md)
48+
- [`IDiaSymbol8::get_associatedSymbolKind`](../../debugger/debug-interface-access/idiasymbol8-get-associatedSymbolkind.md)
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: CV_builtin_e
3+
description: Specifies the HLSL built in type kind.
4+
ms.date: "07/15/2024"
5+
ms.topic: "reference"
6+
dev_langs:
7+
- "C++"
8+
helpviewer_keywords:
9+
- "CV_builtin_e enumeration"
10+
author: "grantri"
11+
ms.author: "grantri"
12+
manager: twhitney
13+
ms.subservice: debug-diagnostics
14+
---
15+
16+
# `CV_builtin_e`
17+
18+
Specifies the HLSL built in type kind.
19+
20+
## Syntax
21+
22+
```c++
23+
typedef enum CV_builtin_e
24+
{
25+
// 0x0000 - 0x01ff - Reserved.
26+
CV_BI_INVALID = 0x0000,
27+
28+
// 0x0200 - 0x03ff - HLSL types.
29+
30+
CV_BI_HLSL_INTERFACE_POINTER = 0x0200,
31+
CV_BI_HLSL_TEXTURE1D = 0x0201,
32+
CV_BI_HLSL_TEXTURE1D_ARRAY = 0x0202,
33+
CV_BI_HLSL_TEXTURE2D = 0x0203,
34+
CV_BI_HLSL_TEXTURE2D_ARRAY = 0x0204,
35+
CV_BI_HLSL_TEXTURE3D = 0x0205,
36+
CV_BI_HLSL_TEXTURECUBE = 0x0206,
37+
CV_BI_HLSL_TEXTURECUBE_ARRAY = 0x0207,
38+
CV_BI_HLSL_TEXTURE2DMS = 0x0208,
39+
CV_BI_HLSL_TEXTURE2DMS_ARRAY = 0x0209,
40+
CV_BI_HLSL_SAMPLER = 0x020a,
41+
CV_BI_HLSL_SAMPLERCOMPARISON = 0x020b,
42+
CV_BI_HLSL_BUFFER = 0x020c,
43+
CV_BI_HLSL_POINTSTREAM = 0x020d,
44+
CV_BI_HLSL_LINESTREAM = 0x020e,
45+
CV_BI_HLSL_TRIANGLESTREAM = 0x020f,
46+
CV_BI_HLSL_INPUTPATCH = 0x0210,
47+
CV_BI_HLSL_OUTPUTPATCH = 0x0211,
48+
CV_BI_HLSL_RWTEXTURE1D = 0x0212,
49+
CV_BI_HLSL_RWTEXTURE1D_ARRAY = 0x0213,
50+
CV_BI_HLSL_RWTEXTURE2D = 0x0214,
51+
CV_BI_HLSL_RWTEXTURE2D_ARRAY = 0x0215,
52+
CV_BI_HLSL_RWTEXTURE3D = 0x0216,
53+
CV_BI_HLSL_RWBUFFER = 0x0217,
54+
CV_BI_HLSL_BYTEADDRESS_BUFFER = 0x0218,
55+
CV_BI_HLSL_RWBYTEADDRESS_BUFFER = 0x0219,
56+
CV_BI_HLSL_STRUCTURED_BUFFER = 0x021a,
57+
CV_BI_HLSL_RWSTRUCTURED_BUFFER = 0x021b,
58+
CV_BI_HLSL_APPEND_STRUCTURED_BUFFER = 0x021c,
59+
CV_BI_HLSL_CONSUME_STRUCTURED_BUFFER= 0x021d,
60+
CV_BI_HLSL_MIN8FLOAT = 0x021e,
61+
CV_BI_HLSL_MIN10FLOAT = 0x021f,
62+
CV_BI_HLSL_MIN16FLOAT = 0x0220,
63+
CV_BI_HLSL_MIN12INT = 0x0221,
64+
CV_BI_HLSL_MIN16INT = 0x0222,
65+
CV_BI_HLSL_MIN16UINT = 0x0223,
66+
CV_BI_HLSL_CONSTANT_BUFFER = 0x0224,
67+
68+
// 0x0400 - 0xffff - Unused.
69+
70+
} CV_builtin_e;
71+
```
72+
73+
## Remarks
74+
75+
Use the [`IDiaSymbol::get_builtInKind`](../../debugger/debug-interface-access/idiasymbol-get-builtinkind.md) method to retrieve the built in type kind for a HLSL symbol.
76+
77+
> [!NOTE]
78+
> The newer DXC compiler no longer produces PDBs. This API only has valid values on PDBs produced by the older *fxc.exe* compiler.
79+
80+
## Requirements
81+
82+
Header: cvconst.h
83+
84+
## See also
85+
86+
- [Enumerations and Structures](../../debugger/debug-interface-access/enumerations-and-structures.md)
87+
- [`IDiaSymbol::get_builtInKind`](../../debugger/debug-interface-access/idiasymbol-get-builtinkind.md)

docs/debugger/debug-interface-access/cv-cfl-lang.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ typedef enum CV_CFL_LANG {
7979

8080
The values in this enumeration are returned by a call to the [IDiaSymbol::get_language](../../debugger/debug-interface-access/idiasymbol-get-language.md) method.
8181

82+
> [!NOTE]
83+
> The newer DXC compiler no longer produces PDBs. This API only has valid values on PDBs produced by the older *fxc.exe* compiler.
84+
8285
## Requirements
8386

8487
Header: cvconst.h
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: CV_CoroutineKind_e
3+
description: Get information about the CV_CoroutineKind_e enumeration type, which specifies the coroutine kind.
4+
ms.date: "07/15/2024"
5+
ms.topic: "reference"
6+
dev_langs:
7+
- "C++"
8+
helpviewer_keywords:
9+
- "CV_CoroutineKind_e enumeration"
10+
author: "grantri"
11+
ms.author: "grantri"
12+
manager: twhitney
13+
ms.subservice: debug-diagnostics
14+
---
15+
16+
# CV_CoroutineKind_e
17+
18+
Specifies the couroutine kind.
19+
20+
## Syntax
21+
22+
```c++
23+
typedef enum CV_CoroutineKind_e
24+
{
25+
CV_COROUTINEKIND_NONE,
26+
CV_COROUTINEKIND_PRIMARY,
27+
CV_COROUTINEKIND_INIT,
28+
CV_COROUTINEKIND_RESUME,
29+
CV_COROUTINEKIND_DESTROY
30+
} CV_CoroutineKind_e;
31+
```
32+
33+
## Elements
34+
35+
| Element | Description |
36+
| ------------ | ---------------------------- |
37+
| `CV_COROUTINEKIND_NONE`| Not a coroutine. |
38+
| `CV_COROUTINEKIND_PRIMARY`| The original coroutine function. |
39+
| `CV_COROUTINEKIND_INIT`| Initialization function, sets up the coroutine frame. |
40+
| `CV_COROUTINEKIND_RESUME`| Resume function, contains the coroutine body code. |
41+
| `CV_COROUTINEKIND_DESTROY`| Destroy function, tears down the coroutine frame. |
42+
43+
## Remarks
44+
45+
Use the [IDiaSymbol8::get_coroutineKind](../../debugger/debug-interface-access/idiasymbol8-get-coroutinekind.md) method to retrieve the coroutine kind for a coroutine function.
46+
47+
## Requirements
48+
49+
Header: cvconst.h
50+
51+
## See also
52+
53+
- [Enumerations and Structures](../../debugger/debug-interface-access/enumerations-and-structures.md)
54+
- [IDiaSymbol8::get_coroutineKind](../../debugger/debug-interface-access/idiasymbol8-get-coroutinekind.md)
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: CV_HLSLMemorySpace_e Enumeration
3+
description: Specifies the HLSL memory space kind.
4+
ms.date: "07/15/2024"
5+
ms.topic: "reference"
6+
dev_langs:
7+
- "C++"
8+
helpviewer_keywords:
9+
- "CV_HLSLMemorySpace_e enumeration"
10+
author: "grantri"
11+
ms.author: "grantri"
12+
manager: twhitney
13+
ms.subservice: debug-diagnostics
14+
---
15+
16+
# `CV_HLSLMemorySpace_e` Enumeration
17+
18+
Specifies the HLSL memory space kind.
19+
20+
## Syntax
21+
22+
```c++
23+
typedef enum CV_HLSLMemorySpace_e
24+
{
25+
// HLSL specific memory spaces
26+
27+
CV_HLSL_MEMSPACE_DATA = 0x00,
28+
CV_HLSL_MEMSPACE_SAMPLER = 0x01,
29+
CV_HLSL_MEMSPACE_RESOURCE = 0x02,
30+
CV_HLSL_MEMSPACE_RWRESOURCE = 0x03,
31+
32+
CV_HLSL_MEMSPACE_MAX = 0x0F,
33+
} CV_HLSLMemorySpace_e;
34+
```
35+
36+
## Remarks
37+
38+
Use the [`IDiaSymbol::get_memorySpaceKind`](../../debugger/debug-interface-access/idiasymbol-get-memoryspacekind.md) method to retrieve the memory space kind for an HLSL symbol.
39+
40+
> [!NOTE]
41+
> The newer DXC compiler no longer produces PDBs. This API only has valid values on PDBs produced by the older *fxc.exe* compiler.
42+
43+
## Requirements
44+
45+
Header: cvconst.h
46+
47+
## See also
48+
49+
- [Enumerations and Structures](../../debugger/debug-interface-access/enumerations-and-structures.md)
50+
- [`IDiaSymbol::get_memorySpaceKind`](../../debugger/debug-interface-access/idiasymbol-get-memoryspacekind.md)

0 commit comments

Comments
 (0)