- Contents
DesignerCOM API
II3IDParameterDefinition::SetAsOutput Method
Synopsis
Implements functionality defined in I3IDToolReg.h's I3IDAddToolOutput method.
IDL Function Prototype
HRESULT SetAsOutput(
[in] VARIANT TypeSpecifier,
[in] BSTR UILabel,
[in, optional, defaultvalue(0)] VARIANT_BOOL Required
);
C/C++ Syntax
HRESULT SetAsOutput(VARIANT TypeSpecifier, BSTR UILabel, VARIANT_BOOL Required);
Parameters
- TypeSpecifier
-
TypeSpecifier denotes the type for the output parameter. It is a VARIANT that should be one of the three following types:
-
VT_BSTR: A string of the format <TypeModule>::<TypeName> that identifies the type for this parameter. For example, the string '::Integer' could be used to specify a type of Integer. In this case, the module name for the type is empty.
-
VT_UNKNOWN: The punkVal member should contain an IUnknown pointer to a COM object that implements the II3IDType interface.
-
VT_DISPATCH The pdispVal member should contain an IDispatch pointer to a COM object that implements the II3IDType interface.
NOTE: For VT_UNKNOWN and VT_DISPATCH, 'the COM object that implements the II3IDType interface' means that it is a type object that was retrieved from a method off of an II3IDTypes call such as the II3IDTypes::Item method.
-
- UILabel
-
This is the localized label that should be displayed next to the output parameter on a step properties page in Interaction Designer.
- Required
-
This parameter is used to tell 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.