Copyright © Cloud Software Group, Inc. All Rights Reserved

AMI Error Handling

The AmiStatus class encapsulates information about AmiStatus conditions to aid in error tracing.

•	AmiStatus Class

AmiStatus Class

Class

Declaration

class AmiStatus;

Purpose

Objects of this class also are used to return an error condition to the monitoring TIBCO Hawk agent.

Member Summary

 

Member	Purpose	Page
AmiStatus()	Constructor	145
operator ami_Error() const	Operator to convert an ami_Error to AmiStatus.	—
AmiStatus& operator=(const AmiStatus& status)	Assignment operator.	—
AmiStatus& operator=(const ami_Error status)	Assignment operator.	—
AmiStatus& operator=(const ami_ErrorCode errorCode)	Assignment operator.	—
ami_Boolean operator==(const AmiStatus& status)	Comparison operator.	—
ami_Boolean operator!=(const AmiStatus& status)	Comparison operator.	—
ami_Boolean operator==(const ami_Error status)	Comparison operator.	—
ami_Boolean operator!=(const ami_Error status)	Comparison operator.	—
ami_Boolean operator!() const	Comparison operator.	—
ami_Boolean ok(void) const	Evaluates whether this status object— indicates an error state.	—
AmiStatus::getAmiError()	Returns the C API error handle of this AmiStatus object.	146
AmiStatus::setStatus()	Creates a new AMI error for the specified error code and descriptive text.	147
AmiStatus::setStatusV()		148
AmiStatus::stamp()	Stamps AMI error for location ID	149
AmiStatus::getCode()	returns the AMI C API error code	150
AmiStatus::getText()	Returns the textual description of the error	151
AmiStatus::getThread()	Returns the thread ID of the thread which created the specified AMI error	152
AmiStatus::getFile()	Returns error’s source file name	153
AmiStatus::getLine()	Returns the line number of the error source	154

Copyright © Cloud Software Group, Inc. All Rights Reserved