Share via


IDebugStackFrame::GetDescriptionString

Returns a short or long textual description of the stack frame.

Syntax

HRESULT GetDescriptionString(  
   BOOL   fLong,  
   BSTR*  pbstrDescription  
);  

Parameters

fLong
[in] Flag, where TRUE returns a long description and FALSE returns a short description.

pbstrDescription
[out] The description of the stack frame.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Value Description
S_OK The method succeeded.

Remarks

Typically, if fLong is FALSE, this method provides only the name of the function associated with the stack frame. When fLong is TRUE, this method may also provide the function parameters and other relevant information.

See also

IDebugStackFrame Interface