DriveConstraintSettings.GetIncrement Method

Parent Object: DriveConstraintSettings

Description

Returns how the increment was specified and the value.

Syntax

DriveConstraintSettings.GetIncrement( IncrementType As ConstraintIncrementTypeEnum, Increment As String )

Parameters

Name Type Description
IncrementType ConstraintIncrementTypeEnum Output enum that returns the increment type. The possible return values are kIncrementAsAmountOfValue and kIncrementAsNumberOfSteps.
Increment String Output String that returns the increment value. The value returned is based on the increment type - amount of value if the type is kIncrementAsAmountOfValue and total number of steps if the type is kIncrementAsNumberOfSteps.

Version

Introduced in version 2012