Data provider types: Oracle Essbase
Description
HypGetSubstitutionVariable() retrieves substitution variables and their current values from Essbase.
Syntax
HypGetSubstitutionVariable (vtSheetName, vtApplicationName, vtDatabaseName, vtVariableName, vtVariableNames, vtVariableValues)
ByVal vtSheetName As Variant
ByVal vtApplicationName As Variant
ByVal vtDatabaseName As Variant
ByVal vtVariableName As Variant
ByRef vtVariableNames As Variant
ByRef vtVariableValues As Variant
Parameters
vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null or Empty, the active worksheet is used.
vtApplicationName: The name of the application from which to return substitution variables. If set to Null or Empty, all the applications are considered.
vtDatabaseName: The name of the database from which to return substitution variables. If set to Null or Empty, all the databases are considered.
vtVariableName: The name of the substitution variable to be retrieved. If set to Null or Empty, the entire list of variables is returned.
vtVariableNames: Output result vector that contains the list of the substitution variable names. Its contents are unknown if the macro fails.
vtVariableValues: Output result vector that contains the list of the substitution variable values corresponding to each variable returned. Its contents are unknown if the macro fails.
Return Value
Returns 0 if successful; otherwise, returns the appropriate error code.
Example
Declare Function HypGetSubstitutionVariable Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtApplicationName As Variant, ByVal vtDatabaseName As Variant, ByVal vtVariableName As Variant, ByRef vtVariableNames As Variant, ByRef vtVariableValues As Variant) As Long
Sub Example_HypGetSubstitutionVariable()
Dim sts As Long
sts = HypGetSubstitutionVariable(Empty, "Sample", "Basic", Empty, vtVarNameList, vtVarValueList)
End If
End Sub