Skip to content

Commit 3f48b2e

Browse files
gewarrengewarren
authored
Merge pull request #2464 from MicrosoftDocs/master636855937382437641
For protected CLA branch, push strategy should use PR and merge to target branch method to work around git push error
2 parents cf72146 + ee3d417 commit 3f48b2e

38 files changed

+451
-595
lines changed

‎docs/debugger/debug-interface-access/idiadatasource-opensession.md

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,59 @@
22
title: "IDiaDataSource::openSession | Microsoft Docs"
33
ms.date: "11/04/2016"
44
ms.topic: "conceptual"
5-
dev_langs:
5+
dev_langs:
66
- "C++"
7-
helpviewer_keywords:
7+
helpviewer_keywords:
88
- "IDiaDataSource::openSession method"
99
ms.assetid: a3319ed0-3979-483b-9852-c0af96852c48
1010
author: "mikejo5000"
1111
ms.author: "mikejo"
1212
manager: jillfra
13-
ms.workload:
13+
ms.workload:
1414
- "multiple"
1515
---
1616
# IDiaDataSource::openSession
17-
Opens a session for querying symbols.
18-
19-
## Syntax
20-
21-
```C++
22-
HRESULT openSession ( 
23-
IDiaSession** ppSession
24-
);
25-
```
26-
27-
#### Parameters
28-
ppSession
29-
[out] Returns an [IDiaSession](../../debugger/debug-interface-access/idiasession.md) object representing the open session.
30-
31-
## Return Value
32-
If successful, returns `S_OK`; otherwise, returns an error code. The following table shows the possible return values for this method.
33-
34-
|Value|Description|
35-
|-----------|-----------------|
36-
|E_UNEXPECTED|The [IDiaDataSource](../../debugger/debug-interface-access/idiadatasource.md) object has not previously been initialized with a source of symbols.|
37-
|E_INVALIDARG|Invalid `ppSession` parameter.|
38-
|E_OUTOFMEMORY|Insufficient memory to open the session.|
39-
40-
## Remarks
41-
This method opens an [IDiaSession](../../debugger/debug-interface-access/idiasession.md) object for a data source.
42-
43-
`IDiaSession` objects implement queries into the data source. A session manages one address space for each set of debug symbols. If the .exe or .dll file described by the data source symbols is active in multiple address ranges (for example, because multiple processes have it loaded), then one session for each address range should be used.
44-
45-
## Example
46-
47-
```C++
48-
IDiaSession* pSession;
49-
HRESULT hr = pSource->openSession( &pSession );
50-
if (FAILED(hr))
51-
{
52-
// report error
53-
}
54-
```
55-
56-
## See Also
57-
[IDiaDataSource](../../debugger/debug-interface-access/idiadatasource.md)
58-
[Overview](../../debugger/debug-interface-access/overview-debug-interface-access-sdk.md)
59-
[IDiaSession](../../debugger/debug-interface-access/idiasession.md)
60-
[Querying the .Pdb File](../../debugger/debug-interface-access/querying-the-dot-pdb-file.md)
17+
Opens a session for querying symbols.
18+
19+
## Syntax
20+
21+
```C++
22+
HRESULT openSession ( 
23+
IDiaSession** ppSession
24+
);
25+
```
26+
27+
#### Parameters
28+
ppSession
29+
[out] Returns an [IDiaSession](../../debugger/debug-interface-access/idiasession.md) object representing the open session.
30+
31+
## Return Value
32+
If successful, returns `S_OK`; otherwise, returns an error code. The following table shows the possible return values for this method.
33+
34+
|Value|Description|
35+
|-----------|-----------------|
36+
|E_UNEXPECTED|The [IDiaDataSource](../../debugger/debug-interface-access/idiadatasource.md) object has not previously been initialized with a source of symbols.|
37+
|E_INVALIDARG|Invalid `ppSession` parameter.|
38+
|E_OUTOFMEMORY|Insufficient memory to open the session.|
39+
40+
## Remarks
41+
This method opens an [IDiaSession](../../debugger/debug-interface-access/idiasession.md) object for a data source.
42+
43+
`IDiaSession` objects implement queries into the data source. A session manages one address space for each set of debug symbols. If the .exe or .dll file described by the data source symbols is active in multiple address ranges (for example, because multiple processes have it loaded), then one session for each address range should be used.
44+
45+
## Example
46+
47+
```C++
48+
IDiaSession* pSession;
49+
HRESULT hr = pSource->openSession( &pSession );
50+
if (FAILED(hr))
51+
{
52+
// report error
53+
}
54+
```
55+
56+
## See Also
57+
[IDiaDataSource](../../debugger/debug-interface-access/idiadatasource.md)
58+
[Overview](../../debugger/debug-interface-access/overview-debug-interface-access-sdk.md)
59+
[IDiaSession](../../debugger/debug-interface-access/idiasession.md)
60+
[Querying the .Pdb File](../../debugger/debug-interface-access/querying-the-dot-pdb-file.md)

