Copyright © Cloud Software Group, Inc. All Rights Reserved

ami_ErrorGet... Accessors

Function

Declaration

int ami_ErrorGetCode(

ami_Error inAmiError );

 

const char * ami_ErrorGetText(

ami_Error inAmiError );

 

int ami_ErrorGetThread(

ami_Error inAmiError );

 

const char * ami_ErrorGetFile(

ami_Error inAmiError );

 

int ami_ErrorGetLine(

ami_Error inAmiError );

Accessor Functions

 

Function	Description
ami_ErrorGetCode	Returns the AMI C API error code of the specified AMI error handle.
ami_ErrorGetText	Returns the textual description of the specified AMI error. This function always returns a description (never NULL). If no description was specified in the create call then a default message is used which states that no description is available.
ami_ErrorGetThread	Returns the thread ID of the thread which created the specified AMI error.
ami_ErrorGetFile	Returns the name of the source file which generated the specified AMI error. This function can return a NULL pointer if the specified error was not file stamped.
ami_ErrorGetLine	Returns the line number of the source file which generated the specified AMI error. This function could return zero if the specified error was not file stamped.

Callback Function Types Summary

The following table summarizes the AMI C API callback function types. These types are described in the following sections.

Function	Description	Page
ami_OnInvokeCallback	Prototype for an AMI method callback function.	179
ami_OnStartCallback	Prototype for the optional AMI asynchronous method on start callback function.	180
ami_OnStopCallback	Prototype for the optional AMI asynchronous method on stop callback function.	181
ami_TraceHandler	Prototype for the optional AMI trace handler callback.	182

Copyright © Cloud Software Group, Inc. All Rights Reserved