Main Page Modules Class Hierarchy Data Structures File List Data Fields Globals Related Pages

# PVLoggerLayout Class Reference

`#include <pvlogger_accessories.h>`

## Public Types
typedef PVLogger::message_id_type | message_id_type
## Public Methods
virtual | ~PVLoggerLayout ()
virtual int32 | FormatString (char *formatBuf, int32 formatBufSize, message_id_type msgID, const char *fmt, va_list va)=0
virtual int32 | FormatOpaqueMessage (char *formatBuf, int32 formatBufSize, message_id_type msgID, int32 numPairs, va_list va)=0

## Detailed Description

Base class for all message formatters. This class defines the interface to the message formatter. There are two kinds of msg formatting APIs, one to format text messages, and other to format opaque message buffers.

## Member Typedef Documentation

typedef PVLogger::message_id_type PVLoggerLayout::message_id_type

## Constructor & Destructor Documentation

virtual PVLoggerLayout::~PVLoggerLayout | ( |  | ) | `[inline, virtual]`

## Member Function Documentation

virtual int32 PVLoggerLayout::FormatOpaqueMessage | ( | char * | formatBuf,
|  | int32 | formatBufSize,
|  | message_id_type | msgID,
|  | int32 | numPairs,
|  | va_list | va
| ) | `[pure virtual]`

| Formats the data and copies it to the given buffer. Returns: The length of the buffer used.

virtual int32 PVLoggerLayout::FormatString | ( | char * | formatBuf,
|  | int32 | formatBufSize,
|  | message_id_type | msgID,
|  | const char * | fmt,
|  | va_list | va
| ) | `[pure virtual]`

| Formats the string and copies it to the given buffer. Returns: The length of the string not including the trailing '\0'

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

- pvlogger_accessories.h