OpenDOF Project
Typedefs | Enumerations | Functions
DOFException
Distributed Object Framework (DOF)

DOFException encapsulates DOFError codes and provider item exceptions. More...

Typedefs

typedef uint32 DOFError
 Standard OAL error codes type.
 

Enumerations

enum  DOFExceptionType {
  DOFEXCEPTIONTYPE_ERROR,
  DOFEXCEPTIONTYPE_PROVIDER
}
 Exception type. More...
 

Functions

DOFException DOFException_Copy (const DOFException self)
 Create a new copy of an existing DOFException.
 
DOFException DOFErrorException_Create (DOFError error, const char *message)
 Construct a DOFErrorException from a DOFError code and a string.
 
DOFException DOFProviderException_Create (DOFInterfaceException iException, uint16 parameterCount, const DOFValue *parameters)
 Construct a DOFException using an Interface Exception (an Item within an Interface).
 
void DOFException_Destroy (DOFException self)
 Destroy a DOFException.
 
DOFExceptionType DOFException_GetType (const DOFException self)
 Get the type of the DOFException.
 
DOFError DOFErrorException_GetError (const DOFException self)
 Get the error code for the DOFException.
 
const char * DOFErrorException_GetMessage (const DOFException self)
 Get the error message string associated with the DOFException.
 
const void * DOFErrorException_GetData (const DOFException self)
 Get the extra data associated with the DOFException, if any.
 
DOFInterfaceException DOFProviderException_GetInterfaceException (const DOFException self)
 Get the Interface Exception associated with the DOFException.
 
DOFValueDOFProviderException_GetParameters (const DOFException self)
 Get the parameters of the DOFException.
 
uint8 DOFProviderException_GetParametersCount (const DOFException self)
 Get the count of parameters of the DOFException.
 
DOFProviderInfo DOFException_GetProviderInfo (const DOFException self)
 Get the DOFProviderInfo of the DOFException, if any.
 

Detailed Description

DOFException encapsulates DOFError codes and provider item exceptions.

core-c-dof-oal Version 8.0.1 Build 0
2018-01-22