Share via


IeXdi2Exec::GetExceptionDescriptionList (Windows Embedded CE 6.0)

1/5/2010

This method returns the supported exception description table.

Syntax

HRESULT GetExceptionDescriptionList(
  [out] DWORD *pdwNbTotalExceptionInList,
  [out, size_is(,* pdwNbTotalExceptionInList)] EXCEPTION_DESCRIPTION_TYPE ** ppedTable
);

Parameters

  • pdwNbTotalExceptionInList
    Pointer to the number of EXCEPTION_DESCRIPTION_TYPE elements to be provided in ppedTable.
  • ppedTable
    Pointer to the table of EXCEPTION_DESCRIPTION_TYPE elements that associate exception number, name, and debugger action. The buffer for this value is allocated by CoTaskMemAlloc.

Return Value

The following table shows return values for this method.

Value Description

S_OK

Indicates the function was successful.

E_FAIL

Indicates an unspecified failure.

E_NOTIMPL

Indicates the error code is not implemented.

EXDI_E_COMMUNICATION

Indicates a communication error between host driver and debugging target.

Remarks

A client such as Platform Builder can use this method to acquire the set of exception codes and corresponding descriptions that can be expected from the eXDI service.

Platform Builder acquires this list when starting the debugger and connecting to the eXDI service.

To avoid resource leaking, use CoTaskMemFree to free the task memory used by the buffer that this function uses to return EXCEPTION_DESCRIPTION_TYPE elements, ppedTable.

The following example shows how you might use CoTaskMemFree to release the memory held for the return buffers.

DWORD dwNbEntries;
EXCEPTION_DESCRIPTION_TYPE *ppedTable;
HRESULT hr = pieXdi2Exec->GetExceptionDescriptionList (&dwNbEntries, &ppedTable);
if (SUCCEEDED (hr))
{
    // Use exception list ..
    CoTaskMemFree (ppedTable);
    ped = 0;
}

Requirements

Header eXDI2.h
Library ole32.lib, oleaut32.lib
Windows Embedded CE Windows CE 5.0 and later

See Also

Reference

IeXdi2Exec
IeXDI2 Interfaces