ami_ParameterListList

Type

Purpose

This is the AMI C API list of parameter lists object handle. It encapsulates all the information required to define and support multiple AMI parameter lists. It is used to return multiple instances of output parameter values for a method (i.e. tabular data).

Remarks

An ami_ParameterListList instance is passed to the invocation callback function of a method to allow that method to return zero or more ami_ParameterList instances containing the return values for the method invocation. The AMI C API provides functions for adding ami_ParameterList instances to the ami_ParameterListList instance as required by the method. On return from the method invocation callback function the AMI C API sends the output parameter values (if any) associated with the ami_ParameterListList to the AMI manager and then destroys the ami_ParameterListList.

The AMI C API provides functions to create and destroy ami_ParameterListList instances for use in asynchronous methods where no method invocation callback is involved. The AMI C API application is responsible for destroying any ami_ParameterListList instances it explicitly creates using ami_ParameterCreateOut().