You are here: SwitchKit® Development Environment - TCAP Interface User’s Guide > 6 SKTAL Parameter Classes > Class TCAP_Error : public TCAP_Component
Class TCAP_Error : public TCAP_Component
Purpose
The purpose of the TCAP_Error component is to define the basic interface to the remote operation error codes. This class is used to reply to unsuccessful invoke operations
TCAP_Error component includes the following methods:
// Error
// If defined(CCITT)
void SetError(const SKTAL_OCTET code);
void GetError(SKTAL_OCTET& code) const;
//If defined(ANSI)
void SetError(const bool isNational, const SKTAL_OCTET code);
void GetError(bool& isNational, SKTAL_OCTET& code) const;
// Parameter
void SetParameter(const SKTAL_OCTET* buf, const int len);
void GetParameter(SKTAL_OCTET* buf, int& len) const;
void SetParameter(const SKTAL_ByteArray& buf);
void GetParameter(SKTAL_ByteArray& buf) const;
Description
This method sets the error code in an error component. The signature of this method varies depending on the standard used.
Syntax
If defined ITU:
void SetError(const SKTAL_OCTET code);
If defined ANSI:
void SetError(const bool isNational, const SKTAL_OCTET code);
Input Parameters (ITU)
code: The error code
Input Parameters (ANSI)
isNational: an indicator that this code is national or private
code: The error code
Input/Output Parameters and Output Parameters
None
Return Value
None
Description
This method gets the error code in an error component. The signature of this method varies depending on the standard used.
Syntax
If defined ITU:
void GetError(SKTAL_OCTET& code) const;
If defined ANSI:
void GetError(bool& isNational, SKTAL_OCTET& code) const;
Input Parameters and Input/Output Parameters
None
Output Parameters (ITU)
code: The error code
Output Parameters (ANSI)
isNational: an indicator that this code is national or private
code: the error code
Return Value
None
Syntax
See class TCAP_Invoke
void SetParameter(const SKTAL_OCTET* buf, const int len);
void SetParameter(const SKTAL_ByteArray& buf);
Syntax
See class TCAP_Invoke
void GetParameter(SKTAL_OCTET* buf, int& len) const;
void GetParameter(SKTAL_ByteArray& buf) const;