EsbDeleteVariable

Description

EsbDeleteVariable() deletes a substitution variable.

Syntax

EsbDeleteVariable (hCtx, pVariable)
ByVal hCtx      As Long
      pVariable As ESB_PVARIABLE_T 

Parameters

hCtx Context handle to the Essbase API.
pVariable The pointer to the structure containing the description of the substitution variable being deleted.

Return Value

If successful, returns zero.

Example

Declare Function EsbDeleteVariable Lib "esbapin" (ByVal hCtx As Long, pVariable As ESB_VARIABLE_T) As Long

Sub Esb_DeleteVariable ()

Dim sts As Long
Dim oVariable As ESB_VARIABLE_T

'  Delete "QuarterName" Susbtitution Variable at the Sample application level
   oVariable.Server = "Localhost"
   oVariable.AppName = "Sample"
'  ** Note that DbName has been left empty
   oVariable.VarName = "QuarterName"
   oVariable.VarValue = "Qtr1"

   sts = EsbDeleteVariable(hCtx, oVariable)

End Sub

See Also

ESB_VARIABLE_T
EsbCreateVariable()
EsbGetVariable()
EsbListVariables()