BugTrap: BTTrace Class Reference

BugTrap

previous page next page

BTTrace Class Reference

C++ wrapper for tracing API. More...

List of all members.

Public Member Functions

BOOL Append (LPCTSTR pszEntry) const
 Append entry to the end of custom log file.
BOOL Append (BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszEntry) const
 Append entry to the end of custom log file.
BOOL AppendF (LPCTSTR pszFormat,...) const
 Append entry to the end of custom log file.
BOOL AppendF (BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszFormat,...) const
 Append entry to the end of custom log file.
BOOL AppendV (LPCTSTR pszFormat, va_list argList) const
 Append entry to the end of custom log file.
BOOL AppendV (BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszFormat, va_list argList) const
 Append entry to the end of custom log file.
void Attach (INT_PTR iHandle)
 Attach log file handle.
 BTTrace (LPCTSTR pszLogFileName, BUGTRAP_LOGFORMAT eLogFormat)
 Initialize the object.
 BTTrace (INT_PTR iHandle)
 Initialize the object.
 BTTrace (void)
 Initialize the object.
BOOL Clear (void) const
 Clear log file.
BOOL Close (void)
 Close log file.
void Detach (void)
 Detach log file handle.
BOOL Flush (void) const
 Flush contents of the log file.
BUGTRAP_LOGLEVEL GetDefaultLogLevel (void) const
 Get default log level.
LPCTSTR GetFileName (void) const
 Get custom log file name.
INT_PTR GetHandle (void) const
 Get custom log file handle.
DWORD GetLogEchoMode (void) const
 Get log echo mode.
DWORD GetLogFlags (void) const
 Return current set of log flags.
BUGTRAP_LOGLEVEL GetLogLevel (void) const
 Return minimal log level accepted by tracing functions.
DWORD GetLogSizeInBytes (void) const
 Get custom log file size in bytes.
DWORD GetLogSizeInEntries (void) const
 Get custom log file size in records.
BOOL Insert (LPCTSTR pszEntry) const
 Insert entry into the beginning of custom log file.
BOOL Insert (BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszEntry) const
 Insert entry into the beginning of custom log file.
BOOL InsertF (LPCTSTR pszFormat,...) const
 Insert entry into the beginning of custom log file.
BOOL InsertF (BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszFormat,...) const
 Insert entry into the beginning of custom log file.
BOOL InsertV (LPCTSTR pszFormat, va_list argList) const
 Insert entry into the beginning of custom log file.
BOOL InsertV (BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszFormat, va_list argList) const
 Insert entry into the beginning of custom log file.
INT_PTR Open (LPCTSTR pszLogFileName, BUGTRAP_LOGFORMAT eLogFormat)
 Open log file.
void SetDefaultLogLevel (BUGTRAP_LOGLEVEL eDefaultLogLevel)
 Set default log level.
BOOL SetLogEchoMode (DWORD dwLogEchoMode) const
 Set log echo mode.
BOOL SetLogFlags (DWORD dwLogFlags) const
 Set new set of log flags.
BOOL SetLogLevel (BUGTRAP_LOGLEVEL eLogLevel) const
 Set minimal log level accepted by tracing functions.
BOOL SetLogSizeInBytes (DWORD dwSize) const
 Set custom log file size in bytes.
BOOL SetLogSizeInEntries (DWORD dwSize) const
 Set custom log file size in records.
 ~BTTrace (void)
 Destroy the object.

Private Member Functions

 BTTrace (const BTTrace &rTrace)
 Prevent object from being accidentally copied.
BTTrace & operator= (const BTTrace &rTrace)
 Prevent object from being accidentally copied.

Private Attributes

BUGTRAP_LOGLEVEL m_eDefaultLogLevel
 Default log level.
INT_PTR m_iHandle
 Log file handle.

Detailed Description

C++ wrapper for tracing API.

Constructor & Destructor Documentation

BTTrace::BTTrace ( void   ) 

Initialize the object.

References Detach().

BTTrace::BTTrace ( INT_PTR  iHandle  ) 

