IDebugDocumentContext2::EnumCodeContexts
Retrieves a list of all code contexts associated with this document context.
HRESULT EnumCodeContexts(
IEnumDebugCodeContexts2** ppEnumCodeCxts
);
int EnumCodeContexts(
out IEnumDebugCodeContexts2 ppEnumCodeCxts
);
Parameters
- ppEnumCodeCxts
[out] Returns an IEnumDebugCodeContexts2 object that contains a list of code contexts.
Return Value
If successful, returns S_OK; otherwise, returns an error code.
Remarks
A single document context can generate multiple code contexts when the document is using templates or include files.
Example
The following example shows how to implement this method for a simple CDebugContext object that exposes the IDebugDocumentContext2 interface.
HRESULT CDebugContext::EnumCodeContexts(IEnumDebugCodeContexts2 **ppEnumCodeCxts)
{
HRESULT hr;
// Check for a valid IEnumDebugCodeContexts2 interface pointer.
if (ppEnumCodeCxts)
{
*ppEnumCodeCxts = NULL;
// Create a CEnumDebugCodeContexts object.
CComObject<CEnumDebugCodeContexts>* pEnum;
hr = CComObject<CEnumDebugCodeContexts>::CreateInstance(&pEnum);
assert(hr == S_OK);
if (hr == S_OK)
{
// Get an IID_IDebugCodeContext2 interface.
CComPtr<IDebugCodeContext2> spCodeCxt;
hr = QueryInterface(IID_IDebugCodeContext2,
(void**)&spCodeCxt);
assert(hr == S_OK);
if (hr == S_OK)
{
// Initialize the code context enumerator with the
// IDebugCodeContext2 information.
IDebugCodeContext2* rgpCodeContext[] = { spCodeCxt.p };
hr = pEnum->Init(rgpCodeContext,
&(rgpCodeContext[1]),
NULL,
AtlFlagCopy);
assert(hr == S_OK);
if (hr == S_OK)
{
// Set the passed IEnumDebugCodeContexts2 pointer equal to the pointer
// value of the created CEnumDebugCodeContexts object.
hr = pEnum->QueryInterface(ppEnumCodeCxts);
assert(hr == S_OK);
}
}
// Otherwise, delete the CEnumDebugCodeContexts object.
if (FAILED(hr))
{
delete pEnum;
}
}
}
else
{
hr = E_INVALIDARG;
}
return hr;
}