Feedback

  • Contents
 

II3IDParameter Interface

Overview

Derived From:        IDispatch

Interface ID:          {FB28A3EF-8F9C-4A76-83A3-C16EEF3DDB80}

II3IDParameter wrappers an Interaction Designer parameter.  Parameters are actual instances of parameter definitions.  Tool steps, subroutine steps and a handler's initiator will all have an II3IDParameters collection that contains Parameter objects.

Methods

AssignStringLiteralToStringParameter

Assign a string literal to a string parameter.  This method performs the necessary insertion of backslashes where appropriate.  Pass the literal value only without the quotes in the StringLiteral parameter.

ClearExpression

Clears the expression currently contained in this parameter.

GetStringLiteralFromStringParameter

For a string parameter, this method returns the literal value contained within the string parameter.  Backslashes are automatically removed.

Properties

Designer

Returns an Interaction Designer interface pointer.

Expression

Returns a VARIANT indicating how the value of the parameter is determined at runtime.

ExpressionIsEmpty

Indicates whether or not an expression exists for this parameter.

ExpressionIsLiteral

Indicates whether the expression that is assigned to this parameter is a string literal.

ExpressionIsReadOnly

Indicates whether the parameter contains a read-only expression.

ExpressionIsValid

Indicates whether or not the expression contained in this parameter is valid.  If the expression is empty, this method returns FALSE.

ExpressionIsVariable

Indicates whether or not the expression contained in this parameter is a variable.

ExpressionVariable

If the expression contained in this parameter is a variable, this method returns the variable.

IsClone

Returns whether or not this is a parameter generated by the II3IDParameter::Clone method.

IsCustom

This property indicates whether or not this parameter was added in addition to the creator's original parameter set definition.

ParameterDefinition

Returns the data definition for the parameter.  This can be used to retrieve meta data for the parameter.

ResourceInfo

Retrieves resource information associated with the parameter.

SourceStep

Returns the step associated with this parameter.