All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

Miscellaneous Class CATVPMError

CATVPMError

public class CATVPMError

Object to manage errors in VPM APIs or User-Exits.

Notes:

Link with module LV0PSBAS.

Following convention is used for naming parameters.
Parameter names prefixed by:

i are input parameters

o are ouput parameters

io are input/output parameters

Constructor and Destructor Index

o CATVPMError(): Constructor
o CATVPMError(CATVPMError&): Copy constructor
o ~CATVPMError(): Destructor

Method Index

o Ier(): Get the error code
o LongMsg(): Get the error message
o Ok(): Reset as OK (no error)
o Set(int,char*,char*,int): Set the error parameters
o Severity(): Get the error severity
o ShortMsg(): Get the error title
o operator =(CATVPMError&): Copy operator

Constructor and Destructor

o CATVPMError

public CATVPMError(

)

Constructor

o CATVPMError

public CATVPMError( const CATVPMError& iErrSource)

Copy constructor

o ~CATVPMError

public ~CATVPMError(

)

Destructor

Methods

o Ier

public int Ier(

)const

Get the error code

Returns:: error code

o LongMsg

public const char * LongMsg(

)const

Get the error message

Returns:: error message

o Ok

public void Ok(

)

Reset as OK (no error)

o Set

public void Set(	const int	`iIer`,
	const char*	`iShortMsg`	`=NULL`,
	const char*	`iLongMsg`	`=NULL`,
	const int	`iSeverity`	`=4`)

Set the error parameters

Parameters:

iIer: error code
iShortMsg: title of the error
iLongMsg: message to display
iSeverity: severity of the error
-1 information
0 warning
1->n error severity 1, 2, 3, ...

o Severity

public int Severity(

)const

Get the error severity

Returns:: error severity

o ShortMsg

public const char * ShortMsg(

)const

Get the error title

Returns:: error title

o operator =

public CATVPMError& operator =( const CATVPMError& iErrSouce)

Copy operator

This object is included in the file: CATVPMError.h
If needed, your Imakefile.mk should include the module: LV0PSBAS