IDVBCMExecRecipeInfo2::getaliases
Method Signatures |
|
C\C++ |
HRESULT GetAliases( LPVARIANT vArrayAliasNames, LPVARIANT vArrayUnitClasses, LPVARIANT vArrayBoundUnits, long lWait) |
VB |
Public Sub GetAliases( ByRef vArrayAliasNames As Variant, ByRef vArrayUnitClasses As Variant, ByRef vArrayBoundUnits As Variant, ByVal lWait As Long) |
This method returns the unit alias information for the 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 vArrayAliasNames As Variant, vArrayUnitClasses As Variant
Dim vArrayBoundUnits As Variant
Dim objExecRecipeInfo As IDVBCMExecRecipeInfo2
Call GetExecRecipeInfoObject(objExecRecipeInfo)
Call objExecRecipeInfo.GetAliases(vArrayAliasNames, _
vArrayUnitClasses, vArrayBoundUnits)
Call DisplayRecipeAliasInfo(vArrayAliasNames, vArrayUnitClasses, _
vArrayBoundUnits)
End Sub
Parameter Name |
Purpose |
|---|---|
vArrayAliasNames |
Safearray of strings representing the names of the aliases associated with the recipe. |
vArrayUnitClasses |
Safearray of strings representing the unit classes associated with the aliases in vArrayAliasNames. |
vArrayBoundUnits |
Safearray of strings representing the units bound to each alias (will be {Defer} if the alias is associated with a unit class). |
lWait |
Optional. Default = 30000. Time to wait for a server resource in milliseconds. |