ami_OnInvokeCallback

Type

Declaration

typedef ami_Error (*ami_OnInvokeCallback)(
   ami_Session             inAmiSession, 
   ami_Method              inAmiMethod,
   ami_Subscription        inAmiSubscription, 
   void *                  inpUserData, 
   ami_ParameterList       inArguments, 
   ami_ParameterListList * inpReturns ); 

Purpose

This is the prototype for an AMI method callback function. These functions are invoked whenever the associated method is executed by TIBCO Hawk. The callback should return method return values or an ami_Error if the function call fails. When this callback is executed for an asynchronous method the inAmiSubscription argument is provided. For synchronous or synchronous invocations of asynchronous methods this argument is NULL.

Parameters

 

Parameter

Description

inAmiSession

Handle of AMI session.

inAmiMethod

Handle of AMI method.

inAmiSubscription

Asynchronous method subscription.

inpUserData

User data associated with the method.

inArguments

AMI input parameter handle.

inpReturns

Target for method return values.