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

sobjxc_exception Struct Reference
[Implementation]

#include <sobjxc.h>

Collaboration diagram for sobjxc_exception:

Collaboration graph
[legend]

Detailed Description

Structure representing an exception class.


Data Fields

sobjxc_exceptionnext
 The next exception in the exception 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 exception should be internationalized.
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 exception options object.
const char ** xcls
 The vector of exception classes.
int xcls_n
 The number of exception classes.
const char * cn
 The class name of the exception object.
const char * id
 The exception ID.
sobjxc_paramparam_list
 The exception parameter list.
const char * body
 The exception documentation body.

Related Functions

(Note that these are not member functions.)

sobjxc_exceptionnew_sobjxc_exception (const char **xcls, int xcls_n, const char *id)
 Create a new exception object.
void delete_sobjxc_exception (struct sobjxc_exception *exception)
 Delete an exception object.
void sobjxc_exception_add_fixed_param (struct sobjxc_exception *exception, const char *name, struct sobj *value)
 Add a fixed parameter to an exception.
int sobjxc_exception_write_xml (const struct sobjxc_exception *exception, FILE *fp, const char *filename)
 Write an XML representation of an exception object to the specified stream.


Field Documentation

const char* sobjxc_exception::body
 

The exception documentation body.

const char* sobjxc_exception::cn
 

The class name of the exception object.

A null-pointer for default ("exc").

int sobjxc_exception::fix_param_n
 

The number of fixed parameters.

const char** sobjxc_exception::fix_param_name
 

Vector of fixed parameter names.

struct sobj** sobjxc_exception::fix_param_value
 

Vector of fixed parameter values.

const char* sobjxc_exception::id
 

The exception ID.

const char* sobjxc_exception::module
 

The module name.

const char* sobjxc_exception::mprefix
 

The macro prefix.

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

struct sobjxc_exception* sobjxc_exception::next
 

The next exception in the exception list.

bool sobjxc_exception::option_doc_comment
 

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

bool sobjxc_exception::option_i18n
 

Flag indicating if the exception should be internationalized.

struct sobj* sobjxc_exception::options
 

The exception options object.

struct sobjxc_param* sobjxc_exception::param_list
 

The exception parameter list.

const char* sobjxc_exception::prefix
 

The function prefix.

const char** sobjxc_exception::xcls
 

The vector of exception classes.

int sobjxc_exception::xcls_n
 

The number of exception classes.


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