Copyright © Cloud Software Group, Inc. All Rights Reserved

ami_TraceHandler

Type

Declaration

typedef void (*ami_TraceHandler)(

ami_Session inAmiSession,

ami_TraceCode inTraceCode,

int inTraceID,

const char * inpText,

void * inpUserData );

Purpose

This is the prototype for the optional AMI trace handler callback. This callback is used by AMI API to report events to the application. These events are classified by ami_TraceCode. If no trace handler is provided then tracing is disabled. Tracing can be controlled (including turned off) using the trace control functions.

Parameters

 

Parameter	Description
inAmiSession	AMI session handle reporting the trace event.
inTraceCode	Category of trace event.
inTraceID	Unique ID of trace event.
inpText	Textual description of trace event
inpUserData	User data associated with the AMI session.

 

Trace Control Functions Summary

The following table summarizes the AMI C API trace control functions. These functions are described in the following sections.

Function	Description	Page
ami_TraceCode	AMI C API trace levels.	184
ami_SessionGetTraceLevels()	Returns the current AMI session trace level settings.	185
ami_SessionSetTraceLevels()	Resets all AMI session trace level settings to the specified settings.	186
ami_SessionEnableTraceLevels()	Enables the specified level(s) of trace output.	187
ami_SessionDisableTraceLevels()	Disables the specified level(s) of trace output.	188

 

 

Copyright © Cloud Software Group, Inc. All Rights Reserved