ami_ParameterCreateOut()

Function

Declaration

ami_Error ami_ParameterCreateOut(
   ami_Session      inAmiSession, 
   ami_Method       inAmiMethod, 
   ami_Parameter *  inpAmiParm, 
   const char *     inpName, 
   ami_DataType     inType, 
   const char *     inpHelp ); 

Purpose

Adds the specified parameter to the description of return parameters for that method.

Parameters

 

Parameter

Description

inAmiSession

Handle of AMI session.

inAmiMethod

Handle of AMI method.

inpAmiParm

Target for returned parameter handle.

inpName

Name of the parameter for AMI purposes.

Note: The use of curly brackets { } in microagent method parameter names is not supported. Use of these characters results in an error.

inType

Type of the parameter.

inpHelp

Optional description for the parameter.