ami_ParameterListOut()

Function

Declaration

ami_Error ami_ParameterListOut(
   ami_Session             inAmiSession,
   ami_Method              inAmiMethod,
   ami_ParameterListList * inpAmiParmListList,
   ami_ParameterList *     inpAmiParmList );

Purpose

Returns a handle to a list of AMI parameter lists to be used to specify return values for a method invocation. The first call to this method allocates and returns the list of AMI parameter lists (ami_ParameterListList) and one parameter list (ami_ParameterList) member. The application then uses the ami_ParameterSetValue to set the return values into this parameter list (ami_ParameterList).

To return more than one row of data (i.e. tabular data) this function can be called repeatedly using the same ami_ParameterListList handle. Each call will add an additional return row and return a parameter list (ami_ParameterList) to set the return values for that row.

If the ami_ParameterListList was created by the AMI API (for example, ami_OnInvokeCallback) then the API is responsible for destroying it. It it was created by the user’s application, the application must destroy it using ami_ParameterListListDestroy.

Parameters

 

Parameter

Description

inAmiSession

Handle of AMI session.

inAmiMethod

Handle of AMI method.

inpAmiParmListList

List of AMI parameters list.

inpAmiParmList

Handle of AMI parameter list.