‎docs/debugger/debug-interface-access/idiaenumstackframes.md

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -2,69 +2,69 @@
22
title: "IDiaEnumStackFrames | Microsoft Docs"
33
ms.date: "11/04/2016"
44
ms.topic: "conceptual"
5-
dev_langs:
5+
dev_langs:
66
- "C++"
7-
helpviewer_keywords:
7+
helpviewer_keywords:
88
- "IDiaEnumStackFrames interface"
99
ms.assetid: 3d1e8403-c9fc-42ff-ae35-0ab9a5ed2ad7
1010
author: "mikejo5000"
1111
ms.author: "mikejo"
1212
manager: jillfra
13-
ms.workload:
13+
ms.workload:
1414
- "multiple"
1515
---
1616
# IDiaEnumStackFrames
17-
Enumerates the various stack frames available.
18-
19-
## Methods in Vtable Order
20-
21-
|Method|Description|
22-
|------------|-----------------|
23-
|[IDiaEnumStackFrames::Next](../../debugger/debug-interface-access/idiaenumstackframes-next.md)|Retrieves a specified number of stack frame elements from the enumeration sequence.|
24-
|[IDiaEnumStackFrames::Reset](../../debugger/debug-interface-access/idiaenumstackframes-reset.md)|Resets an enumeration sequence to the beginning.|
25-
26-
## Remarks
27-
28-
## Notes for Callers
29-
Obtain this interface by calling the [IDiaStackWalker::getEnumFrames](../../debugger/debug-interface-access/idiastackwalker-getenumframes.md) or [IDiaStackWalker::getEnumFrames2](../../debugger/debug-interface-access/idiastackwalker-getenumframes2.md) methods.
30-
31-
## Example
32-
This example shows how to obtain and use the `IDiaEnumStackFrames` interface. See the [IDiaStackFrame](../../debugger/debug-interface-access/idiastackframe.md) interface for an implementation of the `PrintStackFrame` function.
33-
34-
```C++
35-
void DumpStackFrames(IDiaStackWalker* pStackWalker,
36-
IDiaStackWalkHelper* pStackWalkHelper,
37-
CV_CPU_TYPE_e cpuType)
38-
{
39-
if (pStackWalker != NULL && pStackWalkHelper != NULL)
40-
{
41-
CComPtr<IDiaEnumStackFrames> pEnumsFrames;
42-
HRESULT hr;
43-
hr = pStackWalker->getEnumFrames2(cpuType, pStackWalkHelper, &pEnumFrames);
44-
if (SUCCEEDED(hr) && pEnumFrames != NULL)
45-
{
46-
CComPtr<IDiaStackFrame> pStackFrame;
47-
DWORD celt = 0;
48-
49-
while (pEnumFrames->Next(1, &pStackFrame, &celt) == S_OK)
50-
{
51-
PrintStackFrame(pStackFrame);
52-
}
53-
pStackFrame = NULL;
54-
}
55-
}
56-
}
57-
```
58-
59-
## Requirements
60-
Header: Dia2.h
61-
62-
Library: diaguids.lib
63-
64-
DLL: msdia80.dll
65-
66-
## See Also
67-
[Interfaces (Debug Interface Access SDK)](../../debugger/debug-interface-access/interfaces-debug-interface-access-sdk.md)
68-
[IDiaStackWalkFrame](../../debugger/debug-interface-access/idiastackwalkframe.md)
69-
[IDiaStackWalker::getEnumFrames2](../../debugger/debug-interface-access/idiastackwalker-getenumframes2.md)
70-
[IDiaStackWalker::getEnumFrames](../../debugger/debug-interface-access/idiastackwalker-getenumframes.md)
17+
Enumerates the various stack frames available.
18+
19+
## Methods in Vtable Order
20+
21+
|Method|Description|
22+
|------------|-----------------|
23+
|[IDiaEnumStackFrames::Next](../../debugger/debug-interface-access/idiaenumstackframes-next.md)|Retrieves a specified number of stack frame elements from the enumeration sequence.|
24+
|[IDiaEnumStackFrames::Reset](../../debugger/debug-interface-access/idiaenumstackframes-reset.md)|Resets an enumeration sequence to the beginning.|
25+
26+
## Remarks
27+
28+
## Notes for Callers
29+
Obtain this interface by calling the [IDiaStackWalker::getEnumFrames](../../debugger/debug-interface-access/idiastackwalker-getenumframes.md) or [IDiaStackWalker::getEnumFrames2](../../debugger/debug-interface-access/idiastackwalker-getenumframes2.md) methods.
30+
31+
## Example
32+
This example shows how to obtain and use the `IDiaEnumStackFrames` interface. See the [IDiaStackFrame](../../debugger/debug-interface-access/idiastackframe.md) interface for an implementation of the `PrintStackFrame` function.
33+
34+
```C++
35+
void DumpStackFrames(IDiaStackWalker* pStackWalker,
36+
IDiaStackWalkHelper* pStackWalkHelper,
37+
CV_CPU_TYPE_e cpuType)
38+
{
39+
if (pStackWalker != NULL && pStackWalkHelper != NULL)
40+
{
41+
CComPtr<IDiaEnumStackFrames> pEnumsFrames;
42+
HRESULT hr;
43+
hr = pStackWalker->getEnumFrames2(cpuType, pStackWalkHelper, &pEnumFrames);
44+
if (SUCCEEDED(hr) && pEnumFrames != NULL)
45+
{
46+
CComPtr<IDiaStackFrame> pStackFrame;
47+
DWORD celt = 0;
48+
49+
while (pEnumFrames->Next(1, &pStackFrame, &celt) == S_OK)
50+
{
51+
PrintStackFrame(pStackFrame);
52+
}
53+
pStackFrame = NULL;
54+
}
55+
}
56+
}
57+
```
58+
59+
## Requirements
60+
Header: Dia2.h
61+
62+
Library: diaguids.lib
63+
64+
DLL: msdia80.dll
65+
66+
## See Also
67+
[Interfaces (Debug Interface Access SDK)](../../debugger/debug-interface-access/interfaces-debug-interface-access-sdk.md)
68+
[IDiaStackWalkFrame](../../debugger/debug-interface-access/idiastackwalkframe.md)
69+
[IDiaStackWalker::getEnumFrames2](../../debugger/debug-interface-access/idiastackwalker-getenumframes2.md)
70+
[IDiaStackWalker::getEnumFrames](../../debugger/debug-interface-access/idiastackwalker-getenumframes.md)

0 commit comments

Comments
 (0)