CStackReport Class Reference

Generates a stack report. More...

#include <StackReport.h>

List of all members.

Public Member Functions

CStackReport ()

Default Constructor.

virtual ~CStackReport ()

Destructor.

Static Public Member Functions

static BOOL CallStack (CReg *pReg, CStackTrace *pSt)

Generate a stack report.

static BOOL History (CReg *pReg, CStackTrace *pSt)

Generate a stack history report.

static BOOL Profile (CReg *pReg, CStackTrace *pSt)

Call to generate a stack profile report.

Detailed Description

Generates a stack report.

This class contains a few functions to generate a stack report from the specified CStackTrace object.

Member Function Documentation

BOOL CStackReport::CallStack ( CReg * pReg,

CStackTrace * pSt

) [static]

Generate a stack report.

Parameters:

[out] pReg - Receives the stack report

[in] pSt - CStackTrace object pointer

Upon return, the CReg object will contain a key entry for each thread, and the current call stack for each thread will be in the key value fields in order of most recently called functions first.

Returns:
Non-zero if successful

See also:

BOOL CStackReport::History ( CReg * pReg,

CStackTrace * pSt

) [static]

Generate a stack history report.

Parameters:

[out] pReg - Receives the stack trace

[in] pSt - CStackTrace object pointer

Upon return, the CReg object will contain a key entry for each thread, and the current stack trace for each thread will be in the key value fields in order of most recently called functions first.
The stack trace is just the names of the last n number of functions called.

Returns:
Non-zero if successful

See also:

BOOL CStackReport::Profile ( CReg * pReg,

CStackTrace * pSt

) [static]

Call to generate a stack profile report.

Parameters:

[out] pReg - Receives the stack trace

[in] pSt - CStackTrace object pointer

Upon return, the CReg object will contain a key entry for each thread, and the current stack profile for each thread will be in the key value fields in order of most recently called functions first.
The stack profile contains the name of each function as the key entry name, and the total amount of time spent in that function as the key entry value.

Returns:
Non-zero if successful

See also:

The documentation for this class was generated from the following files:

inc/StackReport.h
StackReport.cpp