AmiParameter::addLegal()

Method

Declaration

AmiStatus addLegal(void* value); 

Purpose

Sets the legal value choices for this parameter.

Remarks

Legal value choices can be enforced and displayed by the managing application. If legal value choices are specified for a parameter, no other values are permitted. For a specified AmiParameterIn object, set only one of either choice or legal values. If both are set, the legal value takes precedence.

Parameters

 

Parameter

Description

value

Legal choice value.