AmiParameterIn()

Constructor

Declaration

AmiParameterIn(AmiMethod * method,
               const char* name,
               ami_DataType type,
               const char* help); 

Purpose

Creates an input parameter for the given method.

Parameters

 

Parameter

Description

method

AmiMethod to which this parameter is set.

name

Establishes the name of the AmiParameterIn object.

type

Parameter type. One of:

AMI_I32. 32-bit signed integer.

AMI_I64. 64-bit signed integer.

AMI_U64. 64-bit unsigned integer.

AMI_F64. 64-bit floating-point number.

AMI_STRING. Null-terminated character string (UTF8 encoding).

AMI_BOOLEAN. Boolean.

help

Establishes the help text describing the purpose of the AmiParameterIn object.

NULL or empty string values are acceptable. We strongly recommend you specify meaningful descriptions when describing AmiMethod input parameters.