IDVBCMExecRecipeInfo2::getstepsandboundunits

Method Signatures

C\C++

HRESULT GetStepsAndBoundUnits(

LPVARIANT vArrayStepNames,

LPVARIANT vArrayUnitClasses,

LPVARIANT vArrayClassBased,

long lWait)

Public Sub GetStepsAndBoundUnits(

ByRef vArrayStepNames As Variant,

ByRef vArrayUnitClasses As Variant,

ByRef vArrayClassBased As Variant,

ByVal lWait As Long)

This method returns a list of the steps, the step's associated unit/unit class, and an indication of whether the corresponding unit name is a single unit or a unit class for a given recipe.

Return Values

S_OK - success

else - failed

Memory Allocation

The caller is responsible for releasing the step names, unit class, and class-based safearrays.

Visual Basic Usage Example

Private Sub Button1_Click()
    Dim vArraySteps As Variant, vArrayClasses As Variant, _
            vArrayClassBased As Variant
    Dim objExecRecipeInfo As IDVBCMExecRecipeInfo2
    Dim lCount As Long
    Call GetExecRecipeInfoObject(objExecRecipeInfo)
    Call objExecRecipeInfo.GetStepsAndUnitClasses(vArraySteps, _
            vArrayClasses)
    Call UseStepAndClassInfo(vArraySteps, vArrayClasses, _
            vArrayClassBased)
    For lCount = LBound(vArraySteps) to UBound(vArraySteps)
        If vArrayClassBased(lCount) Then
            Call UseStepAndClassInfo(vArraySteps(lCount), _
                    vArrayClasses(lCount))
        Else
            Call UseStepAndSingleUnitInfo(vArraySteps(lCount), _
                    vArrayClasses(lCount))
        End If
    Next lCount
End Sub

Parameter Name	Purpose
vArrayStepNames	Safearray of strings representing the names of any recipe steps in the given recipe.
vArrayUnitClasses	Safearray of strings representing the names of the unit class of each recipe step in the recipe.
vArrayClassBased	Safearray of Booleans which indicate if the corresponding entry in vArrayUnitClasses is a unit class (for which this value would be True) or a single unit
lWait	Optional. Default = 30000. Time to wait for a server resource in milliseconds.