ami_AsyncMethodCreate()

Function

Declaration

ami_Error ami_AsyncMethodCreate(
   ami_Session          inAmiSession, 
   ami_Method *         inpAmiMethod, 
   const char *         inpName, 
   ami_MethodType       inType,
   const char *         inpHelp, 
   int                  inTimeout, 
   ami_OnInvokeCallback inOnInvoke, 
   ami_OnStartCallback  inOnStart, 
   ami_OnStopCallback   inOnStop,
   const void *         inpUserData );

Purpose

Allocates and initializes an ami_Method object and returns the handle to the object. The ami_Method object belongs to the specified ami_Session object and will be destroyed when the ami_Session is destroyed.

Parameters

 

Parameter

Description

inAmiSession

Handle of AMI session.

inpAmiMethod

Location to store new method handle.

inpName

Name of the method for AMI purpose.

inType

Type of method.

inpHelp

Textual description of method.

inTimeout

Timeout period in milliseconds.

inOnInvoke

Method invocation callback.

inOnStart

(Optional) Start subscription callback.

inOnStop

(Optional) Stop subscription callback.

inpUserData

(Optional) AMI method user data.