IDebugStackFrame::GetDescriptionString Method

---

Retrieves a text description of the stack frame.

Syntax

HRESULT GetDescriptionString(
    BOOL fLong,
    BSTR *pbstrDescription
);

Parameters

fLong

[in] Boolean value that indicates whether the description of the stack frame is long or short.

pbstrDescription

[out] Address of a string that contains the description of the stack frame.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

For the fLong parameter, a value of FALSE indicates a short description that contains only the name of the function associated with the stack frame. A value of TRUE indicates that the description includes more information, such as function parameters.