Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

sobjxc_message Struct Reference
[Implementation]

#include <sobjxc.h>

Collaboration diagram for sobjxc_message:

Collaboration graph
[legend]

Detailed Description

Structure representing a message.


Data Fields

sobjxc_messagenext
 The next message in the message list.
const char * module
 The module name.
const char * prefix
 The function prefix.
const char * mprefix
 The macro prefix.
bool option_i18n
 Flag indicating if the message should be internationalized.
bool option_syslog
 Flag indicating if the message should be logged to syslog().
bool option_doc_comment
 Flag indicating if a Doxygen/Javadoc comment should be written before the function/method bodies.
const char ** fix_param_name
 Vector of fixed parameter names.
sobj ** fix_param_value
 Vector of fixed parameter values.
int fix_param_n
 The number of fixed parameters.
sobjoptions
 The message options object.
int level
 The message level.
const char * id
 The message ID.
sobjxc_paramparam_list
 The message parameter list.
const char * body
 The message body.

Related Functions

(Note that these are not member functions.)

sobjxc_messagenew_sobjxc_message (enum sobjxc_message_type type, int level, const char *id)
 Create a new message object.
void delete_sobjxc_message (struct sobjxc_message *message)
 Delete a message object.
void sobjxc_message_add_fixed_param (struct sobjxc_message *message, const char *name, struct sobj *value)
 Add a fixed parameter to a message.
int sobjxc_message_write_xml (const struct sobjxc_message *message, FILE *fp, const char *filename)
 Write an XML representation of a message object to the specified stream.


Field Documentation

const char* sobjxc_message::body
 

The message body.

int sobjxc_message::fix_param_n
 

The number of fixed parameters.

const char** sobjxc_message::fix_param_name
 

Vector of fixed parameter names.

struct sobj** sobjxc_message::fix_param_value
 

Vector of fixed parameter values.

const char* sobjxc_message::id
 

The message ID.

int sobjxc_message::level
 

The message level.

const char* sobjxc_message::module
 

The module name.

const char* sobjxc_message::mprefix
 

The macro prefix.

This may be a null-pointer if no macro variant of the message function should be created.

struct sobjxc_message* sobjxc_message::next
 

The next message in the message list.

bool sobjxc_message::option_doc_comment
 

Flag indicating if a Doxygen/Javadoc comment should be written before the function/method bodies.

bool sobjxc_message::option_i18n
 

Flag indicating if the message should be internationalized.

bool sobjxc_message::option_syslog
 

Flag indicating if the message should be logged to syslog().

struct sobj* sobjxc_message::options
 

The message options object.

struct sobjxc_param* sobjxc_message::param_list
 

The message parameter list.

const char* sobjxc_message::prefix
 

The function prefix.


The documentation for this struct was generated from the following files:
Generated on Sat Jul 23 16:07:27 2005 for sobject by  doxygen 1.3.9.1