ami_OnStartCallback

Type

Declaration

typedef ami_Error (*ami_OnStartCallback)(
   ami_Session       inAmiSession, 
   ami_Method        inAmiMethod, 
   void *            inpUserData,
   ami_Subscription  inAmiSubscription,
   ami_ParameterList inArguments ); /

Purpose

This is the prototype for the optional AMI asynchronous method on start callback function. These functions are called whenever a new subscription is started. The application should perform any necessary initialization required to process this new subscription. This callback should return AMI_OK if no error, otherwise an ami_Error describing the failure.

Parameters

 

Parameter

Description

inAmiSession

Handle of AMI session.

inAmiMethod

Handle of AMI method.

inpUserData

User data associated with the method.

inAmiSubscription

Asynchronous method subscription.

inArguments

AMI input parameter handle.