SESqlError Class Reference

This class models SQL errors and warnings. More...

List of all members.

Public Member Functions

simba_signed_native GetColNumber () const
 Get the row number.
DiagState GetDiagState () const
 Get the DiagState for this SQL error.
const simba_wstringGetMsgKey () const
 Get the message key.
simba_signed_native GetRowNumber () const
 Get the column number.
 SESqlError (SESqlErrorType in_sqlErrType, simba_signed_native in_rowNumber, simba_int32 in_colNumber)
 Constructor.
 SESqlError (SESqlErrorType in_sqlErrType)
 Type conversion constructor.
 ~SESqlError ()
 Destructor.

Detailed Description

This class models SQL errors and warnings.

Multiple SESqlError might correspond to the same DiagState. Also, SQL warnings are also modeled by this class.


Constructor & Destructor Documentation

SESqlError ( SESqlErrorType  in_sqlErrType  ) 

Type conversion constructor.

This constructor is made implicit so that an object of this class can be easily created with an SESqlErrorType. For example, one only needs to do the following to throw an SESqlErrorException,

 throw SESqlErrorException(SE_ERR_INVALID_ARG);
Parameters:
in_sqlErrType The number that identifies this SQL error.
SESqlError ( SESqlErrorType  in_sqlErrType,
simba_signed_native  in_rowNumber,
simba_int32  in_colNumber 
)

Constructor.

This constructor is made implicit so that an object of this class can be easily created with an SEDiagnosticID.

Parameters:
in_sqlErrType The number that identifies this SQL error.
in_colNumber Column for the error. May be a non-negative integer, NO_COLUMN_NUMBER, or COLUMN_NUMBER_UNKNOWN.
in_rowNumber Row for the error. May be a non-negative integer, NO_ROW_NUMBER, or ROW_NUMBER_UNKNOWN.
~SESqlError (  ) 

Destructor.


Member Function Documentation

simba_signed_native GetColNumber (  )  const

Get the row number.

Returns:
the row number.
DiagState GetDiagState (  )  const

Get the DiagState for this SQL error.

Returns:
the DiagState for this SQL error.
const simba_wstring& GetMsgKey (  )  const

Get the message key.

Returns:
a pointer reference to the message key. (NOT OWN)
simba_signed_native GetRowNumber (  )  const

Get the column number.

Returns:
the column number.

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

Generated on Wed May 17 14:21:18 2017 for SimbaEngine 10.1.3.1011 by simba