Initialize the object.

References BTLL_INFO, m_eDefaultLogLevel, and m_iHandle.

BTTrace::BTTrace ( LPCTSTR  pszLogFileName,
BUGTRAP_LOGFORMAT  eLogFormat 
)

Initialize the object.

References BT_OpenLogFile(), BTLL_INFO, m_eDefaultLogLevel, and m_iHandle.

BTTrace::~BTTrace ( void   ) 

Destroy the object.

References Close().

BTTrace::BTTrace ( const BTTrace &  rTrace  )  [private]

Prevent object from being accidentally copied.

Member Function Documentation

BOOL BTTrace::Append ( LPCTSTR  pszEntry  )  const

Append entry to the end of custom log file.

References BT_AppLogEntry(), m_eDefaultLogLevel, and m_iHandle.

BOOL BTTrace::Append ( BUGTRAP_LOGLEVEL  eLogLevel,
LPCTSTR  pszEntry 
) const

Append entry to the end of custom log file.

References BT_AppLogEntry(), and m_iHandle.

BOOL BTTrace::AppendF ( LPCTSTR  pszFormat,
  ... 
) const

Append entry to the end of custom log file.

References BT_AppLogEntryV(), m_eDefaultLogLevel, and m_iHandle.

BOOL BTTrace::AppendF ( BUGTRAP_LOGLEVEL  eLogLevel,
LPCTSTR  pszFormat,
  ... 
) const

Append entry to the end of custom log file.

References BT_AppLogEntryV(), and m_iHandle.

BOOL BTTrace::AppendV ( LPCTSTR  pszFormat,
va_list  argList 
) const

Append entry to the end of custom log file.

References BT_AppLogEntryV(), m_eDefaultLogLevel, and m_iHandle.

BOOL BTTrace::AppendV ( BUGTRAP_LOGLEVEL  eLogLevel,
LPCTSTR  pszFormat,
va_list  argList 
) const

Append entry to the end of custom log file.

References BT_AppLogEntryV(), and m_iHandle.

void BTTrace::Attach ( INT_PTR  iHandle  ) 

Attach log file handle.

References m_iHandle.

BOOL BTTrace::Clear ( void   )  const

Clear log file.

References BT_ClearLog(), and m_iHandle.

BOOL BTTrace::Close ( void   ) 

Close log file.

References BT_CloseLogFile(), Detach(), and m_iHandle.

Referenced by Open(), and ~BTTrace().

void BTTrace::Detach ( void   ) 

Detach log file handle.

References BTLL_INFO, m_eDefaultLogLevel, and m_iHandle.

Referenced by BTTrace(), and Close().

BOOL BTTrace::Flush ( void   )  const

Flush contents of the log file.

References BT_FlushLogFile(), and m_iHandle.

BUGTRAP_LOGLEVEL BTTrace::GetDefaultLogLevel ( void   )  const

Get default log level.

References m_eDefaultLogLevel.

LPCTSTR BTTrace::GetFileName ( void   )  const

Get custom log file name.

References BT_GetLogFileName(), and m_iHandle.

INT_PTR BTTrace::GetHandle ( void   )  const

Get custom log file handle.

References m_iHandle.

DWORD BTTrace::GetLogEchoMode ( void   )  const

Get log echo mode.

References BT_GetLogEchoMode(), and m_iHandle.

DWORD BTTrace::GetLogFlags ( void   )  const

Return current set of log flags.

References BT_GetLogFlags(), and m_iHandle.

BUGTRAP_LOGLEVEL BTTrace::GetLogLevel ( void   )  const

Return minimal log level accepted by tracing functions.

References BT_GetLogLevel(), and m_iHandle.

DWORD BTTrace::GetLogSizeInBytes ( void   )  const

Get custom log file size in bytes.

References BT_GetLogSizeInBytes(), and m_iHandle.

DWORD BTTrace::GetLogSizeInEntries ( void   )  const

Get custom log file size in records.

References BT_GetLogSizeInEntries(), and m_iHandle.

