HypSetSubstitutionVariable
Cloud data provider types: Oracle Analytics Cloud - Essbase
On-premises data provider types: Oracle Essbase
Description
HypSetSubstitutionVariable() creates substitution variables in Essbase. If the variable already exists, then its value is set to the new specified value.
Syntax
HypSetSubstitutionVariable (vtSheetName, vtApplicationName, vtDatabaseName, vtVariableName, vtVariableValue)
ByVal vtSheetName As Variant
ByVal vtApplicationName As Variant
ByVal vtDatabaseName As Variant
ByVal vtVariableName As Variant
ByVal vtVariableValue As Variant
Parameters
vtSheetName: The name of worksheet on which to run the function. If sest to Null or Empty, the active worksheet is used.
vtApplicationName: The name of the application name in which to create the new substitution variable. If set to Null or Empty , the scope of the variable is global.
vtDatabaseName: The name of the database in which to create the new variable. If set to Null or Empty, the scope of the variable created is global within the application specified.
vtVariableName: The variable name to be created. Required.
vtVariableValue: The value to be assigned to the variable. Required.
Return Value
Returns 0 if successful; otherwise, returns the appropriate error code.
Example
Declare Function HypSetSubstitutionVariable Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtApplicationName As Variant, ByVal vtDatabaseName As Variant, ByVal vtVariableName As Variant, ByVal vtVariableValue As Variant) As Long
Sub Example_HypSetSubstitutionVariable
Dim X as Long
X = HypSetSubstitutionVariable(Empty, "Sample", "Basic", "Account", "100")
End Sub