TOP --> CcDoc

class CCcDocUtils

General utilities used by all clients in the subsystem.

Author:
Joe Linoff

Version:
$Id: ccdocutils.h,v 1.4 1999/06/12 18:10:33 jdl Exp $

Source:
../../ccdoc/src/ccdocutils.h:57

Variables Index

m_MaxNumErrors
[public] The maximum number of errors allowed.
m_NumErrors
[public] The number of errors.
m_NumWarnings
[public] The number of warnings.
m_WarningsAreEnabled
[public] Are warnings enabled? The default is true.


Methods Index

CloseLog
[public] Turn off logging.
Err
[public] Print an error message.
GetRingBuffer
[public] Return a temporary string from a ring buffer with a maximum of 64K characters.
GetRingBufferSize
[public] Returns the maximum size of a ring buffer.
GetVersion
[public] Get the current ccdoc version number.
OpenLog
[public] Turn on logging. This only works for the Err(), Warn() and Status() methods.
Status
[public] Print a status message.
Warn
[public] Print a warning message.


Variables

m_NumErrors

public static ulong m_NumErrors

The number of errors.

m_MaxNumErrors

public static ulong m_MaxNumErrors

The maximum number of errors allowed.

m_NumWarnings

public static ulong m_NumWarnings

The number of warnings.

m_WarningsAreEnabled

public static bool m_WarningsAreEnabled

Are warnings enabled? The default is true.


Methods

GetRingBuffer

public static char * GetRingBuffer ( ) ;

Return a temporary string from a ring buffer with a maximum of 64K characters.

Return:
A temporary string from a ring buffer.

GetRingBufferSize

public static ulong GetRingBufferSize ( ) ;

Returns the maximum size of a ring buffer.

Return:
The maximum size of a ring buffer.

Err

public static void Err ( const char * fmt ,
                         . . . ) ;

Print an error message.

Parameters:
fmt The format string.
args The variable argument list.

Warn

public static void Warn ( const char * fmt ,
                          . . . ) ;

Print a warning message.

Parameters:
fmt The format string.
args The variable argument list.

Status

public static void Status ( const char * fmt ,
                            . . . ) ;

Print a status message.

Parameters:
fmt The format string.
args The variable argument list.

GetVersion

public static const char * GetVersion ( ) ;

Get the current ccdoc version number.

OpenLog

public static void OpenLog ( const char * file ) ;

Turn on logging. This only works for the Err(), Warn() and Status() methods.

Parameters:
file The name of the log file.

CloseLog

public static void CloseLog ( ) ;

Turn off logging.


This documentation was generated automatically by the ccdoc tool (version 0.7a).
Click here to submit a bug report or feature request.

Click here to return to the top of the page.