IDVBCMExecInfo3::geteqtraininstancealias
Method Signatures |
|
C\C++ |
HRESULT GetEqTrainInstanceAlias( [in] BSTR bstrEqTrainBaseClass [in] BSTR bstrEqTrainInstance, [out] LPVARIANT vArrayAlias, [out] LPVARIANT vArrayUnitClass, [in, optional, defaultvalue(DEFAULT_WAIT_TIMEOUT)] long lWait) |
VB |
Public Sub GetEqTrainInstanceAlias( ByVal bstrEqTrainBaseClass As String, ByVal bstrEqTrainInstance As String, ByRef vArrayAlias As Variant, ByRef vArrayUnitClass As Variant, ByVal lWait As Long) |
This method returns the array of aliases for the equipment train instance.
Return Values
S_OK - success
else - failed
Memory Allocation
The caller is responsible for releasing both the vArrayAlias and vArrayUnitClass safearrays.
Parameter Name |
Purpose |
|---|---|
bstrEqTrainBaseClass |
The name of the Equipment Train instance's class from which to retrieve the information. |
bstrEqTrainInstance |
The name of the Equipment Train instance from which to retrieve the information. |
vArrayAlias |
A safearray of strings representing the names of the unit aliases that match the unit passed in. |
vArrayUnitClass |
A safearray of strings representing the names of the unit classes to which each of the unit aliases are mapped. |
lWait |
Optional. Default = 30000. Time to wait for a server resource in milliseconds. |