II3IDParameters::AddInputMultiLine Method

Synopsis

Implements functionality defined in I3IDToolReg.h's I3IDAddToolInputMultiLine method.

IDL Function Prototype

HRESULT AddInputMultiLine(

   [in, optional] BSTR UILabel,

   [in, optional, defaultvalue(0)] VARIANT_BOOL Required,

   [in, optional, defaultvalue(-1)] long Index,

   [out, retval] II3IDParameter ** NewParm

);

C/C++ Syntax

HRESULT AddInputMultiLine(BSTR UILabel, VARIANT_BOOL Required, long Index, II3IDParameter ** NewParm);

Parameters

UILabel

The localized label displayed next to the multi-line text box on a step properties page in Interaction Designer.

Required

This Boolean tells Interaction Designer if the parameter is required for the tool step. If so, a valid entry must be given to the parameter before the step is publishable.

Index

Index indicates where in the parameter list you would like to insert the parameter. The new parameter will be inserted BEFORE the specified index. To append to the current parameter list, specify -1.

The index must be greater than or equal to the registered number of parameters in the parameter list (or -1). The registered count is the number of parameters that are registered by the tool/initiator during its initial registration. That number can be found by checking II3IDParaemters::get_RegisteredCount.

NewParm

The return value is an II3IDParameter parameter created by Interaction Designer.