BOOL BTTrace::Insert ( LPCTSTR  pszEntry  )  const

Insert entry into the beginning of custom log file.

References BT_InsLogEntry(), m_eDefaultLogLevel, and m_iHandle.

BOOL BTTrace::Insert ( BUGTRAP_LOGLEVEL  eLogLevel,
LPCTSTR  pszEntry 
) const

Insert entry into the beginning of custom log file.

References BT_InsLogEntry(), and m_iHandle.

BOOL BTTrace::InsertF ( LPCTSTR  pszFormat,
  ... 
) const

Insert entry into the beginning of custom log file.

References BT_InsLogEntryV(), m_eDefaultLogLevel, and m_iHandle.

BOOL BTTrace::InsertF ( BUGTRAP_LOGLEVEL  eLogLevel,
LPCTSTR  pszFormat,
  ... 
) const

Insert entry into the beginning of custom log file.

References BT_InsLogEntryV(), and m_iHandle.

BOOL BTTrace::InsertV ( LPCTSTR  pszFormat,
va_list  argList 
) const

Insert entry into the beginning of custom log file.

References BT_InsLogEntryV(), m_eDefaultLogLevel, and m_iHandle.

BOOL BTTrace::InsertV ( BUGTRAP_LOGLEVEL  eLogLevel,
LPCTSTR  pszFormat,
va_list  argList 
) const

Insert entry into the beginning of custom log file.

References BT_InsLogEntryV(), and m_iHandle.

INT_PTR BTTrace::Open ( LPCTSTR  pszLogFileName,
BUGTRAP_LOGFORMAT  eLogFormat 
)

Open log file.

References BT_OpenLogFile(), Close(), and m_iHandle.

BTTrace& BTTrace::operator= ( const BTTrace &  rTrace  )  [private]

Prevent object from being accidentally copied.

void BTTrace::SetDefaultLogLevel ( BUGTRAP_LOGLEVEL  eDefaultLogLevel  ) 

Set default log level.

References m_eDefaultLogLevel.

BOOL BTTrace::SetLogEchoMode ( DWORD  dwLogEchoMode  )  const

Set log echo mode.

References BT_SetLogEchoMode(), and m_iHandle.

BOOL BTTrace::SetLogFlags ( DWORD  dwLogFlags  )  const

Set new set of log flags.

References BT_SetLogFlags(), and m_iHandle.

BOOL BTTrace::SetLogLevel ( BUGTRAP_LOGLEVEL  eLogLevel  )  const

Set minimal log level accepted by tracing functions.

References BT_SetLogLevel(), and m_iHandle.

BOOL BTTrace::SetLogSizeInBytes ( DWORD  dwSize  )  const

Set custom log file size in bytes.

References BT_SetLogSizeInBytes(), and m_iHandle.

BOOL BTTrace::SetLogSizeInEntries ( DWORD  dwSize  )  const

Set custom log file size in records.

References BT_SetLogSizeInEntries(), and m_iHandle.

Member Data Documentation

BUGTRAP_LOGLEVEL BTTrace::m_eDefaultLogLevel [private]

Default log level.

Referenced by Append(), AppendF(), AppendV(), BTTrace(), Detach(), GetDefaultLogLevel(), Insert(), InsertF(), InsertV(), and SetDefaultLogLevel().

INT_PTR BTTrace::m_iHandle [private]

Log file handle.

Referenced by Append(), AppendF(), AppendV(), Attach(), BTTrace(), Clear(), Close(), Detach(), Flush(), GetFileName(), GetHandle(), GetLogEchoMode(), GetLogFlags(), GetLogLevel(), GetLogSizeInBytes(), GetLogSizeInEntries(), Insert(), InsertF(), InsertV(), Open(), SetLogEchoMode(), SetLogFlags(), SetLogLevel(), SetLogSizeInBytes(), and SetLogSizeInEntries().

Generated on Sun Dec 21 21:40:08 2008 for BugTrap by  doxygen 1.5.7.1
previous page start next page