IDVBCMExecRecipeInfo4::execparametersdata_v123

Method Signatures

C\C++

HRESULT ExecParametersData_v123(

LPVARIANT vArrayParamNames,

LPVARIANT vArrayParamTypes,

LPVARIANT vArrayParamEditable,

LPVARIANT vArrayParamEUs,

LPVARIANT vArrayParamScaleHigh,

LPVARIANT vArrayParamScaleLow,

LPVARIANT vArrayParamDefaultValues,

LPVARIANT vArrayParamScalable,

LPVARIANT vArrayParamDesc,

LPVARIANT vArrayParamLocked,

long lWait)

Public Sub ExecParametersData_v123(

ByRef vArrayParamNames As Variant,

ByRef vArrayParamTypes As Variant,

ByRef vArrayParamEditable As Variant,

ByRef vArrayParamEUs As Variant,

ByRef vArrayParamScaleHigh As Variant,

ByRef vArrayParamScaleLow As Variant,

ByRef vArrayParamDefaultValues As Variant,

ByRef vArrayParamScalable As Variant,

ByRef vArrayParamDesc As Variant,

ByRef vArrayParamLocked As Variant,

ByVal lWait As Long)

This method returns data for all parameters for the given recipe.

Return Values

S_OK - success

else - failed

Memory Allocation

The caller is responsible releasing all returned safearrays.

Visual Basic Usage Example

Private Sub Button1_Click()
    Dim vArrayParamNames As Variant, vArrayParamTypes As Variant
    Dim vArrayParamEditable As Variant, vArrayParamEUs As Variant
    Dim vArrayParamScaleHigh As Variant, vArrayParamScaleLow As Variant
    Dim vArrayParamDefaultValues As Variant, vArrayParamScalable As Variant
    Dim vArrayParamDesc As Variant, vArrayParamLocked As Variant
    Dim objExecRecipeInfo As IDVBCMExecRecipeInfo4
    Call GetExecRecipeInfoObject(objExecRecipeInfo)
    Call objExecRecipeInfo.ExecParametersData_v123(vArrayParamNames, _
            vArrayParamTypes, vArrayParamEditable, vArrayParamEUs, _
            vArrayParamScaleHigh, vArrayParamScaleLow, vArrayParamDefaultValues, _
            vArrayParamScalable, vArrayParamDesc, vArrayParamLocked)
    Call DisplayRecipeParameterInfo_v123(vArrayParamNames, vArrayParamTypes, _
            vArrayParamEditable, vArrayParamEUs, vArrayParamScaleHigh, _
            vArrayParamScaleLow, vArrayParamDefaultValues, vArrayParamScalable _
            vArrayParamDesc, vArrayParamLocked)
End Sub

Parameter Name	Purpose
vArrayParamNames	Safearray of strings representing the names of the parameters associated with the recipe.
vArrayParamTypes	Safearray of strings representing the types of the parameters associated with the recipe.
vArrayParamEditable	Safearray of Booleans indicating whether the corresponding recipe parameter may be edited.
vArrayParamEUs	Safearray of strings representing the engineering units of the parameters associated with the recipe.
vArrayParamScaleHigh	Safearray of floating point numbers representing the maximum scale of the parameters associated with the recipe.
vArrayParamScaleLow	Safearray of floating point numbers representing the minimum scale of the parameters associated with the recipe.
vArrayParamDefaultValues	Safearray of strings representing the default values of the parameters associated with the recipe.
vArrayParamScalable	Safearray of Booleans indicating whether the corresponding recipe parameter may be scaled.
vArrayParamDesc	Safearray of strings representing the descriptions of the parameters in this recipe.
vArrayParamLocked	Safearray of Booleans indicating whether the corresponding recipe parameter is locked; that is, requires a key to be edited at run-time.
lWait	Optional. Default = 30000. Time to wait for a server resource in milliseconds.