FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoContext Class Reference

#include <Context.h>

Inherits FdoDisposable.

Inherited by FdoSchemaMergeContext, and FdoXmlSaxContext.

Inheritance diagram for FdoContext:

[legend]
List of all members.

Detailed Description

FdoContext is a common base for all FDO context classes. A context class is used in complex operations involving multiple functions. It providers a convenient container for passing information between these functions. This class provides an error list where errors that occur during processing can be logged and reported when the processing completes. Sub-classes can add more specific information to pass around.

Definition at line 30 of file Common/Context.h.


Public Member Functions

FDO_API_COMMON void AddError (FdoException *ex)
 Adds an error to the error list.
virtual FDO_API_COMMON void ThrowErrors ()
 Throws all errors in the error list. The errors are thrown as a chain. The first error is one thrown. The second error is set to be the cause of the first error, the third the cause of the second and so on.

Static Public Member Functions

FDO_API_COMMON FdoContextCreate ()
 Constructs the context.

Protected Member Functions

FDO_API_COMMON FdoContext ()
virtual FDO_API_COMMON ~FdoContext ()

Constructor & Destructor Documentation

FDO_API_COMMON FdoContext::FdoContext  )  [protected]
 

virtual FDO_API_COMMON FdoContext::~FdoContext  )  [protected, virtual]
 


Member Function Documentation

FDO_API_COMMON void FdoContext::AddError FdoException ex  ) 
 

Adds an error to the error list.

Parameters:
ex Input the error to add.
Warning:
If this error has a cause, it will be overridden when thrown (see ThrowErrors()).

FDO_API_COMMON FdoContext* FdoContext::Create  )  [static]
 

Constructs the context.

Returns:
Returns FdoContext

virtual FDO_API_COMMON void FdoContext::ThrowErrors  )  [virtual]
 

Throws all errors in the error list. The errors are thrown as a chain. The first error is one thrown. The second error is set to be the cause of the first error, the third the cause of the second and so on.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.