IDVBCMExecRecipeInfo3::geteqtraininstances

Method Signatures

 

C\C++

HRESULT GetEqTrainInstances(

[out] LPVARIANT vArrayEqTrains,

[in, optional, defaultvalue(DEFAULT_WAIT_TIMEOUT)]

long lWait);

VB

Public Sub GetEqTrainInstance (

ByRef bstrEqTrainSelected As String,

ByRef bstrEqTrainSelectedDesc As String,

ByRef bstrEqTrainBaseClass As String,

ByRef bstrEqTrainClassDesc As String,

ByVal lWait As Long)

This method returns the filtered train list information for the recipe.

Return Values

S_OK - success

else - failed

Memory Allocation

The caller is responsible for releasing the vArrayEqTrains safearray.

Parameter Name

Purpose

vArrayEqTrains

A safearray of strings representing the equipment trains used in the recipe.

lWait

Optional. Default = 30000. Time to wait for a server resource in milliseconds.