Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 6 C AMI API Reference : Data Types Summary : ami_Error

ami_Error
Type
Purpose
This is the AMI C API error object handle. It encapsulates all the information required to define and process errors generated by the AMI C API and for the user's application to pass errors to the AMI C API.
Remarks
A null ami_Error handle indicates success (i.e. no error). The convenience define AMI_OK is provided representing an ami_Error indicating success. It is recommended that you use an expression like the following when testing an ami_Error for success:
ami_Error RC;
RC = ami_Function();
if ( RC != AMI_OK )
{
handle error condition
}
A non-null ami_Error indicates an error. The unique error code identifying the error can be obtained using the ami_ErrorGetCode() function.
The ami_Error is an object handle representing allocated resources and must be destroyed using the ami_ErrorDestroy() function or memory will be leaked. The AMI C API application must destroy any ami_Error instances returned by an AMI C API function call. It must also destroy any ami_Error instance it explicitly creates with the exception of ami_Error instances returned to the AMI C API from a method invocation callback function.
The unique error codes returned by the ami_ErrorGetCode() function are documented in the following table.
TIBCO Rendezvous error (RV error number): (RV error text)
TIBCO Rendezvous error (RV error number) occurred attempting to get value for argument (argument name) of method (method name). (RV error text)

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved