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

public static ulong m_NumErrors

The number of errors.

public static ulong m_MaxNumErrors

The maximum number of errors allowed.

public static ulong m_NumWarnings

The number of warnings.

public static bool m_WarningsAreEnabled

Are warnings enabled? The default is true.

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.

public static ulong GetRingBufferSize ( ) ;

Returns the maximum size of a ring buffer.

Return:

The maximum size of a ring buffer.

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

Print an error message.

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

Print a warning message.

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

Print a status message.

public static const char * GetVersion ( ) ;

Get the current ccdoc version number.

public static void OpenLog ( const char * file ) ;

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

public static void CloseLog ( ) ;

Turn off logging.