II3IDParameterDefinition::SetAsInputMultiLine Method

Synopsis

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

IDL Function Prototype

HRESULT SetAsInputMultiLine(

   [in, optional] BSTR UILabel,

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

);

C/C++ Syntax

HRESULT SetAsInputMultiLine(BSTR UILabel, VARIANT_BOOL Required);

Parameters

UILabel

This is the localized label that should be displayed next to the multi-line text edit box on a step properties page in Interaction Designer.

Required

This Boolean parameter 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.